The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

Product

Requires products access scope.

Important

Listing, creating, updating, and deleting products is deprecated as of REST API 2024-04. For more information, refer to the guide to the new product model.

The Product resource lets you update and create products in a merchant's store. You can use product variants with the Product resource to create or update different versions of the same product. You can also add or update product images.

You can add products to collections with the CustomCollection resource and the SmartCollection resource.

Was this section helpful?
Anchor to section titled 'The Product resource'

The Product resource

Properties
body_html
string
->descriptionHtml
A description of the product. Supports HTML formatting.
created_at
date
ISO 8601
read-only
->createdAt
The date and time (ISO 8601 format) when the product was created.
handle
string
->handle
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.
id
integer
int64
read-only
->id
An unsigned 64-bit integer that's used as a unique identifier for the product. Each id is unique across the Shopify system. No two products will have the same id, even if they're from different shops.
images
array
->media
A list of product image objects, each one representing an image associated with the product.
options
array
->options
The custom product properties. For example, Size, Color, and Material. Each product can have up to 3 options and each option value can be up to 255 characters. Product variants are made of up combinations of option values. Options cannot be created without values. To create new options, a variant with an associated option value also needs to be created.
product_type
string
->productType
A categorization for the product used for filtering and searching products.
published_at
date
ISO 8601
->publishedAt
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
string
Whether the product is published to the Point of Sale channel. Valid values:
status
string
->status
The status of the product. Valid values:
tags
string
->tags
A string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters.
template_suffix
string
->templateSuffix
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)
Was this section helpful?
{}The Product resource
{
  "body_html": "It's the small iPod with a big idea: Video.",
  "created_at": "2012-02-15T15:12:21-05:00",
  "handle": "ipod-nano",
  "id": 632910392,
  "images": [
    {
      "id": 850703190,
      "product_id": 632910392,
      "position": 1,
      "created_at": "2018-01-08T12:34:47-05:00",
      "updated_at": "2018-01-08T12:34:47-05:00",
      "width": 110,
      "height": 140,
      "src": "http://example.com/burton.jpg",
      "variant_ids": [
        {}
      ]
    }
  ],
  "options": {
    "id": 594680422,
    "product_id": 632910392,
    "name": "Color",
    "position": 1,
    "values": [
      "Pink",
      "Red",
      "Green",
      "Black"
    ]
  },
  "product_type": "Cult Products",
  "published_at": "2007-12-31T19:00:00-05:00",
  "published_scope": "global",
  "status": "active",
  "tags": "Emotive, Flash Memory, MP3, Music",
  "template_suffix": "special",
  "title": "IPod Nano - 8GB",
  "updated_at": "2012-08-24T14:01:47-04:00",
  "variants": [
    {
      "barcode": "1234_pink",
      "compare_at_price": null,
      "created_at": "2012-08-24T14:01:47-04:00",
      "fulfillment_service": "manual",
      "grams": 567,
      "weight": 0.2,
      "weight_unit": "kg",
      "id": 808950810,
      "inventory_item_id": 341629,
      "inventory_management": "shopify",
      "inventory_policy": "continue",
      "inventory_quantity": 10,
      "option1": "Pink",
      "position": 1,
      "price": 199.99,
      "product_id": 632910392,
      "requires_shipping": true,
      "sku": "IPOD2008PINK",
      "taxable": true,
      "title": "Pink",
      "updated_at": "2012-08-24T14:01:47-04:00"
    }
  ],
  "vendor": "Apple"
}
Anchor to section titled 'POST request, Create a new product'

post
Create a new product

productCreate

Create a new product


Anchor to section titled 'Parameters of Create a new product'

Parameters

api_version
string
required
Was this section helpful?
Anchor to section titled 'Examples of Create a new product'

Examples

