shop.product.skus.getInfo
Returns information about a product variant.
Parameters
-
id
GET
Product variant ID.
-
access_token
GET
API auth token obtained during the API authorization.
-
format
GET
Optional
Sets response format. Available options:
json
(default),xml
.
Product variant data array with the following keys:
- id int Variant ID.
- product_id int Variant product ID.
- sku string Code of the product SKU to which the variant belongs.
- sort int Sort value.
- name string Name of the product SKU to which the variant belongs.
- image_id int ID of the product image selected in the variant’s properties.
- price float Variant’s price, expressed in the product currency, in the
decimal(15,4)
format. - purchase_price float Purchase price expressed in the product currency, in the
decimal(15,4)
format. - compare_price float Strike-through price expressed in the product currency, in the
decimal(15,4)
format. - count float|null Variant’s total quantity available on all stocks, in the
decimal(15,3)
format ornull
in case of infinite quantity on some stocks. - available int Flag (0 or 1) denoting the variant’s availability for purchase.
- stock_base_ratio float Conversion ratio between the stock unit and the base quantity unit.
- order_count_min float Minimum orderable product quantity in the
decimal(15,3)
format. - order_count_step float Quantity adjustment value with “+/-” buttons in the
decimal(15,3)
format. - status int Flag (0 or 1) denoting the variant’s visibility in the storefront.
- file_name string Attached file’s name.
- file_size int Attached file’s size in bytes.
- file_description string Attached file’s description.
- stock array Array of the variant’s quantity available on each of the stocks. Array keys are stock IDs, values are quantities available on the corresponding stocks.