List All Products
OAuthScope
ZohoCommerce.items.READ
HTTP Request
GET https://commerce.zoho.com/store/api/v1/products
Query Parameters
| Parameter | Values |
| filter_by | string: Status.All, Status.Active, Status.Inactive, ItemType.All, ItemType.Inventory, ItemType.NonInventory |
| sort_column | string: name, created_time, last_modified_time, min_rate, max_rate |
| sort_order | char: A ,D |
| page_start_from | integer: 1 to n |
| per_page | integer: 10,25,50,100,200 |
Request Example
Copiedcurl -i -X GET
-H "Authorization:Zoho-oauthtoken ***"
-H "X-com-zoho-store-organizationid:682219181"
'https://commerce.zoho.com/store/api/v1/products'Success Response
Copied{
"code": 0,
"message": "success",
"products": [
{
"product_id": "1706707000000068087",
"name": "A-Line Dress with Slit",
"product_type": "goods",
"brand": "",
"manufacturer": "",
"unit": "",
"is_product_custom_fields_enabled": false,
"description": "",
"product_description": "",
"product_short_description": "",
"attribute_id1": "",
"attribute_id2": "",
"attribute_id3": "",
"attribute_name1": "",
"attribute_name2": "",
"attribute_name3": "",
"attribute1": {
},
"attribute2": {
},
"attribute3": {
},
"url": "fa6ef9e19a",
"created_time": "1547646281557",
"last_modified_time": "1547728311086",
"variant_type": "inventory",
"is_returnable": 1,
"show_in_storefront": true,
"show_in_pos": false,
"show_in_both": false,
"is_combo_product": false,
"document_id": "1706707000000068874",
"alter_text": "A-Line Dress with Slit",
"status": "active",
"min_rate": 280,
"max_rate": "",
"is_featured": false,
"has_variant": false,
"variant_count": 1,
"overall_stock": 22,
"is_below_reorder_level": false,
"variants": [
{
"variant_id": "1706707000000068083",
"name": "A-Line Dress with Slit",
"status": "active",
"rate": 280,
"purchase_rate": 0,
"sku": "",
"upc": "",
"ean": "",
"isbn": "",
"part_number": "",
"reorder_level": "",
"initial_stock": 25,
"initial_stock_date": "",
"attribute_option_id1": "",
"attribute_option_id2": "",
"attribute_option_id3": "",
"attribute_option_name1": "",
"attribute_option_data1": "",
"attribute_option_name2": "",
"attribute_option_data2": "",
"attribute_option_name3": "",
"attribute_option_data3": "",
"attribute_id1": "",
"attribute_id2": "",
"attribute_id3": "",
"attribute_name1": "",
"attribute_name2": "",
"attribute_name3": "",
"attribute_type1": "",
"attribute_type2": "",
"attribute_type3": "",
"stock_on_hand": 21,
"available_stock": 22,
"actual_available_stock": 23,
"available_sale_stock": 21,
"variant_type": "inventory",
"initial_stock_rate": 85,
"label_rate": 0
}
]
},
{...},
{...},
],
"page_context": {
"page": 1,
"per_page": 200,
"has_more_page": false,
"report_name": "Product",
"applied_filter": "Status.All",
"sort_column": "name",
"sort_order": "A"
}
}Show full
Show less