Request body
product
Product resource
Was this section helpful?
post
/admin/api/2024-07/products.json
Copy
curl -d '{"product":{"title":"Burton Custom Freestyle 151","body_html":"<strong>Good snowboard!</strong>","vendor":"Burton","product_type":"Snowboard","status":"draft"}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2024-07/products.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
{}Response
JSON
HTTP/1.1 201 Created
{
  "product": {
    "id": 1072481047,
    "title": "Burton Custom Freestyle 151",
    "body_html": "<strong>Good snowboard!</strong>",
    "vendor": "Burton",
    "product_type": "Snowboard",
    "created_at": "2024-09-25T14:25:33-04:00",
    "handle": "burton-custom-freestyle-151",
    "updated_at": "2024-09-25T14:25:34-04:00",
    "published_at": null,
    "template_suffix": null,
    "published_scope": "web",
    "tags": "",
    "status": "draft",
    "admin_graphql_api_id": "gid://shopify/Product/1072481047",
    "variants": [
      {
        "id": 1070325022,
        "product_id": 1072481047,
        "title": "Default Title",
        "price": "0.00",
        "position": 1,
        "inventory_policy": "deny",
        "compare_at_price": null,
        "option1": "Default Title",
        "option2": null,
        "option3": null,
        "created_at": "2024-09-25T14:25:33-04:00",
        "updated_at": "2024-09-25T14:25:33-04:00",
        "taxable": true,
        "barcode": null,
        "fulfillment_service": "manual",
        "grams": 0,
        "inventory_management": null,
        "requires_shipping": true,
        "sku": "",
        "weight": 0,
        "weight_unit": "lb",
        "inventory_item_id": 1070325022,
        "inventory_quantity": 0,
        "old_inventory_quantity": 0,
        "presentment_prices": [
          {
            "price": {
              "amount": "0.00",
              "currency_code": "USD"
            },
            "compare_at_price": null
          }
        ],
        "admin_graphql_api_id": "gid://shopify/ProductVariant/1070325022",
        "image_id": null
      }
    ],
    "options": [
      {
        "id": 1064576497,
        "product_id": 1072481047,
        "name": "Title",
        "position": 1,
        "values": [
          "Default Title"
        ]
      }
    ],
    "images": [],
    "image": null
  }
}
Anchor to section titled 'GET request, Retrieve a list of products'

get
Retrieve a list of products

products
Retrieve a list of products.
Anchor to section titled 'Parameters of Retrieve a list of products'

Parameters

api_version
string
required
collection_id
Return products by product collection ID.
created_at_max
Return products created before a specified date. (format: 2014-04-25T16:15:47-04:00)
created_at_min
Return products created after a specified date. (format: 2014-04-25T16:15:47-04:00)
fields
Return only certain fields specified by a comma-separated list of field names.
handle
Return only products specified by a comma-separated list of product handles.
ids
Return only products specified by a comma-separated list of product IDs.
limit
≤ 250
default 50
Return up to this many results per page.
presentment_currencies
Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes.
product_type
Return products by product type.
published_at_max
Return products published before a specified date. (format: 2014-04-25T16:15:47-04:00)
published_at_min
Return products published after a specified date. (format: 2014-04-25T16:15:47-04:00)
Was this section helpful?
Anchor to section titled 'Examples of Retrieve a list of products'

Examples

