A product in the store.

PropertiesTypeDescription
availablebooleanReturns true if at least one of the variants of the product is available. Returns false if not.

For a variant to be available, it needs to meet one of the following criteria:
- The variant.inventory_quantity is greater than 0.
- The inventory_policy is set to continue.
compare_at_pricestringThe compare at price of any variants of the product in the currency's subunit.

The value is output in the customer's local (presentment) currency.
compare_at_price_maxstringThe highest compare at price of any variants of the product in the currency's subunit.

The value is output in the customer's local (presentment) currency.
compare_at_price_minstringThe lowest compare at price of any variants of the product in the currency's subunit.

The value is output in the customer's local (presentment) currency.
created_atstringA data time for when the product was created.
display_fake_salesbooleanReturns true if the product enables virtual sales. Returns false if not.

The product sales are equal to the current real sales plus the virtual sales (Product sales = current real sales + virtual sales) when the product enables virtual sales.
fake_salesnumberThe fake sales of the product.
handlestringThe handle of the product.
has_only_default_variantbooleanReturns true if the product doesn't have any options. Returns false if not.
idstringThe ID of the product.
imageimageThe first image is attached to the product.
imagesan array of imageThe images are attached to the product.
metafieldsThe metafields applied to the product.
inventory_policystring from a set of valuesWhether the product should continue to be sold when it's out of stock.
inventory_quantitynumberThe inventory quantity of all variants of the product.
inventory_trackingbooleanReturns true if the product enables inventory tracking. Returns false if not.
mixed_wholesalebooleanReturns true if the product supports mixed wholesale. Returns false if not.
need_variant_imagebooleanReturns true if the product enables the image required. Returns false if not.
optionsan array of product_optionThe options on the product.
pricestringThe price of any variants of the product in the currency's subunit.

The value is output in the customer's local (presentment) currency.
price_maxstringThe highest price of any variants of the product in the currency's subunit.

The value is output in the customer's local (presentment) currency.
price_minstringThe lowest price of any variants of the product in the currency's subunit.

The value is output in the customer's local (presentment) currency.
price_variesboolean
publishedbooleanReturns true if the product is published. Returns false if not.
published_atstringDate and time for when the product was published.
requires_shippingbooleanReturns true if the product needs shipping. Returns false if not.
salesnumberThe sales of the product.
spustringSPU refers to products with the same value and attribute.
tagsstringThe tags of the product.
taxablebooleanReturns true if taxes should be charged on the product. Returns false if not.
titlestringThe title of the product.
updated_atstringA data time for when the product was updated.
urlstringThe relative URL of the product.
variantsan array of variantThe variants of the product.
vendorstringThe vendor of the product.
vendor_urlstringThe vendor URL of the product.

inventory_policy values

