For dev - Product Properties (App Lib V2)
In this article
This instruction is appropriate for App Lib V2 only. The app lib V3 associated documents will be available soon. 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 Id of the variant |
| available | 'available': true Whether the product is available or not Allowed values: - true - false (default) |
| title | 'title': 'iPod Nano - 8GB' The name of the product. |
| body_html | 'body_htm': 'The small iPod with a big idea: Video.' A description of the product. Supports HTML formatting. |
| vendor | 'vendor': 'Apple' The name of the product's vendor. |
| product_type | 'product_type': 'phone' The product type of the product. |
| handle | 'handle': 'ipod-nano' A unique human-friendly string for the product. Automatically generated from the product's title. Used by the Liquid templating language to refer to objects. |
| published_at | 'published_at': '2007-12-31T19:00:00-05:00' The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel. |
| published_scope | 'published_scope': 'global' Whether the product is published to the Point of Sale channel. Allowed values: - web: The product is published to the Online Store channel but not published to the Point of Sale channel. - global: The product is published to both the Online Store channel and the Point of Sale channel. |
| template_suffix | 'template_suffix': 'special' The suffix of the Liquid template used for the product page. If this property is specified, then the product page uses a template called "product.suffix.liquid", where "suffix" is the value of this property. If this property is "" or null, then the product page uses the default template "product.liquid". (default: null) |
| tags | 'tags': [ 'collection:tops', 'style:Arty' ] An array of tags that are used for filtering and search. Each comma-separated tag can have up to 255 characters. |
| price_min | 'price_min': 199.00 The Min Variant Price of the Product |
| price_max | 'price_max': 210.00 The Max Variant Price of the Product |
| compare_at_price_min | 'compare_at_price_min': 200.00 The original min price of the variant of the product before an adjustment or a sale. |
| compare_at_price_max | 'compare_at_price_max': 300.00 The original max price of the variant of the product before an adjustment or a sale. |
| percent_sale_min | 'percent_sale_min': 15 The min percent sale of the product. |
| images | 'images': { '1': 'https://cdn.shopify.com/s/files/1/1052/4162/products/blade-120-s-330mm-13-rotor-diameter-bnf-helicopter-motion-rc-11645442310.jpg?v=1498346048', '2': 'https://cdn.shopify.com/s/files/1/1052/4162/products/blade-120-s-330mm-13-rotor-diameter-bnf-helicopter-motion-rc-11298495750.jpg?v=1498346048' } Images of the product |
| images_info | 'images_info': [ { 'id': 26209109004, 'position': 1, 'src': 'https://cdn.shopify.com/s/files/1/1052/4162/products/blade-120-s-330mm-13-rotor-diameter-bnf-helicopter-motion-rc-11645442310.jpg?v=1498346048', 'width': 1020, 'height': 680 }, { 'id': 26209109708, 'position': 2, 'src': 'https://cdn.shopify.com/s/files/1/1052/4162/products/blade-120-s-330mm-13-rotor-diameter-bnf-helicopter-motion-rc-11298495750.jpg?v=1498346048', 'width': 1020, 'height': 680 } ] Images info of the product |
| weight_min | 'weight_min': 5 The min weight of the product. |
| weight_max | 'weight_max': 15 The max weight of the product. |
| metafields | 'metafields': [ { 'namespace': 'stamped', 'key': 'reviews_average', 'value': '5' }, { 'namespace': 'stamped', 'key': 'reviews_count', 'value': 5 } ] Metafields of the product |
| review_ratings | 'review_rating': 0 Calculated review rating of the product for filtering and sorting |
| variants | 'variants': [ variant 1, variant 2, ] Variants of the product. Check below variant properties for more information |
Variants Properties
| Property | Description |
| id | 'id': 28652161170 Id of the variant |
| available | 'available': true Whether the variant is available or not Allowed values: - true - false (default) |
| merged_options | 'merged_options': [ "color:Yellow", "size:S/M" ] Combined options of the variant for filtering |
| image | 'image': null Image of the variant |
| title | 'title': 'S / Yellow' Title of the variant |
| sku | 'sku': 'WLT-K100R' SKU of the variant |
| barcode | 'barcode': '23123123' Barcode of the variant |
| inventory_management | 'inventory_management': 'shopify' The fulfillment service that tracks the number of items in stock for the product variant. If you track the inventory yourself using the admin, then set the value to "shopify". Valid values: shopify or the handle of a fulfillment service that has inventory management enabled. Must be the same fulfillment service referenced by the fulfillment_service property. |
| inventory_policy | 'inventory_policy': 'continue' Whether customers are allowed to place an order for the product variant when it's out of stock. Allowed values: - deny: Customers are not allowed to place orders for the product variant if it's out of stock. (default) - continue: Customers are allowed to place orders for the product variant if it's out of stock. |
| inventory_quantity | 'inventory_quantity': 10 An aggregate of inventory across all locations. |
| price | 'price': 199.00 The price of the product variant. |
| compare_at_price | 'compare_at_price': 299.00 The original price of the item before an adjustment or a sale. |
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": {
},
"images_info": [
{
"id": 17677375442,
"position": 1,
"width": 762,
"height": 1100
},
{
"id": 17677375506,
"position": 2,
"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
}
![https://cdn.shopify.com/s/files/1/1651/2159/products/1_2e3ce250-465b-41e4-9ede-4e520d92dffd.jpg?v=1481416402"](https://cdn.shopify.com/s/files/1/1651/2159/products/1_2e3ce250-465b-41e4-9ede-4e520d92dffd.jpg?v=1481416402"){kind=link}
![https://cdn.shopify.com/s/files/1/1651/2159/products/4_fa3ba281-e7d6-4c54-b16d-76ab7799a49a.jpg?v=1481416402"](https://cdn.shopify.com/s/files/1/1651/2159/products/4_fa3ba281-e7d6-4c54-b16d-76ab7799a49a.jpg?v=1481416402"){kind=link}