List All Variants
Use this API to list all variants for a store in Zoho Commerce.
OAuthScope
ZohoCommerce.items.READ
HTTP Request
GET https://commerce.zoho.com/store/api/v1/variants
Query Parameters
| Parameter | Values |
| status | string: active, inactive |
| item_type | string: ItemType.Inventory, ItemType.NonInventory |
| sort_column | string: name, last_modified_time, actual_available_stock |
| sort_order | char: A ,D |
| page | integer: 1 to n |
| per_page | integer: 10,25,50,100,200 |
| variant_ids | long: list of unique variant ids separated by comma to get specific variant details limit: 50 |
Request Example
Copiedcurl -i -X GET \
-H "Authorization:Zoho-oauthtoken ******" \
-H "X-com-zoho-store-organizationid:687591958" \
'https://commerce.zoho.com/store/api/v1/variants?sort_column=last_modified_time&sort_order=D&page=1&per_page=40&status=active&item_type=ItemType.Inventory'Success Response
Copied{
"code": 0,
"message": "success",
"variants": [
{
"variant_id": "1831511000001401129",
"name": "The Way of Life-Book-Publisher-Product1-Book-Publisher-Product1-Book-Publishing Date",
"product_name": "The Way of Life",
"product_id": "1831511000001401127",
"brand": "Book-Author",
"category_id": "1831511000000068277",
"purchase_rate": 0.00,
"rate": 56.90,
"label_rate": 69.90,
"sku": "9780768442748",
"minimum_order_quantity": 1.000000,
"maximum_order_quantity": 10.000000,
"reorder_level": 5.000000,
"document_id": "",
"document_name": "",
"is_combo_product": false,
"status": "active",
"last_modified_time": "2021-08-23T01:03:37-0400",
"stock_on_hand": 10.000000,
"actual_available_stock": 10.000000,
"available_stock": 10.000000,
"available_sale_stock": 10.000000,
"committed_stock": 0.000000,
"track_serial_number": false,
"track_batch_number": false
},
{.....},
{.....},
{.....},
............
],
"page_context": {
"page": 1,
"per_page": 40,
"has_more_page": true,
"applied_filter": "Status.All",
"sort_column": "last_modified_time",
"sort_order": "D",
"search_criteria": [
{
"column_name": "item_type",
"search_text": "ItemType.Inventory",
"search_text_formatted": "ItemType.Inventory",
"comparator": "equal"
},
{
"column_name": "status",
"search_text": "active",
"search_text_formatted": "active",
"comparator": "equal"
}
]
}
}
Show full
Show less