Possible valuesDescription
auto_unpublishedAuto unpublished when the product is out of stock.
continueContinue selling when the product is out of stock.
denyStop selling when the product is out of stock.
{
  "id": "588ed0ce-40af-44c7-8dea-afa18b489ef8",
  "title": "Zoe Fedora",
  "brief": "",
  "description": "Sporty yet sophisticated, this short-sleeve ribbed crewneck is made from super-fine Egyptian cotton with stretch that hugs in all the right places. Finished with varsity stripe detail on the cuff and hem. 55% linen, 45% cotton oversized relax fit cotton herringbone drawcord cold delicate machine wash Model is 177cm, wearing size S. This is a demo store. You can purchase products like this from rag&bone<\/a>.",
  "vendor": "Nero",
  "vendor_url": "",
  "has_only_default_variant": false,
  "requires_shipping": true,
  "taxable": false,
  "inventory_policy": "deny",
  "inventory_quantity": 503,
  "inventory_tracking": true,
  "published": true,
  "handle": "zoe-fedora",
  "spu": "",
  "note": "",
  "need_variant_image": true,
  "fake_sales": 0,
  "display_fake_sales": false,
  "independent_seo": false,
  "updated_at": "2022-02-10T02:30:48Z",
  "created_at": "2022-02-10T02:30:49Z",
  "mixed_wholesale": false,
  "product_type": "",
  "tags": "Color_DarkGray,Color_Lightcoral,Location_Colorado,Price_$200-$300",
  "available": true,
  "price_min": "255",
  "price": "255",
  "price_max": "255",
  "compare_at_price_min": "0",
  "compare_at_price": "0",
  "compare_at_price_max": "0",
  "retail_price_min": "0",
  "retail_price_max": "0",
  "url": "\/products\/zoe-fedora",
  "published_at": "2022-02-10T02:30:49Z",
  "sales": 21,
  "image": {
    "src": "\/\/img.staticdj.com\/ca250f986a8799da153565a6a8ea55d2.jpeg",
    "path": "ca250f986a8799da153565a6a8ea55d2.jpeg",
    "width": 1280,
    "height": 1710,
    "alt": "Zoe Fedora Nero Noe - stg",
    "aspect_ratio": 0.7485380116959064
  },
  "meta_title": "Zoe Fedora",
  "meta_description": "Sporty yet sophisticated, this short-sleeve ribbed crewneck is made from super-fine Egyptian cotton with stretch that hugs in all the right places. Finished with varsity stripe detail on the cuff and hem. 55% linen, 45% cotton oversized relax fit cotton herringbone drawcord cold delicate machine wash Model is 177cm, wearing size S. This is a demo store. You can purchase products like this from rag&bone<\/a>.",
  "meta_keyword": "",
  "options": [
    {
      "id": "afc6fa3b-c895-49eb-8d1c-fc099f78f7a8",
      "name": "Color",
      "position": 1,
      "values": [
        "DarkOliveGreen",
        "Moccasin"
      ]
    },
    {
      "id": "25085627-8c3a-4c78-b0e2-38efe4a27490",
      "name": "Size",
      "position": 2,
      "values": [
        "S",
        "M",
        "L"
      ]
    }
  ],
  "variants": [
    {
      "id": "83196e5a-b25f-42c3-8df5-359d83ea7ae8",
      "product_id": "588ed0ce-40af-44c7-8dea-afa18b489ef8",
      "title": "DarkOliveGreen-S",
      "weight_unit": "kg",
      "inventory_quantity": 74,
      "sku": "WJW19F1014LA14-1",
      "barcode": "",
      "position": 1,
      "option1": "DarkOliveGreen",
      "option2": "S",
      "option3": "",
      "note": "",
      "image": {
        "src": "\/\/img.staticdj.com\/9974fe2bd69a80624c2c47976568b252.jpeg",
        "path": "9974fe2bd69a80624c2c47976568b252.jpeg",
        "width": 1280,
        "height": 1710,
        "alt": "Zoe Fedora Nero Noe - stg",
        "aspect_ratio": 0.7485380116959064
      },
      "wholesale_price": [
        {
          "price": 255,
          "min_quantity": 1
        }
      ],
      "weight": "0",
      "compare_at_price": "0",
      "price": "255",
      "retail_price": "0",
      "available": true,
      "url": "\/products\/zoe-fedora?variant=83196e5a-b25f-42c3-8df5-359d83ea7ae8",
      "available_quantity": 74,
      "options": [
        {
          "name": "Color",
          "value": "DarkOliveGreen"
        },
        {
          "name": "Size",
          "value": "S"
        }
      ],
      "off_ratio": 0,
      "flashsale_info": [],
      "sales": 21
    },
    {
      "id": "e675452a-0dc1-4d89-a4f3-bdd4f94c99ee",
      "product_id": "588ed0ce-40af-44c7-8dea-afa18b489ef8",
      "title": "DarkOliveGreen-M",
      "weight_unit": "kg",
      "inventory_quantity": 83,
      "sku": "WJW19F1014LA14-2",
      "barcode": "",
      "position": 2,
      "option1": "DarkOliveGreen",
      "option2": "M",
      "option3": "",
      "note": "",
      "image": {
        "src": "\/\/img.staticdj.com\/9974fe2bd69a80624c2c47976568b252.jpeg",
        "path": "9974fe2bd69a80624c2c47976568b252.jpeg",
        "width": 1280,
        "height": 1710,
        "alt": "Zoe Fedora Nero Noe - stg",
        "aspect_ratio": 0.7485380116959064
      },
      "wholesale_price": [
        {
          "price": 255,
          "min_quantity": 1
        }
      ],
      "weight": "0",
      "compare_at_price": "0",
      "price": "255",
      "retail_price": "0",
      "available": true,
      "url": "\/products\/zoe-fedora?variant=e675452a-0dc1-4d89-a4f3-bdd4f94c99ee",
      "available_quantity": 83,
      "options": [
        {
          "name": "Color",
          "value": "DarkOliveGreen"
        },
        {
          "name": "Size",
          "value": "M"
        }
      ],
      "off_ratio": 0,
      "flashsale_info": [],
      "sales": 21
    },
    {
      "id": "b3bc5cde-1a3e-47de-a85b-634ef75082f7",
      "product_id": "588ed0ce-40af-44c7-8dea-afa18b489ef8",
      "title": "DarkOliveGreen-L",
      "weight_unit": "kg",
      "inventory_quantity": 90,
      "sku": "WJW19F1014LA14-3",
      "barcode": "",
      "position": 3,
      "option1": "DarkOliveGreen",
      "option2": "L",
      "option3": "",
      "note": "",
      "image": {
        "src": "\/\/img.staticdj.com\/9974fe2bd69a80624c2c47976568b252.jpeg",
        "path": "9974fe2bd69a80624c2c47976568b252.jpeg",
        "width": 1280,
        "height": 1710,
        "alt": "Zoe Fedora Nero Noe - stg",
        "aspect_ratio": 0.7485380116959064
      },
      "wholesale_price": [
        {
          "price": 255,
          "min_quantity": 1
        }
      ],
      "weight": "0",
      "compare_at_price": "0",
      "price": "255",
      "retail_price": "0",
      "available": true,
      "url": "\/products\/zoe-fedora?variant=b3bc5cde-1a3e-47de-a85b-634ef75082f7",
      "available_quantity": 90,
      "options": [
        {
          "name": "Color",
          "value": "DarkOliveGreen"
        },
        {
          "name": "Size",
          "value": "L"
        }
      ],
      "off_ratio": 0,
      "flashsale_info": [],
      "sales": 21
    },
    {
      "id": "fb1e52f8-ff9c-46c8-8a7b-57f42fa9e81c",
      "product_id": "588ed0ce-40af-44c7-8dea-afa18b489ef8",
      "title": "Moccasin-S",
      "weight_unit": "kg",
      "inventory_quantity": 87,
      "sku": "WJW19F1014LA14-4",
      "barcode": "",
      "position": 4,
      "option1": "Moccasin",
      "option2": "S",
      "option3": "",
      "note": "",
      "image": {
        "src": "\/\/img.staticdj.com\/0921bb7355653c5f5b73a819cfe6bffe.jpeg",
        "path": "0921bb7355653c5f5b73a819cfe6bffe.jpeg",
        "width": 1280,
        "height": 1710,
        "alt": "Zoe Fedora Nero Noe - stg",
        "aspect_ratio": 0.7485380116959064
      },
      "wholesale_price": [
        {
          "price": 255,
          "min_quantity": 1
        }
      ],
      "weight": "0",
      "compare_at_price": "0",
      "price": "255",
      "retail_price": "0",
      "available": true,
      "url": "\/products\/zoe-fedora?variant=fb1e52f8-ff9c-46c8-8a7b-57f42fa9e81c",
      "available_quantity": 87,
      "options": [
        {
          "name": "Color",
          "value": "Moccasin"
        },
        {
          "name": "Size",
          "value": "S"
        }
      ],
      "off_ratio": 0,
      "flashsale_info": [],
      "sales": 21
    },
    {
      "id": "f06049a2-6627-422f-a181-707b8579ae3d",
      "product_id": "588ed0ce-40af-44c7-8dea-afa18b489ef8",
      "title": "Moccasin-M",
      "weight_unit": "kg",
      "inventory_quantity": 79,
      "sku": "WJW19F1014LA14-5",
      "barcode": "",
      "position": 5,
      "option1": "Moccasin",
      "option2": "M",
      "option3": "",
      "note": "",
      "image": {
        "src": "\/\/img.staticdj.com\/0921bb7355653c5f5b73a819cfe6bffe.jpeg",
        "path": "0921bb7355653c5f5b73a819cfe6bffe.jpeg",
        "width": 1280,
        "height": 1710,
        "alt": "Zoe Fedora Nero Noe - stg",
        "aspect_ratio": 0.7485380116959064
      },
      "wholesale_price": [
        {
          "price": 255,
          "min_quantity": 1
        }
      ],
      "weight": "0",
      "compare_at_price": "0",
      "price": "255",
      "retail_price": "0",
      "available": true,
      "url": "\/products\/zoe-fedora?variant=f06049a2-6627-422f-a181-707b8579ae3d",
      "available_quantity": 79,
      "options": [
        {
          "name": "Color",
          "value": "Moccasin"
        },
        {
          "name": "Size",
          "value": "M"
        }
      ],
      "off_ratio": 0,
      "flashsale_info": [],
      "sales": 21
    },
    {
      "id": "1c13e798-b3e7-4df9-ad9c-35a2a1310ae7",
      "product_id": "588ed0ce-40af-44c7-8dea-afa18b489ef8",
      "title": "Moccasin-L",
      "weight_unit": "kg",
      "inventory_quantity": 90,
      "sku": "WJW19F1014LA14-6",
      "barcode": "",
      "position": 6,
      "option1": "Moccasin",
      "option2": "L",
      "option3": "",
      "note": "",
      "image": {
        "src": "\/\/img.staticdj.com\/0921bb7355653c5f5b73a819cfe6bffe.jpeg",
        "path": "0921bb7355653c5f5b73a819cfe6bffe.jpeg",
        "width": 1280,
        "height": 1710,
        "alt": "Zoe Fedora Nero Noe - stg",
        "aspect_ratio": 0.7485380116959064
      },
      "wholesale_price": [
        {
          "price": 255,
          "min_quantity": 1
        }
      ],
      "weight": "0",
      "compare_at_price": "0",
      "price": "255",
      "retail_price": "0",
      "available": true,
      "url": "\/products\/zoe-fedora?variant=1c13e798-b3e7-4df9-ad9c-35a2a1310ae7",
      "available_quantity": 90,
      "options": [
        {
          "name": "Color",
          "value": "Moccasin"
        },
        {
          "name": "Size",
          "value": "L"
        }
      ],
      "off_ratio": 0,
      "flashsale_info": [],
      "sales": 21
    }
  ],
  "images": [
    {
      "src": "\/\/img.staticdj.com\/ca250f986a8799da153565a6a8ea55d2.jpeg",
      "path": "ca250f986a8799da153565a6a8ea55d2.jpeg",
      "width": 1280,
      "height": 1710,
      "alt": "Zoe Fedora Nero Noe - stg",
      "aspect_ratio": 0.7485380116959064
    },
    {
      "src": "\/\/img.staticdj.com\/4b1ea3524b2c2b0ad0e04e02aaa9b1c8.jpeg",
      "path": "4b1ea3524b2c2b0ad0e04e02aaa9b1c8.jpeg",
      "width": 1280,
      "height": 1710,
      "alt": "Zoe Fedora Nero Noe - stg",
      "aspect_ratio": 0.7485380116959064
    },
    {
      "src": "\/\/img.staticdj.com\/9974fe2bd69a80624c2c47976568b252.jpeg",
      "path": "9974fe2bd69a80624c2c47976568b252.jpeg",
      "width": 1280,
      "height": 1710,
      "alt": "Zoe Fedora Nero Noe - stg",
      "aspect_ratio": 0.7485380116959064
    },
    {
      "src": "\/\/img.staticdj.com\/4b1ea3524b2c2b0ad0e04e02aaa9b1c8.jpeg",
      "path": "4b1ea3524b2c2b0ad0e04e02aaa9b1c8.jpeg",
      "width": 1280,
      "height": 1710,
      "alt": "Zoe Fedora Nero Noe - stg",
      "aspect_ratio": 0.7485380116959064
    },
    {
      "src": "\/\/img.staticdj.com\/0921bb7355653c5f5b73a819cfe6bffe.jpeg",
      "path": "0921bb7355653c5f5b73a819cfe6bffe.jpeg",
      "width": 1280,
      "height": 1710,
      "alt": "Zoe Fedora Nero Noe - stg",
      "aspect_ratio": 0.7485380116959064
    },
    {
      "src": "\/\/img.staticdj.com\/f3c255209b09906dd7ae2926401a2be3.jpeg",
      "path": "f3c255209b09906dd7ae2926401a2be3.jpeg",
      "width": 1280,
      "height": 1710,
      "alt": "Zoe Fedora Nero Noe - stg",
      "aspect_ratio": 0.7485380116959064
    }
  ],
  "redirect": false,
  "redirect_url": "",
  "retail_price": "0",
  "price_varies": true,
  "off_ratio": 0,
  "flashsale_info": []
}