Product resource - Developer documentation

{
  "id": "<string>",
  "title": "<string>",
  "image": {
    "id": "<string>",
    "url": "<string>",
    "altText": "<string>"
  },
  "variants": [
    {
      "id": "<string>",
      "title": "<string>",
      "image": {
        "id": "<string>",
        "url": "<string>",
        "altText": "<string>"
      },
      "price": 123,
      "purchaseOptions": [
        {
          "name": "<string>",
          "price": 123,
          "interval": {
            "intervalCount": 123
          }
        }
      ]
    }
  ],
  "collections": [
    {
      "handle": "<string>"
    }
  ]
}

The Product object is a purchasable resource, it comes with multiple purchase options based on the subscription offers set up in your account. Customers can subscribe to a product or add them as onetime purchases to upcoming recurring orders.

Search query fields

Field	Description	Type
id	The product identifier	string
title	The product title	string
status	The product status	enum (`ACTIVE`, `ARCHIVED`, `DRAFT`)
availability	The product availability	enum (`not-for-sale`, `out-of-stock`, `subscription-only`, `onetime-only`, `available`)
variants.id	The product’s variant id	string
variants.title	The product’s variant title	string
collections.handle	The product’s collections’ handle	string

Reference

string

required

Minimum string length: 1

title

string

required

Minimum string length: 1

image

null | object

required

Show child attributes

variants

ProductVariant · object[]

required

Show child attributes

collections

object[]

required

Show child attributes

Introduction List products

⌘I

​Search query fields

​Reference

Search query fields

Reference