openapi: 3.1.0 info: title: Shopify Admin REST About Collections API description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date. version: 2025-01 contact: name: Shopify url: https://shopify.dev/docs/api/admin-rest email: api@shopify.com license: name: Shopify API Terms url: https://www.shopify.com/legal/api-terms x-date: '2026-03-04' servers: - url: https://{store}.myshopify.com/admin/api/2025-01 description: Shopify Admin REST API variables: store: default: my-store description: The Shopify store subdomain security: - AccessToken: [] tags: - name: Collections description: Retrieve collection data paths: /collections/{collection_id}.json: get: operationId: getCollection summary: Shopify Retrieve a single collection description: Retrieves a single collection by ID including its metadata. tags: - Collections parameters: - name: collection_id in: path required: true description: The ID of the collection schema: type: integer - name: fields in: query description: Comma-separated list of fields to include schema: type: string responses: '200': description: The requested collection content: application/json: schema: type: object properties: collection: $ref: '#/components/schemas/Collection' /collections/{collection_id}/products.json: get: operationId: listCollectionProducts summary: Shopify Retrieve products in a collection description: Retrieves a list of products belonging to a collection. tags: - Collections parameters: - name: collection_id in: path required: true description: The ID of the collection schema: type: integer - name: limit in: query description: Maximum number of results (max 250, default 50) schema: type: integer default: 50 maximum: 250 responses: '200': description: Products in the collection content: application/json: schema: type: object properties: products: type: array items: $ref: '#/components/schemas/Product' /admin/api/2020-01/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-01 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202001_get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-01 parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202001_get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-04 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202004_get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-04 parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202004_get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-07 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202007_get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-07 parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202007_get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-10 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2020-10 parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2021-01 parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202101_get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-2021-01 parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202101_get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/custom_collections.json: get: summary: Shopify Retrieves A List Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-unstable parameters: - in: query name: limit description: "The maximum number of results to retrieve.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show custom collections with a given title. schema: {} required: false - in: query name: product_id description: Show custom collections that include a given product. schema: {} required: false - in: query name: handle description: Filter by custom collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_unstable_get_custom_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/custom_collections/count.json: get: summary: Shopify Retrieves A Count Of Custom Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#count-unstable parameters: - in: query name: title description: Count custom collections with given title. schema: {} required: false - in: query name: product_id description: Count custom collections that include a given product. schema: {} required: false - in: query name: updated_at_min description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: updated_at_max description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_min description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_at_max description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).' schema: {} required: false - in: query name: published_status 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." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_unstable_get_custom_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-01 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202001_get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-01/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-01 parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202001_get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-04 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202004_get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-04/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-04 parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202004_get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-07 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202007_get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-07/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-07 parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202007_get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2020-10 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2020-10/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2020-10 parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-2021-01 parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202101_get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/2021-01/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-2021-01 parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_202101_get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/smart_collections.json: get: summary: Shopify Retrieves A List Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#index-unstable parameters: - in: query name: limit description: "The number of results to show.\n (default: 50, maximum: 250)" schema: {} required: false - in: query name: ids description: Show only the smart collections specified by a comma-separated list of IDs. schema: {} required: false - in: query name: since_id description: Restrict results to after the specified ID. schema: {} required: false - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that includes the specified product. schema: {} required: false - in: query name: handle description: Filter results by smart collection handle. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false - in: query name: fields description: Show only certain fields, specified by a comma-separated list of field names. schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_unstable_get_smart_collections x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true /admin/api/unstable/smart_collections/count.json: get: summary: Shopify Retrieves A Count Of Smart Collections description: https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#count-unstable parameters: - in: query name: title description: Show smart collections with the specified title. schema: {} required: false - in: query name: product_id description: Show smart collections that include the specified product. schema: {} required: false - in: query name: updated_at_min description: 'Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: updated_at_max description: 'Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_min description: 'Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_at_max description: 'Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)' schema: {} required: false - in: query name: published_status description: "Filter results based on the published status of smart collections.\n (default: any)\n \n published: Show only published smart collections.\n unpublished: Show only unpublished smart collections.\n any: Show all smart collections." schema: {} required: false tags: - Collections responses: '200': description: '' operationId: deprecated_unstable_get_smart_collections_count x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true components: schemas: Product: type: object description: A Shopify product properties: id: type: integer description: Unique numeric identifier for the product title: type: string description: The name of the product body_html: type: string description: Product description in HTML vendor: type: string description: The name of the product vendor product_type: type: string description: A categorization for the product handle: type: string description: URL-friendly version of the product title created_at: type: string format: date-time description: When the product was created updated_at: type: string format: date-time description: When the product was last updated published_at: type: - string - 'null' format: date-time description: When the product was published (null if unpublished) template_suffix: type: - string - 'null' description: Liquid template suffix for the product page published_scope: type: string description: Whether the product is published to the POS channel and online store tags: type: string description: Comma-separated list of tags status: type: string description: Product status enum: - active - archived - draft admin_graphql_api_id: type: string description: The GraphQL Admin API ID variants: type: array description: Product variants items: $ref: '#/components/schemas/Variant' options: type: array description: Product options (e.g. Size, Color) items: $ref: '#/components/schemas/ProductOption' images: type: array description: Product images items: $ref: '#/components/schemas/Image' image: description: The primary product image $ref: '#/components/schemas/Image' Image: type: object description: A product image properties: id: type: integer product_id: type: integer position: type: integer description: Position in the image list alt: type: - string - 'null' description: Alt text for the image width: type: integer height: type: integer src: type: string format: uri description: The image URL variant_ids: type: array description: Variant IDs associated with this image items: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time admin_graphql_api_id: type: string Variant: type: object description: A product variant properties: id: type: integer description: Unique numeric identifier product_id: type: integer description: The ID of the parent product title: type: string description: The variant title price: type: string description: The price of the variant sku: type: - string - 'null' description: Stock keeping unit position: type: integer description: Position of the variant in the list inventory_policy: type: string description: Whether to allow selling when out of stock enum: - deny - continue compare_at_price: type: - string - 'null' description: Original price for comparison fulfillment_service: type: string description: The fulfillment service for the variant inventory_management: type: - string - 'null' description: The inventory tracking service option1: type: - string - 'null' description: Option 1 value option2: type: - string - 'null' description: Option 2 value option3: type: - string - 'null' description: Option 3 value taxable: type: boolean description: Whether the variant is taxable barcode: type: - string - 'null' description: Barcode, UPC, or ISBN grams: type: integer description: Weight in grams weight: type: number description: Weight in the specified unit weight_unit: type: string description: Weight unit enum: - g - kg - oz - lb inventory_item_id: type: integer description: The inventory item ID inventory_quantity: type: integer description: Tracked inventory quantity requires_shipping: type: boolean description: Whether the variant requires shipping created_at: type: string format: date-time updated_at: type: string format: date-time image_id: type: - integer - 'null' description: The ID of the associated image admin_graphql_api_id: type: string Collection: type: object description: A product collection properties: id: type: integer title: type: string description: The collection title handle: type: string description: URL-friendly title body_html: type: - string - 'null' description: Description in HTML published_at: type: - string - 'null' format: date-time sort_order: type: string description: Sort order for products template_suffix: type: - string - 'null' published_scope: type: string updated_at: type: string format: date-time image: $ref: '#/components/schemas/Image' admin_graphql_api_id: type: string ProductOption: type: object description: A product option (e.g. Size, Color) properties: id: type: integer product_id: type: integer name: type: string description: The option name position: type: integer description: Position in the options list values: type: array description: Available values for this option items: type: string securitySchemes: AccessToken: type: apiKey name: X-Shopify-Access-Token in: header description: Access token obtained via OAuth