Query parameters
ids=632910392921728736
Return only products specified by a comma-separated list of product IDs.
Was this section helpful?
get
/admin/api/2024-07/products.json?ids=632910392921728736
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-07/products.json?ids=632910392%2C921728736" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "products": [
    {
      "id": 632910392,
      "title": "IPod Nano - 8GB",
      "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
      "vendor": "Apple",
      "product_type": "Cult Products",
      "created_at": "2024-09-25T14:24:08-04:00",
      "handle": "ipod-nano",
      "updated_at": "2024-09-25T14:24:08-04:00",
      "published_at": "2007-12-31T19:00:00-05:00",
      "template_suffix": null,
      "published_scope": "web",
      "tags": "Emotive, Flash Memory, MP3, Music",
      "status": "active",
      "admin_graphql_api_id": "gid://shopify/Product/632910392",
      "variants": [
        {
          "id": 808950810,
          "product_id": 632910392,
          "title": "Pink",
          "price": "199.00",
          "position": 1,
          "inventory_policy": "continue",
          "compare_at_price": null,
          "option1": "Pink",
          "option2": null,
          "option3": null,
          "created_at": "2024-09-25T14:24:08-04:00",
          "updated_at": "2024-09-25T14:24:08-04:00",
          "taxable": true,
          "barcode": "1234_pink",
          "fulfillment_service": "manual",
          "grams": 567,
          "inventory_management": "shopify",
          "requires_shipping": true,
          "sku": "IPOD2008PINK",
          "weight": 1.25,
          "weight_unit": "lb",
          "inventory_item_id": 808950810,
          "inventory_quantity": 10,
          "old_inventory_quantity": 10,
          "presentment_prices": [
            {
              "price": {
                "amount": "199.00",
                "currency_code": "USD"
              },
              "compare_at_price": null
            }
          ],
          "admin_graphql_api_id": "gid://shopify/ProductVariant/808950810",
          "image_id": 562641783
        },
        {
          "id": 49148385,
          "product_id": 632910392,
          "title": "Red",
          "price": "199.00",
          "position": 2,
          "inventory_policy": "continue",
          "compare_at_price": null,
          "option1": "Red",
          "option2": null,
          "option3": null,
          "created_at": "2024-09-25T14:24:08-04:00",
          "updated_at": "2024-09-25T14:24:08-04:00",
          "taxable": true,
          "barcode": "1234_red",
          "fulfillment_service": "manual",
          "grams": 567,
          "inventory_management": "shopify",
          "requires_shipping": true,
          "sku": "IPOD2008RED",
          "weight": 1.25,
          "weight_unit": "lb",
          "inventory_item_id": 49148385,
          "inventory_quantity": 20,
          "old_inventory_quantity": 20,
          "presentment_prices": [
            {
              "price": {
                "amount": "199.00",
                "currency_code": "USD"
              },
              "compare_at_price": null
            }
          ],
          "admin_graphql_api_id": "gid://shopify/ProductVariant/49148385",
          "image_id": null
        },
        {
          "id": 39072856,
          "product_id": 632910392,
          "title": "Green",
          "price": "199.00",
          "position": 3,
          "inventory_policy": "continue",
          "compare_at_price": null,
          "option1": "Green",
          "option2": null,
          "option3": null,
          "created_at": "2024-09-25T14:24:08-04:00",
          "updated_at": "2024-09-25T14:24:08-04:00",
          "taxable": true,
          "barcode": "1234_green",
          "fulfillment_service": "manual",
          "grams": 567,
          "inventory_management": "shopify",
          "requires_shipping": true,
          "sku": "IPOD2008GREEN",
          "weight": 1.25,
          "weight_unit": "lb",
          "inventory_item_id": 39072856,
          "inventory_quantity": 30,
          "old_inventory_quantity": 30,
          "presentment_prices": [
            {
              "price": {
                "amount": "199.00",
                "currency_code": "USD"
              },
              "compare_at_price": null
            }
          ],
          "admin_graphql_api_id": "gid://shopify/ProductVariant/39072856",
          "image_id": null
        },
        {
          "id": 457924702,
          "product_id": 632910392,
          "title": "Black",
          "price": "199.00",
          "position": 4,
          "inventory_policy": "continue",
          "compare_at_price": null,
          "option1": "Black",
          "option2": null,
          "option3": null,
          "created_at": "2024-09-25T14:24:08-04:00",
          "updated_at": "2024-09-25T14:24:08-04:00",
          "taxable": true,
          "barcode": "1234_black",
          "fulfillment_service": "manual",
          "grams": 567,
          "inventory_management": "shopify",
          "requires_shipping": true,
          "sku": "IPOD2008BLACK",
          "weight": 1.25,
          "weight_unit": "lb",
          "inventory_item_id": 457924702,
          "inventory_quantity": 40,
          "old_inventory_quantity": 40,
          "presentment_prices": [
            {
              "price": {
                "amount": "199.00",
                "currency_code": "USD"
              },
              "compare_at_price": null
            }
          ],
          "admin_graphql_api_id": "gid://shopify/ProductVariant/457924702",
          "image_id": null
        }
      ],
      "options": [
        {
          "id": 594680422,
          "product_id": 632910392,
          "name": "Color",
          "position": 1,
          "values": [
            "Pink",
            "Red",
            "Green",
            "Black"
          ]
        }
      ],
      "images": [
        {
          "id": 850703190,
          "alt": null,
          "position": 1,
          "product_id": 632910392,
          "created_at": "2024-09-25T14:24:08-04:00",
          "updated_at": "2024-09-25T14:24:08-04:00",
          "admin_graphql_api_id": "gid://shopify/ProductImage/850703190",
          "width": 123,
          "height": 456,
          "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727288648",
          "variant_ids": []
        },
        {
          "id": 562641783,
          "alt": null,
          "position": 2,
          "product_id": 632910392,
          "created_at": "2024-09-25T14:24:08-04:00",
          "updated_at": "2024-09-25T14:24:08-04:00",
          "admin_graphql_api_id": "gid://shopify/ProductImage/562641783",
          "width": 123,
          "height": 456,
          "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano-2.png?v=1727288648",
          "variant_ids": [
            808950810
          ]
        },
        {
          "id": 378407906,
          "alt": null,
          "position": 3,
          "product_id": 632910392,
          "created_at": "2024-09-25T14:24:08-04:00",
          "updated_at": "2024-09-25T14:24:08-04:00",
          "admin_graphql_api_id": "gid://shopify/ProductImage/378407906",
          "width": 123,
          "height": 456,
          "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727288648",
          "variant_ids": []
        }
      ],
      "image": {
        "id": 850703190,
        "alt": null,
        "position": 1,
        "product_id": 632910392,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "admin_graphql_api_id": "gid://shopify/ProductImage/850703190",
        "width": 123,
        "height": 456,
        "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727288648",
        "variant_ids": []
      }
    },
    {
      "id": 921728736,
      "title": "IPod Touch 8GB",
      "body_html": "<p>The iPod Touch has the iPhone's multi-touch interface, with a physical home button off the touch screen. The home screen has a list of buttons for the available applications.</p>",
      "vendor": "Apple",
      "product_type": "Cult Products",
      "created_at": "2024-09-25T14:24:08-04:00",
      "handle": "ipod-touch",
      "updated_at": "2024-09-25T14:24:08-04:00",
      "published_at": "2008-09-25T20:00:00-04:00",
      "template_suffix": null,
      "published_scope": "web",
      "tags": "",
      "status": "active",
      "admin_graphql_api_id": "gid://shopify/Product/921728736",
      "variants": [
        {
          "id": 447654529,
          "product_id": 921728736,
          "title": "Black",
          "price": "199.00",
          "position": 1,
          "inventory_policy": "continue",
          "compare_at_price": null,
          "option1": "Black",
          "option2": null,
          "option3": null,
          "created_at": "2024-09-25T14:24:08-04:00",
          "updated_at": "2024-09-25T14:24:08-04:00",
          "taxable": true,
          "barcode": "1234_black",
          "fulfillment_service": "manual",
          "grams": 567,
          "inventory_management": "shopify",
          "requires_shipping": true,
          "sku": "IPOD2009BLACK",
          "weight": 1.25,
          "weight_unit": "lb",
          "inventory_item_id": 447654529,
          "inventory_quantity": 13,
          "old_inventory_quantity": 13,
          "presentment_prices": [
            {
              "price": {
                "amount": "199.00",
                "currency_code": "USD"
              },
              "compare_at_price": null
            }
          ],
          "admin_graphql_api_id": "gid://shopify/ProductVariant/447654529",
          "image_id": null
        }
      ],
      "options": [
        {
          "id": 891236591,
          "product_id": 921728736,
          "name": "Title",
          "position": 1,
          "values": [
            "Black"
          ]
        }
      ],
      "images": [],
      "image": null
    }
  ]
}
Anchor to section titled 'GET request, Retrieve a single product'

