⚠️ This instruction is appropriate for App Lib V2 only. Please contact us for further assistance.
Description
The following describes the properties of a product returned by Filter/Search API.
Product Properties
Property | Description |
id | 'id': 28652161170 |
available | 'available': true |
title | 'title': 'iPod Nano - 8GB' |
body_html | 'body_htm': 'The small iPod with a big idea: Video.' |
vendor | 'vendor': 'Apple' |
product_type | 'product_type': 'phone' |
handle | 'handle': 'ipod-nano' |
published_at | 'published_at': '2007-12-31T19:00:00-05:00' |
published_scope | 'published_scope': 'global' |
template_suffix | 'template_suffix': 'special' |
tags | 'tags': [ |
price_min | 'price_min': 199.00 |
price_max | 'price_max': 210.00 |
compare_at_price_min | 'compare_at_price_min': 200.00 |
compare_at_price_max | 'compare_at_price_max': 300.00 |
percent_sale_min | 'percent_sale_min': 15 |
images | 'images': { |
images_info | 'images_info': [ |
weight_min | 'weight_min': 5 |
weight_max | 'weight_max': 15 |
metafields | 'metafields': [ |
review_ratings | 'review_rating': 0 |
variants | 'variants': [ |
Variants Properties
Property | Description |
id | 'id': 28652161170 |
available | 'available': true |
merged_options | 'merged_options': [ |
image | 'image': null |
title | 'title': 'S / Yellow' |
sku | 'sku': 'WLT-K100R' |
barcode | 'barcode': '23123123' |
inventory_management | 'inventory_management': 'shopify' |
inventory_policy | 'inventory_policy': 'continue' |
inventory_quantity | 'inventory_quantity': 10 |
price | 'price': 199.00 |
compare_at_price | 'compare_at_price': 299.00 |
Example
{
"product": {
"id": 8584719122,
"available": true,
"title": "Intelligent Linen Chair",
"body_html": "",
"vendor": "Hermes",
"product_type": "Dresses",
"handle": "intelligent-linen-chair",
"published_at": "2016-12-10T19:33:03-05:00",
"published_scope": "web",
"template_suffix": null,
"tags": [
"collection:tops",
"style:Arty"
],
"price_min": 58,
"price_max": 146,
"compare_at_price_min": null,
"compare_at_price_max": null,
"percent_sale_min": 0,
"images": {
"1": "https://cdn.shopify.com/s/files/1/1651/2159/products/1_2e3ce250-465b-41e4-9ede-4e520d92dffd.jpg?v=1481416402",
"2": "https://cdn.shopify.com/s/files/1/1651/2159/products/4_fa3ba281-e7d6-4c54-b16d-76ab7799a49a.jpg?v=1481416402"
},
"images_info": [
{
"id": 17677375442,
"position": 1,
"src": "https://cdn.shopify.com/s/files/1/1651/2159/products/1_2e3ce250-465b-41e4-9ede-4e520d92dffd.jpg?v=1481416402",
"width": 762,
"height": 1100
},
{
"id": 17677375506,
"position": 2,
"src": "https://cdn.shopify.com/s/files/1/1651/2159/products/4_fa3ba281-e7d6-4c54-b16d-76ab7799a49a.jpg?v=1481416402",
"width": 762,
"height": 1100
}
],
"collections": [
{
"id": 357407890,
"handle": "tops",
"title": "Tops",
"featured": false,
"sort_value": "0000000022"
},
{
"id": 34592456740,
"handle": "all",
"title": "Collection All",
"featured": false,
"sort_value": "0000000259"
}
],
"options_with_values": [
{
"name": "size",
"label": "Size",
"values": [
{
"title": "S",
"image": null
},
{
"title": "M",
"image": null
},
{
"title": "XL",
"image": null
},
{
"title": "XXL",
"image": null
}
]
},
{
"name": "color",
"label": "Color",
"values": [
{
"title": "Yellow",
"image": null
}
]
}
],
"variants": [
{
"available": true,
"merged_options": [
"color:Yellow",
"size:S/M"
],
"image": null,
"id": 28652161170,
"title": "S / Yellow",
"sku": "",
"barcode": "",
"inventory_management": null,
"inventory_policy": "deny",
"inventory_quantity": 7,
"price": "85.50",
"compare_at_price": null
},
{
"available": true,
"merged_options": [
"color:Yellow",
"size:S/M"
],
"image": null,
"id": 28652161234,
"title": "M / Yellow",
"sku": "intelligent-linen-chair-m",
"barcode": "",
"inventory_management": null,
"inventory_policy": "deny",
"inventory_quantity": 1,
"price": "86.50",
"compare_at_price": null
},
{
"available": true,
"merged_options": [
"color:Yellow",
"size:XXL"
],
"image": null,
"id": 28652161298,
"title": "XL / Yellow",
"sku": "intelligent-linen-chair-xl, "barcode": "",
"inventory_management": null,
"inventory_policy": "deny",
"inventory_quantity": 2,
"price": "146.00",
"compare_at_price": null
},
{
"available": true,
"merged_options": [
"color:Yellow",
"size:XXL"
],
"image": null,
"id": 28652161426,
"title": "XXL / Yellow",
"sku": "intelligent-linen-chair-xxl",
"barcode": "",
"inventory_management": null,
"inventory_policy": "deny",
"inventory_quantity": 1,
"price": "58.00",
"compare_at_price": null
}
],
"skus": [
"intelligent-linen-chair-m",
"intelligent-linen-chair-xl",
"intelligent-linen-chair-xxl"
],
"barcodes": [],
"weight_min": 56,
"weight_max": 879,
"metafields": [],
"review_ratings": 0
}
}
If you have any questions or need further assistance, please do not hesitate to contact our dedicated support team at [email protected].