Product
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.
What you can do with Product
The Shopify API lets you do the following with the Product resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-01/products.json Retrieves a list of products
- GET /admin/api/2020-01/products/count.json Retrieves a count of products
- GET /admin/api/2020-01/products/{product_id}.json Retrieves a single product
- POST /admin/api/2020-01/products.json Creates a new product
- PUT /admin/api/2020-01/products/{product_id}.json Updates a product
- DELETE /admin/api/2020-01/products/{product_id}.json Deletes a product
Product properties
body_html |
A description of the product. Supports HTML formatting. |
created_at
read-only |
The date and time (ISO 8601 format) when the product was created. |
handle |
A unique human-friendly string for the product. Automatically generated from the product's |
id
read-only |
An unsigned 64-bit integer that's used as a unique identifier for the product. Each |
images |
A list of product image objects, each one representing an image associated with the product. |
options |
The custom product property names like |
product_type |
A categorization for the product used for filtering and searching products. |
published_at |
The date and time (ISO 8601 format) when the product was
published. Can be set to |
published_scope |
Whether the product is published to the Point of Sale channel. Valid values:
|
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 |
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 |
title
required |
The name of the product. |
updated_at
read-only |
The date and time (ISO 8601 format) when the product was last modified.
A product's |
variants |
A list of product variants, each representing a different version of the product. The To retrieve the |
vendor |
The name of the product's vendor. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
ids
|
Return only products specified by a comma-separated list of product IDs. |
limit
|
Return up to this many results per page. (default:50 , maximum: 250 )
|
since_id
|
Return only products after the specified ID. |
title
|
Return products by product title. |
vendor
|
Return products by product title. |
handle
|
Return only products specified by a comma-separated list of product handles. |
product_type
|
Return products by product type. |
status
|
Return only products specified by a comma-separated list of statuses. (default:active )
|
collection_id
|
Return products by product collection ID. |
created_at_min
|
Return products created after a specified date. (format: 2014-04-25T16:15:47-04:00) |
created_at_max
|
Return products created 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) |
updated_at_max
|
Return products last updated 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_at_max
|
Return products published before a specified date. (format: 2014-04-25T16:15:47-04:00) |
published_status
|
Return products by their published status (default:any )
|
fields
|
Return only certain fields specified by a comma-separated list of field names. |
presentment_currencies
|
Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. |
Retrieve all products
GET /admin/api/2020-01/products.json
View Response
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": "2021-01-11T18:12:26-05:00",
"handle": "ipod-nano",
"updated_at": "2021-01-11T18:12:26-05:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"admin_graphql_api_id": "gid://shopify/Product/632910392",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Pink",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 808950810,
"inventory_quantity": 10,
"old_inventory_quantity": 10,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 49148385,
"product_id": 632910392,
"title": "Red",
"price": "199.00",
"sku": "IPOD2008RED",
"position": 2,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Red",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_red",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 49148385,
"inventory_quantity": 20,
"old_inventory_quantity": 20,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/49148385",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 39072856,
"product_id": 632910392,
"title": "Green",
"price": "199.00",
"sku": "IPOD2008GREEN",
"position": 3,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Green",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_green",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 39072856,
"inventory_quantity": 30,
"old_inventory_quantity": 30,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/39072856",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 457924702,
"product_id": 632910392,
"title": "Black",
"price": "199.00",
"sku": "IPOD2008BLACK",
"position": 4,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Black",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_black",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 457924702,
"inventory_quantity": 40,
"old_inventory_quantity": 40,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/457924702",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red",
"Green",
"Black"
]
}
],
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
},
{
"id": 562641783,
"product_id": 632910392,
"position": 2,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1610406746",
"variant_ids": [
808950810
],
"admin_graphql_api_id": "gid://shopify/ProductImage/562641783"
}
],
"image": {
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
},
{
"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": "2021-01-11T18:12:26-05:00",
"handle": "ipod-touch",
"updated_at": "2021-01-11T18:12:26-05:00",
"published_at": "2008-09-25T20:00:00-04:00",
"template_suffix": null,
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/921728736",
"variants": [
{
"id": 447654529,
"product_id": 921728736,
"title": "Black",
"price": "199.00",
"sku": "IPOD2009BLACK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "shipwire-app",
"inventory_management": "shipwire-app",
"option1": "Black",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_black",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 447654529,
"inventory_quantity": 13,
"old_inventory_quantity": 13,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/447654529",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 891236591,
"product_id": 921728736,
"name": "Title",
"position": 1,
"values": [
"Black"
]
}
],
"images": [],
"image": null
}
]
}
Retrieve a list of specific products.
GET /admin/api/2020-01/products.json?ids=632910392,921728736
View Response
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": "2021-01-11T18:12:26-05:00",
"handle": "ipod-nano",
"updated_at": "2021-01-11T18:12:26-05:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"admin_graphql_api_id": "gid://shopify/Product/632910392",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Pink",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 808950810,
"inventory_quantity": 10,
"old_inventory_quantity": 10,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 49148385,
"product_id": 632910392,
"title": "Red",
"price": "199.00",
"sku": "IPOD2008RED",
"position": 2,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Red",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_red",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 49148385,
"inventory_quantity": 20,
"old_inventory_quantity": 20,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/49148385",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 39072856,
"product_id": 632910392,
"title": "Green",
"price": "199.00",
"sku": "IPOD2008GREEN",
"position": 3,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Green",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_green",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 39072856,
"inventory_quantity": 30,
"old_inventory_quantity": 30,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/39072856",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 457924702,
"product_id": 632910392,
"title": "Black",
"price": "199.00",
"sku": "IPOD2008BLACK",
"position": 4,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Black",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_black",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 457924702,
"inventory_quantity": 40,
"old_inventory_quantity": 40,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/457924702",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red",
"Green",
"Black"
]
}
],
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
},
{
"id": 562641783,
"product_id": 632910392,
"position": 2,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1610406746",
"variant_ids": [
808950810
],
"admin_graphql_api_id": "gid://shopify/ProductImage/562641783"
}
],
"image": {
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
},
{
"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": "2021-01-11T18:12:26-05:00",
"handle": "ipod-touch",
"updated_at": "2021-01-11T18:12:26-05:00",
"published_at": "2008-09-25T20:00:00-04:00",
"template_suffix": null,
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/921728736",
"variants": [
{
"id": 447654529,
"product_id": 921728736,
"title": "Black",
"price": "199.00",
"sku": "IPOD2009BLACK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "shipwire-app",
"inventory_management": "shipwire-app",
"option1": "Black",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_black",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 447654529,
"inventory_quantity": 13,
"old_inventory_quantity": 13,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/447654529",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 891236591,
"product_id": 921728736,
"name": "Title",
"position": 1,
"values": [
"Black"
]
}
],
"images": [],
"image": null
}
]
}
Retrieve all products, showing only some attributes
GET /admin/api/2020-01/products.json?fields=id,images,title
View Response
HTTP/1.1 200 OK
{
"products": [
{
"id": 632910392,
"title": "IPod Nano - 8GB",
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
},
{
"id": 562641783,
"product_id": 632910392,
"position": 2,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1610406746",
"variant_ids": [
808950810
],
"admin_graphql_api_id": "gid://shopify/ProductImage/562641783"
}
]
},
{
"id": 921728736,
"title": "IPod Touch 8GB",
"images": []
}
]
}
Retrieve all products that belong to a certain collection
GET /admin/api/2020-01/products.json?collection_id=841564295
View Response
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": "2021-01-11T18:12:26-05:00",
"handle": "ipod-nano",
"updated_at": "2021-01-11T18:12:26-05:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"admin_graphql_api_id": "gid://shopify/Product/632910392",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Pink",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 808950810,
"inventory_quantity": 10,
"old_inventory_quantity": 10,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 49148385,
"product_id": 632910392,
"title": "Red",
"price": "199.00",
"sku": "IPOD2008RED",
"position": 2,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Red",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_red",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 49148385,
"inventory_quantity": 20,
"old_inventory_quantity": 20,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/49148385",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 39072856,
"product_id": 632910392,
"title": "Green",
"price": "199.00",
"sku": "IPOD2008GREEN",
"position": 3,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Green",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_green",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 39072856,
"inventory_quantity": 30,
"old_inventory_quantity": 30,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/39072856",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 457924702,
"product_id": 632910392,
"title": "Black",
"price": "199.00",
"sku": "IPOD2008BLACK",
"position": 4,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Black",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_black",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 457924702,
"inventory_quantity": 40,
"old_inventory_quantity": 40,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/457924702",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red",
"Green",
"Black"
]
}
],
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
},
{
"id": 562641783,
"product_id": 632910392,
"position": 2,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1610406746",
"variant_ids": [
808950810
],
"admin_graphql_api_id": "gid://shopify/ProductImage/562641783"
}
],
"image": {
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
}
]
}
Retrieve all products after the specified ID
GET /admin/api/2020-01/products.json?since_id=632910392
View Response
HTTP/1.1 200 OK
{
"products": [
{
"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": "2021-01-11T18:12:26-05:00",
"handle": "ipod-touch",
"updated_at": "2021-01-11T18:12:26-05:00",
"published_at": "2008-09-25T20:00:00-04:00",
"template_suffix": null,
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/921728736",
"variants": [
{
"id": 447654529,
"product_id": 921728736,
"title": "Black",
"price": "199.00",
"sku": "IPOD2009BLACK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "shipwire-app",
"inventory_management": "shipwire-app",
"option1": "Black",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_black",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 447654529,
"inventory_quantity": 13,
"old_inventory_quantity": 13,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/447654529",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 891236591,
"product_id": 921728736,
"name": "Title",
"position": 1,
"values": [
"Black"
]
}
],
"images": [],
"image": null
}
]
}
Retrieve all products with prices in selected presentment currencies
GET /admin/api/2020-01/products.json?presentment_currencies=USD
View Response
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": "2021-01-11T18:12:26-05:00",
"handle": "ipod-nano",
"updated_at": "2021-01-11T18:12:26-05:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"admin_graphql_api_id": "gid://shopify/Product/632910392",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Pink",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 808950810,
"inventory_quantity": 10,
"old_inventory_quantity": 10,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 49148385,
"product_id": 632910392,
"title": "Red",
"price": "199.00",
"sku": "IPOD2008RED",
"position": 2,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Red",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_red",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 49148385,
"inventory_quantity": 20,
"old_inventory_quantity": 20,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/49148385",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 39072856,
"product_id": 632910392,
"title": "Green",
"price": "199.00",
"sku": "IPOD2008GREEN",
"position": 3,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Green",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_green",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 39072856,
"inventory_quantity": 30,
"old_inventory_quantity": 30,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/39072856",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 457924702,
"product_id": 632910392,
"title": "Black",
"price": "199.00",
"sku": "IPOD2008BLACK",
"position": 4,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Black",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_black",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 457924702,
"inventory_quantity": 40,
"old_inventory_quantity": 40,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/457924702",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red",
"Green",
"Black"
]
}
],
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
},
{
"id": 562641783,
"product_id": 632910392,
"position": 2,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1610406746",
"variant_ids": [
808950810
],
"admin_graphql_api_id": "gid://shopify/ProductImage/562641783"
}
],
"image": {
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
},
{
"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": "2021-01-11T18:12:26-05:00",
"handle": "ipod-touch",
"updated_at": "2021-01-11T18:12:26-05:00",
"published_at": "2008-09-25T20:00:00-04:00",
"template_suffix": null,
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/921728736",
"variants": [
{
"id": 447654529,
"product_id": 921728736,
"title": "Black",
"price": "199.00",
"sku": "IPOD2009BLACK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "shipwire-app",
"inventory_management": "shipwire-app",
"option1": "Black",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_black",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 447654529,
"inventory_quantity": 13,
"old_inventory_quantity": 13,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/447654529",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 891236591,
"product_id": 921728736,
"name": "Title",
"position": 1,
"values": [
"Black"
]
}
],
"images": [],
"image": null
}
]
}
vendor
|
Return products by product title. |
product_type
|
Return products by product type. |
collection_id
|
Return products by product collection ID. |
created_at_min
|
Return products created after a specified date. (format: 2014-04-25T16:15:47-04:00) |
created_at_max
|
Return products created 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) |
updated_at_max
|
Return products last updated 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_at_max
|
Return products published before a specified date. (format: 2014-04-25T16:15:47-04:00) |
published_status
|
Return products by their published status (default:any )
|
Retrieve a count of all products
GET /admin/api/2020-01/products/count.json
View Response
HTTP/1.1 200 OK
{
"count": 2
}
Retrieve a count of all products of a given collection
GET /admin/api/2020-01/products/count.json?collection_id=841564295
View Response
HTTP/1.1 200 OK
{
"count": 1
}
fields
|
A comma-separated list of fields to include in the response. |
Retrieve a single product by ID
GET /admin/api/2020-01/products/632910392.json
View Response
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": "2021-01-11T18:12:26-05:00",
"handle": "ipod-nano",
"updated_at": "2021-01-11T18:12:26-05:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"admin_graphql_api_id": "gid://shopify/Product/632910392",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Pink",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 808950810,
"inventory_quantity": 10,
"old_inventory_quantity": 10,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 49148385,
"product_id": 632910392,
"title": "Red",
"price": "199.00",
"sku": "IPOD2008RED",
"position": 2,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Red",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_red",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 49148385,
"inventory_quantity": 20,
"old_inventory_quantity": 20,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/49148385",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 39072856,
"product_id": 632910392,
"title": "Green",
"price": "199.00",
"sku": "IPOD2008GREEN",
"position": 3,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Green",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_green",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 39072856,
"inventory_quantity": 30,
"old_inventory_quantity": 30,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/39072856",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 457924702,
"product_id": 632910392,
"title": "Black",
"price": "199.00",
"sku": "IPOD2008BLACK",
"position": 4,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Black",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_black",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 457924702,
"inventory_quantity": 40,
"old_inventory_quantity": 40,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/457924702",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red",
"Green",
"Black"
]
}
],
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
},
{
"id": 562641783,
"product_id": 632910392,
"position": 2,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1610406746",
"variant_ids": [
808950810
],
"admin_graphql_api_id": "gid://shopify/ProductImage/562641783"
}
],
"image": {
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
}
}
Retrieve only particular fields
GET /admin/api/2020-01/products/632910392.json?fields=id,images,title
View Response
HTTP/1.1 200 OK
{
"product": {
"id": 632910392,
"title": "IPod Nano - 8GB",
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1610406746",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
},
{
"id": 562641783,
"product_id": 632910392,
"position": 2,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1610406746",
"variant_ids": [
808950810
],
"admin_graphql_api_id": "gid://shopify/ProductImage/562641783"
}
]
}
}
Creates a new product.
If you want to set the product's SEO information, then you can use the following properties:
- metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the
<meta name='title'>
tag. - metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the
<meta name='description'>
tag.
Create a new product with the default product variant
POST /admin/api/2020-01/products.json
{
"product": {
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"tags": [
"Barnes & Noble",
"John's Fav",
"\Big Air\"
]
}
}
View Response
HTTP/1.1 201 Created
{
"product": {
"id": 1071559582,
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"created_at": "2021-01-11T18:18:19-05:00",
"handle": "burton-custom-freestyle-151",
"updated_at": "2021-01-11T18:18:19-05:00",
"published_at": "2021-01-11T18:18:19-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "\Big Air\, Barnes & Noble, John's Fav",
"admin_graphql_api_id": "gid://shopify/Product/1071559582",
"variants": [
{
"id": 1070325028,
"product_id": 1071559582,
"title": "Default Title",
"price": "0.00",
"sku": "",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "Default Title",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:18:19-05:00",
"updated_at": "2021-01-11T18:18:19-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0.0,
"weight_unit": "lb",
"inventory_item_id": 1070325028,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325028",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "0.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 1022828620,
"product_id": 1071559582,
"name": "Title",
"position": 1,
"values": [
"Default Title"
]
}
],
"images": [],
"image": null
}
}
Create a new unpublished product
POST /admin/api/2020-01/products.json
{
"product": {
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"published": false
}
}
View Response
HTTP/1.1 201 Created
{
"product": {
"id": 1071559583,
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"created_at": "2021-01-11T18:18:22-05:00",
"handle": "burton-custom-freestyle-151",
"updated_at": "2021-01-11T18:18:23-05:00",
"published_at": null,
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/1071559583",
"variants": [
{
"id": 1070325029,
"product_id": 1071559583,
"title": "Default Title",
"price": "0.00",
"sku": "",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "Default Title",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:18:22-05:00",
"updated_at": "2021-01-11T18:18:22-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0.0,
"weight_unit": "lb",
"inventory_item_id": 1070325029,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325029",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "0.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 1022828621,
"product_id": 1071559583,
"name": "Title",
"position": 1,
"values": [
"Default Title"
]
}
],
"images": [],
"image": null
}
}
Create a new draft product
POST /admin/api/2020-01/products.json
{
"product": {
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"shop": {
"id": 690933842,
"name": "Apple Computers",
"email": "steve@apple.com",
"domain": "apple.myshopify.com",
"province": "California",
"country": "US",
"address1": "1 Infinite Loop",
"zip": "95014",
"city": "Cupertino",
"source": null,
"phone": "1231231234",
"latitude": 45.45,
"longitude": -75.43,
"primary_locale": "en",
"address2": "Suite 100",
"created_at": "2007-12-31T19:00:00-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"country_code": "US",
"country_name": "United States",
"currency": "USD",
"customer_email": "steve@apple.com",
"timezone": "(GMT-05:00) Eastern Time (US & Canada)",
"iana_timezone": "America/New_York",
"shop_owner": "Steve Jobs",
"money_format": "$",
"money_with_currency_format": "$ USD",
"weight_unit": "lb",
"province_code": "CA",
"taxes_included": null,
"auto_configure_tax_inclusivity": null,
"tax_shipping": null,
"county_taxes": true,
"plan_display_name": "Shopify Plus",
"plan_name": "enterprise",
"has_discounts": true,
"has_gift_cards": true,
"myshopify_domain": "apple.myshopify.com",
"google_apps_domain": null,
"google_apps_login_enabled": null,
"money_in_emails_format": "$",
"money_with_currency_in_emails_format": "$ USD",
"eligible_for_payments": true,
"requires_extra_payments_agreement": false,
"password_enabled": null,
"has_storefront": true,
"eligible_for_card_reader_giveaway": false,
"finances": true,
"primary_location_id": 905684977,
"cookie_consent_level": "implicit",
"visitor_tracking_consent_preference": "allow_all",
"force_ssl": true,
"checkout_api_supported": true,
"multi_location_enabled": false,
"setup_required": false,
"pre_launch_enabled": false,
"enabled_presentment_currencies": [
"USD"
]
},
"status": "draft"
}
}
View Response
HTTP/1.1 201 Created
{
"product": {
"id": 1071559584,
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"created_at": "2021-01-11T18:18:27-05:00",
"handle": "burton-custom-freestyle-151",
"updated_at": "2021-01-11T18:18:27-05:00",
"published_at": null,
"template_suffix": null,
"status": "draft",
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/1071559584",
"variants": [
{
"id": 1070325030,
"product_id": 1071559584,
"title": "Default Title",
"price": "0.00",
"sku": "",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "Default Title",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:18:27-05:00",
"updated_at": "2021-01-11T18:18:27-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0.0,
"weight_unit": "lb",
"inventory_item_id": 1070325030,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325030",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "0.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 1022828622,
"product_id": 1071559584,
"name": "Title",
"position": 1,
"values": [
"Default Title"
]
}
],
"images": [],
"image": null
}
}
Create a new product with multiple product variants
POST /admin/api/2020-01/products.json
{
"product": {
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"variants": [
{
"option1": "First",
"price": "10.00",
"sku": "123"
},
{
"option1": "Second",
"price": "20.00",
"sku": "123"
}
]
}
}
View Response
HTTP/1.1 201 Created
{
"product": {
"id": 1071559585,
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"created_at": "2021-01-11T18:18:30-05:00",
"handle": "burton-custom-freestyle-151",
"updated_at": "2021-01-11T18:18:31-05:00",
"published_at": "2021-01-11T18:18:30-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/1071559585",
"variants": [
{
"id": 1070325031,
"product_id": 1071559585,
"title": "First",
"price": "10.00",
"sku": "123",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "First",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:18:31-05:00",
"updated_at": "2021-01-11T18:18:31-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0.0,
"weight_unit": "lb",
"inventory_item_id": 1070325031,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325031",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "10.00"
},
"compare_at_price": null
}
]
},
{
"id": 1070325032,
"product_id": 1071559585,
"title": "Second",
"price": "20.00",
"sku": "123",
"position": 2,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "Second",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:18:31-05:00",
"updated_at": "2021-01-11T18:18:31-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0.0,
"weight_unit": "lb",
"inventory_item_id": 1070325032,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325032",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "20.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 1022828623,
"product_id": 1071559585,
"name": "Title",
"position": 1,
"values": [
"First",
"Second"
]
}
],
"images": [],
"image": null
}
}
Create a new product with multiple product variants and multiple options
POST /admin/api/2020-01/products.json
{
"product": {
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"variants": [
{
"option1": "Blue",
"option2": "155"
},
{
"option1": "Black",
"option2": "159"
}
],
"options": [
{
"name": "Color",
"values": [
"Blue",
"Black"
]
},
{
"name": "Size",
"values": [
"155",
"159"
]
}
]
}
}
View Response
HTTP/1.1 201 Created
{
"product": {
"id": 1071559586,
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"created_at": "2021-01-11T18:18:36-05:00",
"handle": "burton-custom-freestyle-151",
"updated_at": "2021-01-11T18:18:38-05:00",
"published_at": "2021-01-11T18:18:36-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/1071559586",
"variants": [
{
"id": 1070325033,
"product_id": 1071559586,
"title": "Blue / 155",
"price": "0.00",
"sku": "",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "Blue",
"option2": "155",
"option3": null,
"created_at": "2021-01-11T18:18:38-05:00",
"updated_at": "2021-01-11T18:18:38-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0.0,
"weight_unit": "lb",
"inventory_item_id": 1070325033,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325033",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "0.00"
},
"compare_at_price": null
}
]
},
{
"id": 1070325034,
"product_id": 1071559586,
"title": "Black / 159",
"price": "0.00",
"sku": "",
"position": 2,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "Black",
"option2": "159",
"option3": null,
"created_at": "2021-01-11T18:18:38-05:00",
"updated_at": "2021-01-11T18:18:38-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0.0,
"weight_unit": "lb",
"inventory_item_id": 1070325034,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325034",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "0.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 1022828624,
"product_id": 1071559586,
"name": "Color",
"position": 1,
"values": [
"Blue",
"Black"
]
},
{
"id": 1022828625,
"product_id": 1071559586,
"name": "Size",
"position": 2,
"values": [
"155",
"159"
]
}
],
"images": [],
"image": null
}
}
Create a new product with the default variant and base64 encoded image
POST /admin/api/2020-01/products.json
{
"product": {
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"images": [
{
"attachment": "R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==\n"
}
]
}
}
View Response
HTTP/1.1 201 Created
{
"product": {
"id": 1071559587,
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"created_at": "2021-01-11T18:18:46-05:00",
"handle": "burton-custom-freestyle-151",
"updated_at": "2021-01-11T18:18:48-05:00",
"published_at": "2021-01-11T18:18:46-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/1071559587",
"variants": [
{
"id": 1070325035,
"product_id": 1071559587,
"title": "Default Title",
"price": "0.00",
"sku": "",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "Default Title",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:18:47-05:00",
"updated_at": "2021-01-11T18:18:47-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0.0,
"weight_unit": "lb",
"inventory_item_id": 1070325035,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325035",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "0.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 1022828626,
"product_id": 1071559587,
"name": "Title",
"position": 1,
"values": [
"Default Title"
]
}
],
"images": [
{
"id": 1001473896,
"product_id": 1071559587,
"position": 1,
"created_at": "2021-01-11T18:18:46-05:00",
"updated_at": "2021-01-11T18:18:46-05:00",
"alt": null,
"width": 1,
"height": 1,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/df3e567d6f16d040326c7a0ea29a4f41.gif?v=1610407126",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/1001473896"
}
],
"image": {
"id": 1001473896,
"product_id": 1071559587,
"position": 1,
"created_at": "2021-01-11T18:18:46-05:00",
"updated_at": "2021-01-11T18:18:46-05:00",
"alt": null,
"width": 1,
"height": 1,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/df3e567d6f16d040326c7a0ea29a4f41.gif?v=1610407126",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/1001473896"
}
}
}
Create a new product with the default variant and a product image that will be downloaded by Shopify
POST /admin/api/2020-01/products.json
{
"product": {
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"images": [
{
"src": "http://example.com/rails_logo.gif"
}
]
}
}
View Response
HTTP/1.1 201 Created
{
"product": {
"id": 1071559588,
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"created_at": "2021-01-11T18:18:55-05:00",
"handle": "burton-custom-freestyle-151",
"updated_at": "2021-01-11T18:18:56-05:00",
"published_at": "2021-01-11T18:18:55-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/1071559588",
"variants": [
{
"id": 1070325036,
"product_id": 1071559588,
"title": "Default Title",
"price": "0.00",
"sku": "",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "Default Title",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:18:56-05:00",
"updated_at": "2021-01-11T18:18:56-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0.0,
"weight_unit": "lb",
"inventory_item_id": 1070325036,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325036",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "0.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 1022828627,
"product_id": 1071559588,
"name": "Title",
"position": 1,
"values": [
"Default Title"
]
}
],
"images": [
{
"id": 1001473897,
"product_id": 1071559588,
"position": 1,
"created_at": "2021-01-11T18:18:55-05:00",
"updated_at": "2021-01-11T18:18:55-05:00",
"alt": null,
"width": 110,
"height": 140,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/rails_logo20210111-37418-1gvejw5.gif?v=1610407135",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/1001473897"
}
],
"image": {
"id": 1001473897,
"product_id": 1071559588,
"position": 1,
"created_at": "2021-01-11T18:18:55-05:00",
"updated_at": "2021-01-11T18:18:55-05:00",
"alt": null,
"width": 110,
"height": 140,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/rails_logo20210111-37418-1gvejw5.gif?v=1610407135",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/1001473897"
}
}
}
Creating a product without a title will return an error
HTTP/1.1 422 Unprocessable Entity
{
"errors": {
"title": [
"can't be blank"
]
}
}
Create a product with a metafield
POST /admin/api/2020-01/products.json
{
"product": {
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"metafields": [
{
"key": "new",
"value": "newvalue",
"value_type": "string",
"namespace": "global"
}
]
}
}
View Response
HTTP/1.1 201 Created
{
"product": {
"id": 1071559589,
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"created_at": "2021-01-11T18:19:02-05:00",
"handle": "burton-custom-freestyle-151",
"updated_at": "2021-01-11T18:19:02-05:00",
"published_at": "2021-01-11T18:19:02-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "",
"admin_graphql_api_id": "gid://shopify/Product/1071559589",
"variants": [
{
"id": 1070325037,
"product_id": 1071559589,
"title": "Default Title",
"price": "0.00",
"sku": "",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "Default Title",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:19:02-05:00",
"updated_at": "2021-01-11T18:19:02-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0.0,
"weight_unit": "lb",
"inventory_item_id": 1070325037,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325037",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "0.00"
},
"compare_at_price": null
}
]
}
],
"options": [
{
"id": 1022828628,
"product_id": 1071559589,
"name": "Title",
"position": 1,
"values": [
"Default Title"
]
}
],
"images": [],
"image": null
}
}
Updates a product and its variants and images.
If you want to update the product's SEO information, then you can use the following properties:
- metafields_global_title_tag: The name of the product used for SEO purposes. Generally added to the
<meta name='title'>
tag. - metafields_global_description_tag: A description of the product used for SEO purposes. Generally added to the
<meta name='description'>
tag.
Update a product's title
PUT /admin/api/2020-01/products/632910392.json
{
"product": {
"id": 632910392,
"title": "New product title"
}
}
View Response
HTTP/1.1 200 OK
{
"product": {
"id": 632910392,
"title": "New product title",
"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": "2021-01-11T18:12:26-05:00",
"handle": "ipod-nano",
"updated_at": "2021-01-11T18:19:06-05:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"admin_graphql_api_id": "gid://shopify/Product/632910392",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Pink",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 808950810,
"inventory_quantity": 10,
"old_inventory_quantity": 10,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 49148385,
"product_id": 632910392,
"title": "Red",
"price": "199.00",
"sku": "IPOD2008RED",
"position": 2,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Red",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_red",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 49148385,
"inventory_quantity": 20,
"old_inventory_quantity": 20,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/49148385",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 39072856,
"product_id": 632910392,
"title": "Green",
"price": "199.00",
"sku": "IPOD2008GREEN",
"position": 3,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Green",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_green",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 39072856,
"inventory_quantity": 30,
"old_inventory_quantity": 30,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/39072856",
"presentment_prices": [
{
"price": {
"currency_code": "USD",
"amount": "199.00"
},
"compare_at_price": null
}
]
},
{
"id": 457924702,
"product_id": 632910392,
"title": "Black",
"price": "199.00",
"sku": "IPOD2008BLACK",
"position": 4,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Black",
"option2": null,
"option3": null,
"created_at": "2021-01-11T18:12:26-05:00",
"updated_at": "2021-01-11T18:12:26-05:00",
"taxable": true,
"barcode": "1234_black",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 457924702,
"inventory_quantity": 40,
"old_inventory_quantity": 40,
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/457924702",
"presentment_prices": [
{
"price": {
"currency_code": "USD",