get
Retrieve a single product

product
Retrieve a single product.
Anchor to section titled 'Parameters of Retrieve a single product'

Parameters

api_version
string
required
product_id
string
required
fields
A comma-separated list of fields to include in the response.
Was this section helpful?
Anchor to section titled 'Examples of Retrieve a single product'

Examples

Path parameters
productid=632910392
string
required
Was this section helpful?
get
/admin/api/2024-07/products/632910392.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-07/products/632910392.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "product": {
    "id": 632910392,
    "title": "IPod Nano - 8GB",
    "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
    "vendor": "Apple",
    "product_type": "Cult Products",
    "created_at": "2024-09-25T14:24:08-04:00",
    "handle": "ipod-nano",
    "updated_at": "2024-09-25T14:24:08-04:00",
    "published_at": "2007-12-31T19:00:00-05:00",
    "template_suffix": null,
    "published_scope": "web",
    "tags": "Emotive, Flash Memory, MP3, Music",
    "status": "active",
    "admin_graphql_api_id": "gid://shopify/Product/632910392",
    "variants": [
      {
        "id": 808950810,
        "product_id": 632910392,
        "title": "Pink",
        "price": "199.00",
        "position": 1,
        "inventory_policy": "continue",
        "compare_at_price": null,
        "option1": "Pink",
        "option2": null,
        "option3": null,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "taxable": true,
        "barcode": "1234_pink",
        "fulfillment_service": "manual",
        "grams": 567,
        "inventory_management": "shopify",
        "requires_shipping": true,
        "sku": "IPOD2008PINK",
        "weight": 1.25,
        "weight_unit": "lb",
        "inventory_item_id": 808950810,
        "inventory_quantity": 10,
        "old_inventory_quantity": 10,
        "presentment_prices": [
          {
            "price": {
              "amount": "199.00",
              "currency_code": "USD"
            },
            "compare_at_price": null
          }
        ],
        "admin_graphql_api_id": "gid://shopify/ProductVariant/808950810",
        "image_id": 562641783
      },
      {
        "id": 49148385,
        "product_id": 632910392,
        "title": "Red",
        "price": "199.00",
        "position": 2,
        "inventory_policy": "continue",
        "compare_at_price": null,
        "option1": "Red",
        "option2": null,
        "option3": null,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "taxable": true,
        "barcode": "1234_red",
        "fulfillment_service": "manual",
        "grams": 567,
        "inventory_management": "shopify",
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "weight": 1.25,
        "weight_unit": "lb",
        "inventory_item_id": 49148385,
        "inventory_quantity": 20,
        "old_inventory_quantity": 20,
        "presentment_prices": [
          {
            "price": {
              "amount": "199.00",
              "currency_code": "USD"
            },
            "compare_at_price": null
          }
        ],
        "admin_graphql_api_id": "gid://shopify/ProductVariant/49148385",
        "image_id": null
      },
      {
        "id": 39072856,
        "product_id": 632910392,
        "title": "Green",
        "price": "199.00",
        "position": 3,
        "inventory_policy": "continue",
        "compare_at_price": null,
        "option1": "Green",
        "option2": null,
        "option3": null,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "taxable": true,
        "barcode": "1234_green",
        "fulfillment_service": "manual",
        "grams": 567,
        "inventory_management": "shopify",
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "weight": 1.25,
        "weight_unit": "lb",
        "inventory_item_id": 39072856,
        "inventory_quantity": 30,
        "old_inventory_quantity": 30,
        "presentment_prices": [
          {
            "price": {
              "amount": "199.00",
              "currency_code": "USD"
            },
            "compare_at_price": null
          }
        ],
        "admin_graphql_api_id": "gid://shopify/ProductVariant/39072856",
        "image_id": null
      },
      {
        "id": 457924702,
        "product_id": 632910392,
        "title": "Black",
        "price": "199.00",
        "position": 4,
        "inventory_policy": "continue",
        "compare_at_price": null,
        "option1": "Black",
        "option2": null,
        "option3": null,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "taxable": true,
        "barcode": "1234_black",
        "fulfillment_service": "manual",
        "grams": 567,
        "inventory_management": "shopify",
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "weight": 1.25,
        "weight_unit": "lb",
        "inventory_item_id": 457924702,
        "inventory_quantity": 40,
        "old_inventory_quantity": 40,
        "presentment_prices": [
          {
            "price": {
              "amount": "199.00",
              "currency_code": "USD"
            },
            "compare_at_price": null
          }
        ],
        "admin_graphql_api_id": "gid://shopify/ProductVariant/457924702",
        "image_id": null
      }
    ],
    "options": [
      {
        "id": 594680422,
        "product_id": 632910392,
        "name": "Color",
        "position": 1,
        "values": [
          "Pink",
          "Red",
          "Green",
          "Black"
        ]
      }
    ],
    "images": [
      {
        "id": 850703190,
        "alt": null,
        "position": 1,
        "product_id": 632910392,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "admin_graphql_api_id": "gid://shopify/ProductImage/850703190",
        "width": 123,
        "height": 456,
        "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727288648",
        "variant_ids": []
      },
      {
        "id": 562641783,
        "alt": null,
        "position": 2,
        "product_id": 632910392,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "admin_graphql_api_id": "gid://shopify/ProductImage/562641783",
        "width": 123,
        "height": 456,
        "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano-2.png?v=1727288648",
        "variant_ids": [
          808950810
        ]
      },
      {
        "id": 378407906,
        "alt": null,
        "position": 3,
        "product_id": 632910392,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "admin_graphql_api_id": "gid://shopify/ProductImage/378407906",
        "width": 123,
        "height": 456,
        "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727288648",
        "variant_ids": []
      }
    ],
    "image": {
      "id": 850703190,
      "alt": null,
      "position": 1,
      "product_id": 632910392,
      "created_at": "2024-09-25T14:24:08-04:00",
      "updated_at": "2024-09-25T14:24:08-04:00",
      "admin_graphql_api_id": "gid://shopify/ProductImage/850703190",
      "width": 123,
      "height": 456,
      "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727288648",
      "variant_ids": []
    }
  }
}
Anchor to section titled 'GET request, Retrieve a count of products'

