{ "opencollection": "1.0.0", "info": { "name": "Shopify Admin REST About Custom API", "version": "2025-01" }, "request": { "auth": { "type": "apikey", "key": "X-Shopify-Access-Token", "value": "{{X-Shopify-Access-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Custom", "type": "folder" }, "items": [ { "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 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 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 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 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 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 Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-01" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2020-01" }, { "info": { "name": "Shopify Retrieves A Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-01" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2020-01" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2020-01" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2020-01" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-04" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2020-04" }, { "info": { "name": "Shopify Retrieves A Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-04" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2020-04" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2020-04" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2020-04" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-07" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2020-07" }, { "info": { "name": "Shopify Retrieves A Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-07" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2020-07" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2020-07" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2020-07" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-10" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2020-10" }, { "info": { "name": "Shopify Retrieves A Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-10" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2020-10" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2020-10" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2020-10" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2021-01" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-2021-01" }, { "info": { "name": "Shopify Retrieves A Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2021-01" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-2021-01" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-2021-01" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-2021-01" }, { "info": { "name": "Shopify Retrieves A List Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/custom_collections.json", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" }, { "name": "ids", "value": "", "type": "query", "description": "Show only collections specified by a comma-separated list of IDs." }, { "name": "since_id", "value": "", "type": "query", "description": "Restrict results to after the specified ID." }, { "name": "title", "value": "", "type": "query", "description": "Show custom collections with a given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Show custom collections that include a given product." }, { "name": "handle", "value": "", "type": "query", "description": "Filter by custom collection handle." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Show custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Show custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Show custom collectsion with a given published status.\n (default: any)\n \n published: Show only published custom collections.\n unpublished: Show only unpublished custom collections.\n any: Show custom collections of any published status." }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-unstable" }, { "info": { "name": "Shopify Creates A Custom Collection", "type": "http" }, "http": { "method": "POST", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/custom_collections.json", "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#create-unstable" }, { "info": { "name": "Shopify Retrieves A Count Of Custom Collections", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/custom_collections/count.json", "params": [ { "name": "title", "value": "", "type": "query", "description": "Count custom collections with given title." }, { "name": "product_id", "value": "", "type": "query", "description": "Count custom collections that include a given product." }, { "name": "updated_at_min", "value": "", "type": "query", "description": "Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "updated_at_max", "value": "", "type": "query", "description": "Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_min", "value": "", "type": "query", "description": "Count custom collections published after date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_at_max", "value": "", "type": "query", "description": "Count custom collections published before date (format: 2014-04-25T16:15:47-04:00)." }, { "name": "published_status", "value": "", "type": "query", "description": "Count custom collections with a given published status.\n (default: any)\n \n published: Count only published custom collections.\n unpublished: Count only unpublished custom collections.\n any: Count custom collections of any published status." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-unstable" }, { "info": { "name": "Shopify Retrieves A Single Custom Collection", "type": "http" }, "http": { "method": "GET", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" }, { "name": "fields", "value": "", "type": "query", "description": "Show only certain fields, specified by a comma-separated list of field names." } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#show-unstable" }, { "info": { "name": "Shopify Updates An Existing Custom Collection", "type": "http" }, "http": { "method": "PUT", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#update-unstable" }, { "info": { "name": "Shopify Deletes A Custom Collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/custom_collections/:custom_collection_id.json", "params": [ { "name": "custom_collection_id", "value": "", "type": "path", "description": "custom_collection_id" } ] }, "docs": "https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#destroy-unstable" } ] } ], "bundled": true }