Search Product
HTTP Request
GET https://commerce.zoho.com/storefront/api/v1/search-products
Parameter
| Parameter | Description |
| q* | string: The query string to be searched for in the store. |
Request Example
Copiedcurl -i -L -X GET
-H "domain-name:zylkerfashionstore.zohostore.com"
'https://commerce.zoho.com/storefront/api/v1/search-products?q=xxx'Success Response
Copied{
"status_message": "success",
"status_code": "0",
"payload": {
"pagination": {
"total_number_of_pages": 0,
"per_page": 50,
"has_more_page": false,
"current_page": 1
},
"currency": {
"symbol": "$",
"code": "USD",
"symbol_formatted": "$",
"code_on_left": true,
"format": "###,##0.00",
"symbol_on_left": true
},
"products": [
{
"selling_price": 290,
"short_description": "Made from polyester, this upmarket black dress is a design exclusive.\nPair it with an elegant bag for an exquisite
"review_id": "1147341000000040657",
"documents": [
],
"description": "<div>\n <span style=\"color: inherit\">\n <div style=\"font-size: 15px\">\n <ul>\n <li>Polyester</li>\n
"is_out_of_stock": false,
"label_price": 350,
"variants": [
{
"selling_price": 290,
"images": [
{
"alternate_text": "",
"is_placeholder_image": true,
"id": "-1",
"title": "",
"url": "/zs-common/images/no-preview-image.jpg",
"is_featured": true,
"order": 1
}
],
"custom_fields": [
],
"isbn": "",
"is_out_of_stock": false,
"upc": "",
"mpn": "",
"label_price": 350,
"stock_available": 49,
"variant_id": "1706707000000068709",
"ean": "",
"options": [
{
"name": "Size",
"id": "1706707000000071026",
"value": "2",
"color_code": ""
}
],
"is_returnable": false,
"sku": ""
},
{
"selling_price": 290,
"images": [
{
"alternate_text": "",
"is_placeholder_image": true,
"id": "-1",
"title": "",
"url": "/zs-common/images/no-preview-image.jpg",
"is_featured": true,
"order": 1
}
],
"custom_fields": [
],
"isbn": "",
"is_out_of_stock": false,
"upc": "",
"mpn": "",
"label_price": 350,
"stock_available": 21,
"variant_id": "1706707000000071020",
"ean": "",
"options": [
{
"name": "Size",
"id": "1706707000000071028",
"value": "4",
"color_code": ""
}
],
"is_returnable": false,
"sku": ""
},
{
"selling_price": 290,
"images": [
{
"alternate_text": "",
"is_placeholder_image": true,
"id": "-1",
"title": "",
"url": "/zs-common/images/no-preview-image.jpg",
"is_featured": true,
"order": 1
}
],
"custom_fields": [
],
"isbn": "",
"is_out_of_stock": false,
"upc": "",
"mpn": "",
"label_price": 350,
"stock_available": 43,
"variant_id": "1706707000000071022",
"ean": "",
"options": [
{
"name": "Size",
"id": "1706707000000071030",
"value": "6",
"color_code": ""
}
],
"is_returnable": false,
"sku": ""
},
{
"selling_price": 290,
"images": [
{
"alternate_text": "",
"is_placeholder_image": true,
"id": "-1",
"title": "",
"url": "/zs-common/images/no-preview-image.jpg",
"is_featured": true,
"order": 1
}
],
"custom_fields": [
],
"isbn": "",
"is_out_of_stock": false,
"upc": "",
"mpn": "",
"label_price": 350,
"stock_available": 49,
"variant_id": "1706707000000071024",
"ean": "",
"options": [
{
"name": "Size",
"id": "1706707000000071032",
"value": "8",
"color_code": ""
}
],
"is_returnable": false,
"sku": ""
},
{
"selling_price": 500,
"images": [
{
"alternate_text": "",
"is_placeholder_image": true,
"id": "-1",
"title": "",
"url": "/zs-common/images/no-preview-image.jpg",
"is_featured": true,
"order": 1
}
],
"custom_fields": [
],
"isbn": "",
"is_out_of_stock": false,
"upc": "",
"mpn": "",
"label_price": 0,
"stock_available": 10,
"variant_id": "1706707000000623004",
"ean": "",
"options": [
{
"name": "Size",
"id": "1706707000000623006",
"value": "10",
"color_code": ""
}
],
"is_returnable": false,
"sku": ""
}
],
"type": 0,
"starts_with": 290,
"is_product_custom_fields_enabled": true,
"category_id": "0",
"product_id": "1706707000000068713",
"quick_look_url": "/products/j9c1649166/1706707000000068713?quick_look=true",
"is_returnable": false,
"seo": {
"description": "Made from polyester, this upmarket black dress is a design exclusive.\nPair it with an elegant bag for an exquisite lo
"title": "Little Black Dress"
},
"on_sale": false,
"images": [
{
"alternate_text": "Little Black Dress",
"is_placeholder_image": false,
"id": "1706707000000069483",
"title": "Little Black Dress",
"url": "/product-images/1706707000000069483",
"is_featured": true,
"order": 0
}
],
"has_variant_price": true,
"specification_group": [
],
"has_variants": true,
"handle": "j9c1649166",
"is_product_review_enabled": true,
"url": "/products/j9c1649166/1706707000000068713",
"tags": [
],
"is_stock_managed": false,
"ends_with": 500,
"name": "Little Black Dress",
"is_social_share_enabled": false,
"attributes": [
{
"name": "Size",
"options": [
{
"id": "1706707000000071026",
"value": "2",
"color_code": ""
},
{
"id": "1706707000000071028",
"value": "4",
"color_code": ""
},
{
"id": "1706707000000071030",
"value": "6",
"color_code": ""
},
{
"id": "1706707000000071032",
"value": "8",
"color_code": ""
},
{
"id": "1706707000000623006",
"value": "10",
"color_code": ""
}
],
"id": "1706707000000067329",
"type": "Text"
}
],
"status": true
}
]
},
"extra": {
"rating_details": {
"1147341000000040657": {
"total_comments": 0,
"total_ratings": 2,
"average_ratings_roundvalue": 5,
"unique_id": "1147341000000040657",
"contexttype": "review",
"enable_review": false,
"is_commentbox_enabled": true,
"average_ratings": 5,
"rating_scales": [
{
"star_width_percentage": 100
},
{
"star_width_percentage": 100
},
{
"star_width_percentage": 100
},
{
"star_width_percentage": 100
},
{
"star_width_percentage": 100
}
]
}
}
},
"api_kind": "kind#search-products"Show full
Show less