get
Retrieve a count of products

productsCount
Retrieve a count of products.
Anchor to section titled 'Parameters of Retrieve a count of products'

Parameters

api_version
string
required
collection_id
Return products by product collection ID.
created_at_max
Return products created before a specified date. (format: 2014-04-25T16:15:47-04:00)
created_at_min
Return products created after a specified date. (format: 2014-04-25T16:15:47-04:00)
product_type
Return products by product type.
published_at_max
Return products published before a specified date. (format: 2014-04-25T16:15:47-04:00)
published_at_min
Return products published after a specified date. (format: 2014-04-25T16:15:47-04:00)
published_status
default any
Return products by their published status.
updated_at_max
Return products last updated before a specified date. (format: 2014-04-25T16:15:47-04:00)
updated_at_min
Return products last updated after a specified date. (format: 2014-04-25T16:15:47-04:00)
vendor
Return products by product vendor.
Was this section helpful?
Anchor to section titled 'Examples of Retrieve a count of products'

Examples

Was this section helpful?
get
/admin/api/2024-07/products/count.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-07/products/count.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "count": 2
}
Anchor to section titled 'PUT request, Updates a product'

put
Updates a product

productUpdate

Update a product


Anchor to section titled 'Parameters of Updates a product'

Parameters

api_version
string
required
product_id
string
required
Was this section helpful?
Anchor to section titled 'Examples of Updates a product'

