{ "opencollection": "1.0.0", "info": { "name": "Shopify Admin REST About Product API", "version": "2025-01" }, "request": { "auth": { "type": "apikey", "key": "X-Shopify-Access-Token", "value": "{{X-Shopify-Access-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Product", "type": "folder" }, "items": [ { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Metafields That Belong To A Product Image Resource", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/metafields.json", "params": [ { "name": "metafield[owner_id]", "value": "", "type": "query", "description": "metafield[owner_id]" }, { "name": "metafield[owner_resource]", "value": "", "type": "query", "description": "metafield[owner_resource]" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/metafield#index-unstable" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2020-01" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2020-01" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2020-04" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2020-04" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2020-07" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2020-07" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2020-10" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2020-10" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-2021-01" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-2021-01" }, { "info": { "name": "Shopify Adds A Product To A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/collects.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#create-unstable" }, { "info": { "name": "Shopify Removes A Product From A Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/collects/:collect_id.json", "params": [ { "name": "collect_id", "value": "", "type": "path", "description": "collect_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/collect#destroy-unstable" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2020-01" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2020-01" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2020-01" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2020-04" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2020-04" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2020-04" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2020-07" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2020-07" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2020-07" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2020-10" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2020-10" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2020-10" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#show-2021-01" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-2021-01" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-2021-01" }, { "info": { "name": "Shopify Creates A New Product", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#create-unstable" }, { "info": { "name": "Shopify Retrieves A Single Product", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include in the response." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#show-unstable" }, { "info": { "name": "Shopify Updates A Product And Its Variants And Images", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#update-unstable" }, { "info": { "name": "Shopify Deletes A Product", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products/:product_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product#destroy-unstable" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2020-01" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2020-01" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-01" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-01" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-01" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2020-04" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2020-04" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-04" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-04" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-04" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2020-07" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2020-07" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-07" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-07" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-07" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2020-10" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2020-10" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2020-10" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2020-10" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2020-10" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-2021-01" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-2021-01" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-2021-01" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-2021-01" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-2021-01" }, { "info": { "name": "Shopify Get All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#index-unstable" }, { "info": { "name": "Shopify Create A New Product Image", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products/:product_id/images.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#create-unstable" }, { "info": { "name": "Shopify Get A Count Of All Product Images", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products/:product_id/images/count.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#count-unstable" }, { "info": { "name": "Shopify Get A Single Product Image By Id", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" }, { "name": "fields", "value": "", "type": "query", "description": "comma-separated list of fields to include in the response" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#show-unstable" }, { "info": { "name": "Shopify Modify An Existing Product Image", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/products/:product_id/images/:image_id.json", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "product_id" }, { "name": "image_id", "value": "", "type": "path", "description": "image_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/product-image#update-unstable" }, { "info": { "name": "Shopify Retrieve Product Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/product_listings.json", "params": [ { "name": "product_ids", "value": "", "type": "query", "description": "A comma-separated list of product ids" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter by products belonging to a particular collection" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Filter by products last updated after a certain date and time (formatted in ISO 8601)" }, { "name": "handle", "value": "", "type": "query", "description": "Filter by product handle" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-01" }, { "info": { "name": "Shopify Retrieve A Specific Product Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-01" }, { "info": { "name": "Shopify Create A Product Listing To Publish A Product To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-01" }, { "info": { "name": "Shopify Delete A Product Listing To Unpublish A Product From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-01" }, { "info": { "name": "Shopify Retrieve Product Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/product_listings.json", "params": [ { "name": "product_ids", "value": "", "type": "query", "description": "A comma-separated list of product ids" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter by products belonging to a particular collection" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Filter by products last updated after a certain date and time (formatted in ISO 8601)" }, { "name": "handle", "value": "", "type": "query", "description": "Filter by product handle" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-04" }, { "info": { "name": "Shopify Retrieve A Specific Product Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-04" }, { "info": { "name": "Shopify Create A Product Listing To Publish A Product To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-04" }, { "info": { "name": "Shopify Delete A Product Listing To Unpublish A Product From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-04" }, { "info": { "name": "Shopify Retrieve Product Listings That Are Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/product_listings.json", "params": [ { "name": "product_ids", "value": "", "type": "query", "description": "A comma-separated list of product ids" }, { "name": "limit", "value": "", "type": "query", "description": "Amount of results\n (default: 50, maximum: 1000)" }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter by products belonging to a particular collection" }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Filter by products last updated after a certain date and time (formatted in ISO 8601)" }, { "name": "handle", "value": "", "type": "query", "description": "Filter by product handle" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#index-2020-07" }, { "info": { "name": "Shopify Retrieve A Specific Product Listing That Is Published To Your App", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#show-2020-07" }, { "info": { "name": "Shopify Create A Product Listing To Publish A Product To Your App", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#create-2020-07" }, { "info": { "name": "Shopify Delete A Product Listing To Unpublish A Product From Your App", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/product_listings/:product_listing_id.json", "params": [ { "name": "product_listing_id", "value": "", "type": "path", "description": "product_listing_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting#destroy-2020-07" } ] } ], "bundled": true }