Examples

Path parameters
productid=632910392
string
required
Request body
product
Product resource
Was this section helpful?
put
/admin/api/2024-07/products/632910392.json
Copy
curl -d '{"product":{"id":632910392,"metafields":[{"key":"new","value":"newvalue","type":"single_line_text_field","namespace":"global"}]}}' \
-X PUT "https://your-development-store.myshopify.com/admin/api/2024-07/products/632910392.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
{}Response
JSON
HTTP/1.1 200 OK
{
  "product": {
    "id": 632910392,
    "title": "IPod Nano - 8GB",
    "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
    "vendor": "Apple",
    "product_type": "Cult Products",
    "created_at": "2024-09-25T14:24:08-04:00",
    "handle": "ipod-nano",
    "updated_at": "2024-09-25T14:26:29-04:00",
    "published_at": "2007-12-31T19:00:00-05:00",
    "template_suffix": null,
    "published_scope": "web",
    "tags": "Emotive, Flash Memory, MP3, Music",
    "status": "active",
    "admin_graphql_api_id": "gid://shopify/Product/632910392",
    "variants": [
      {
        "id": 808950810,
        "product_id": 632910392,
        "title": "Pink",
        "price": "199.00",
        "position": 1,
        "inventory_policy": "continue",
        "compare_at_price": null,
        "option1": "Pink",
        "option2": null,
        "option3": null,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "taxable": true,
        "barcode": "1234_pink",
        "fulfillment_service": "manual",
        "grams": 567,
        "inventory_management": "shopify",
        "requires_shipping": true,
        "sku": "IPOD2008PINK",
        "weight": 1.25,
        "weight_unit": "lb",
        "inventory_item_id": 808950810,
        "inventory_quantity": 10,
        "old_inventory_quantity": 10,
        "presentment_prices": [
          {
            "price": {
              "amount": "199.00",
              "currency_code": "USD"
            },
            "compare_at_price": null
          }
        ],
        "admin_graphql_api_id": "gid://shopify/ProductVariant/808950810",
        "image_id": 562641783
      },
      {
        "id": 49148385,
        "product_id": 632910392,
        "title": "Red",
        "price": "199.00",
        "position": 2,
        "inventory_policy": "continue",
        "compare_at_price": null,
        "option1": "Red",
        "option2": null,
        "option3": null,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "taxable": true,
        "barcode": "1234_red",
        "fulfillment_service": "manual",
        "grams": 567,
        "inventory_management": "shopify",
        "requires_shipping": true,
        "sku": "IPOD2008RED",
        "weight": 1.25,
        "weight_unit": "lb",
        "inventory_item_id": 49148385,
        "inventory_quantity": 20,
        "old_inventory_quantity": 20,
        "presentment_prices": [
          {
            "price": {
              "amount": "199.00",
              "currency_code": "USD"
            },
            "compare_at_price": null
          }
        ],
        "admin_graphql_api_id": "gid://shopify/ProductVariant/49148385",
        "image_id": null
      },
      {
        "id": 39072856,
        "product_id": 632910392,
        "title": "Green",
        "price": "199.00",
        "position": 3,
        "inventory_policy": "continue",
        "compare_at_price": null,
        "option1": "Green",
        "option2": null,
        "option3": null,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "taxable": true,
        "barcode": "1234_green",
        "fulfillment_service": "manual",
        "grams": 567,
        "inventory_management": "shopify",
        "requires_shipping": true,
        "sku": "IPOD2008GREEN",
        "weight": 1.25,
        "weight_unit": "lb",
        "inventory_item_id": 39072856,
        "inventory_quantity": 30,
        "old_inventory_quantity": 30,
        "presentment_prices": [
          {
            "price": {
              "amount": "199.00",
              "currency_code": "USD"
            },
            "compare_at_price": null
          }
        ],
        "admin_graphql_api_id": "gid://shopify/ProductVariant/39072856",
        "image_id": null
      },
      {
        "id": 457924702,
        "product_id": 632910392,
        "title": "Black",
        "price": "199.00",
        "position": 4,
        "inventory_policy": "continue",
        "compare_at_price": null,
        "option1": "Black",
        "option2": null,
        "option3": null,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "taxable": true,
        "barcode": "1234_black",
        "fulfillment_service": "manual",
        "grams": 567,
        "inventory_management": "shopify",
        "requires_shipping": true,
        "sku": "IPOD2008BLACK",
        "weight": 1.25,
        "weight_unit": "lb",
        "inventory_item_id": 457924702,
        "inventory_quantity": 40,
        "old_inventory_quantity": 40,
        "presentment_prices": [
          {
            "price": {
              "amount": "199.00",
              "currency_code": "USD"
            },
            "compare_at_price": null
          }
        ],
        "admin_graphql_api_id": "gid://shopify/ProductVariant/457924702",
        "image_id": null
      }
    ],
    "options": [
      {
        "id": 594680422,
        "product_id": 632910392,
        "name": "Color",
        "position": 1,
        "values": [
          "Pink",
          "Red",
          "Green",
          "Black"
        ]
      }
    ],
    "images": [
      {
        "id": 850703190,
        "alt": null,
        "position": 1,
        "product_id": 632910392,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "admin_graphql_api_id": "gid://shopify/ProductImage/850703190",
        "width": 123,
        "height": 456,
        "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727288648",
        "variant_ids": []
      },
      {
        "id": 562641783,
        "alt": null,
        "position": 2,
        "product_id": 632910392,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "admin_graphql_api_id": "gid://shopify/ProductImage/562641783",
        "width": 123,
        "height": 456,
        "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano-2.png?v=1727288648",
        "variant_ids": [
          808950810
        ]
      },
      {
        "id": 378407906,
        "alt": null,
        "position": 3,
        "product_id": 632910392,
        "created_at": "2024-09-25T14:24:08-04:00",
        "updated_at": "2024-09-25T14:24:08-04:00",
        "admin_graphql_api_id": "gid://shopify/ProductImage/378407906",
        "width": 123,
        "height": 456,
        "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727288648",
        "variant_ids": []
      }
    ],
    "image": {
      "id": 850703190,
      "alt": null,
      "position": 1,
      "product_id": 632910392,
      "created_at": "2024-09-25T14:24:08-04:00",
      "updated_at": "2024-09-25T14:24:08-04:00",
      "admin_graphql_api_id": "gid://shopify/ProductImage/850703190",
      "width": 123,
      "height": 456,
      "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727288648",
      "variant_ids": []
    }
  }
}
Anchor to section titled 'DELETE request, Delete a product'

del
Delete a product

productDelete
Deletes a product.
Anchor to section titled 'Parameters of Delete a product'

Parameters

api_version
string
required
product_id
string
required
Was this section helpful?
Anchor to section titled 'Examples of Delete a product'

Examples

Path parameters
productid=632910392
string
required
Was this section helpful?
del
/admin/api/2024-07/products/632910392.json
Copy
curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-07/products/632910392.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{}