Shopify API — Custom

naftiko: 1.0.0-alpha2
info:
  label: Shopify  API — Custom
  description: 'Shopify  API — Custom. 42 operations. Lead operation: Shopify Adds A Product To A Custom Collection. Self-contained
    Naftiko capability covering one Shopify business surface.'
  tags:
  - Shopify
  - Custom
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_API_KEY: SHOPIFY_API_KEY
capability:
  consumes:
  - type: http
    namespace: shopify-custom
    baseUri: ''
    description: Shopify  API — Custom business capability. Self-contained, no shared references.
    resources:
    - name: admin-api-2020-01-collects.json
      path: /admin/api/2020-01/collects.json
      operations:
      - name: deprecated202001createcollects
        method: POST
        description: Shopify Adds A Product To A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-01-custom_collections.json
      path: /admin/api/2020-01/custom_collections.json
      operations:
      - name: deprecated202001getcustomcollections
        method: GET
        description: Shopify Retrieves A List Of Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: ids
          in: query
          type: string
          description: Show only collections specified by a comma-separated list of IDs.
        - name: since_id
          in: query
          type: string
          description: Restrict results to after the specified ID.
        - name: title
          in: query
          type: string
          description: Show custom collections with a given title.
        - name: product_id
          in: query
          type: string
          description: Show custom collections that include a given product.
        - name: handle
          in: query
          type: string
          description: Filter by custom collection handle.
        - name: updated_at_min
          in: query
          type: string
          description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_min
          in: query
          type: string
          description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_max
          in: query
          type: string
          description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_status
          in: query
          type: string
          description: Show custom collectsion with a given published status.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
      - name: deprecated202001createcustomcollections
        method: POST
        description: Shopify Creates A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-01-custom_collections-count.json
      path: /admin/api/2020-01/custom_collections/count.json
      operations:
      - name: deprecated202001getcustomcollectionscount
        method: GET
        description: Shopify Retrieves A Count Of Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: title
          in: query
          type: string
          description: Count custom collections with given title.
        - name: product_id
          in: query
          type: string
          description: Count custom collections that include a given product.
        - name: updated_at_min
          in: query
          type: string
          description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_min
          in: query
          type: string
          description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_max
          in: query
          type: string
          description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_status
          in: query
          type: string
          description: Count custom collections with a given published status.
    - name: admin-api-2020-01-custom_collections-custom_collection_id}.json
      path: /admin/api/2020-01/custom_collections/{custom_collection_id}.json
      operations:
      - name: deprecated202001getcustomcollectionsparamcustomcollectionid
        method: GET
        description: Shopify Retrieves A Single Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
      - name: deprecated202001updatecustomcollectionsparamcustomcollectionid
        method: PUT
        description: Shopify Updates An Existing Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deprecated202001deletecustomcollectionsparamcustomcollectionid
        method: DELETE
        description: Shopify Deletes A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
    - name: admin-api-2020-04-collects.json
      path: /admin/api/2020-04/collects.json
      operations:
      - name: deprecated202004createcollects
        method: POST
        description: Shopify Adds A Product To A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-custom_collections.json
      path: /admin/api/2020-04/custom_collections.json
      operations:
      - name: deprecated202004getcustomcollections
        method: GET
        description: Shopify Retrieves A List Of Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: ids
          in: query
          type: string
          description: Show only collections specified by a comma-separated list of IDs.
        - name: since_id
          in: query
          type: string
          description: Restrict results to after the specified ID.
        - name: title
          in: query
          type: string
          description: Show custom collections with a given title.
        - name: product_id
          in: query
          type: string
          description: Show custom collections that include a given product.
        - name: handle
          in: query
          type: string
          description: Filter by custom collection handle.
        - name: updated_at_min
          in: query
          type: string
          description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_min
          in: query
          type: string
          description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_max
          in: query
          type: string
          description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_status
          in: query
          type: string
          description: Show custom collectsion with a given published status.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
      - name: deprecated202004createcustomcollections
        method: POST
        description: Shopify Creates A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-custom_collections-count.json
      path: /admin/api/2020-04/custom_collections/count.json
      operations:
      - name: deprecated202004getcustomcollectionscount
        method: GET
        description: Shopify Retrieves A Count Of Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: title
          in: query
          type: string
          description: Count custom collections with given title.
        - name: product_id
          in: query
          type: string
          description: Count custom collections that include a given product.
        - name: updated_at_min
          in: query
          type: string
          description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_min
          in: query
          type: string
          description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_max
          in: query
          type: string
          description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_status
          in: query
          type: string
          description: Count custom collections with a given published status.
    - name: admin-api-2020-04-custom_collections-custom_collection_id}.json
      path: /admin/api/2020-04/custom_collections/{custom_collection_id}.json
      operations:
      - name: deprecated202004getcustomcollectionsparamcustomcollectionid
        method: GET
        description: Shopify Retrieves A Single Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
      - name: deprecated202004updatecustomcollectionsparamcustomcollectionid
        method: PUT
        description: Shopify Updates An Existing Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deprecated202004deletecustomcollectionsparamcustomcollectionid
        method: DELETE
        description: Shopify Deletes A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
    - name: admin-api-2020-07-collects.json
      path: /admin/api/2020-07/collects.json
      operations:
      - name: deprecated202007createcollects
        method: POST
        description: Shopify Adds A Product To A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-custom_collections.json
      path: /admin/api/2020-07/custom_collections.json
      operations:
      - name: deprecated202007getcustomcollections
        method: GET
        description: Shopify Retrieves A List Of Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: ids
          in: query
          type: string
          description: Show only collections specified by a comma-separated list of IDs.
        - name: since_id
          in: query
          type: string
          description: Restrict results to after the specified ID.
        - name: title
          in: query
          type: string
          description: Show custom collections with a given title.
        - name: product_id
          in: query
          type: string
          description: Show custom collections that include a given product.
        - name: handle
          in: query
          type: string
          description: Filter by custom collection handle.
        - name: updated_at_min
          in: query
          type: string
          description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_min
          in: query
          type: string
          description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_max
          in: query
          type: string
          description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_status
          in: query
          type: string
          description: Show custom collectsion with a given published status.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
      - name: deprecated202007createcustomcollections
        method: POST
        description: Shopify Creates A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-custom_collections-count.json
      path: /admin/api/2020-07/custom_collections/count.json
      operations:
      - name: deprecated202007getcustomcollectionscount
        method: GET
        description: Shopify Retrieves A Count Of Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: title
          in: query
          type: string
          description: Count custom collections with given title.
        - name: product_id
          in: query
          type: string
          description: Count custom collections that include a given product.
        - name: updated_at_min
          in: query
          type: string
          description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_min
          in: query
          type: string
          description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_max
          in: query
          type: string
          description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_status
          in: query
          type: string
          description: Count custom collections with a given published status.
    - name: admin-api-2020-07-custom_collections-custom_collection_id}.json
      path: /admin/api/2020-07/custom_collections/{custom_collection_id}.json
      operations:
      - name: deprecated202007getcustomcollectionsparamcustomcollectionid
        method: GET
        description: Shopify Retrieves A Single Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
      - name: deprecated202007updatecustomcollectionsparamcustomcollectionid
        method: PUT
        description: Shopify Updates An Existing Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deprecated202007deletecustomcollectionsparamcustomcollectionid
        method: DELETE
        description: Shopify Deletes A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
    - name: admin-api-2020-10-collects.json
      path: /admin/api/2020-10/collects.json
      operations:
      - name: createcollects
        method: POST
        description: Shopify Adds A Product To A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-10-custom_collections.json
      path: /admin/api/2020-10/custom_collections.json
      operations:
      - name: getcustomcollections
        method: GET
        description: Shopify Retrieves A List Of Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: ids
          in: query
          type: string
          description: Show only collections specified by a comma-separated list of IDs.
        - name: since_id
          in: query
          type: string
          description: Restrict results to after the specified ID.
        - name: title
          in: query
          type: string
          description: Show custom collections with a given title.
        - name: product_id
          in: query
          type: string
          description: Show custom collections that include a given product.
        - name: handle
          in: query
          type: string
          description: Filter by custom collection handle.
        - name: updated_at_min
          in: query
          type: string
          description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_min
          in: query
          type: string
          description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_max
          in: query
          type: string
          description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_status
          in: query
          type: string
          description: Show custom collectsion with a given published status.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
      - name: createcustomcollections
        method: POST
        description: Shopify Creates A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-10-custom_collections-count.json
      path: /admin/api/2020-10/custom_collections/count.json
      operations:
      - name: getcustomcollectionscount
        method: GET
        description: Shopify Retrieves A Count Of Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: title
          in: query
          type: string
          description: Count custom collections with given title.
        - name: product_id
          in: query
          type: string
          description: Count custom collections that include a given product.
        - name: updated_at_min
          in: query
          type: string
          description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_min
          in: query
          type: string
          description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_max
          in: query
          type: string
          description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_status
          in: query
          type: string
          description: Count custom collections with a given published status.
    - name: admin-api-2020-10-custom_collections-custom_collection_id}.json
      path: /admin/api/2020-10/custom_collections/{custom_collection_id}.json
      operations:
      - name: getcustomcollectionsparamcustomcollectionid
        method: GET
        description: Shopify Retrieves A Single Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
      - name: updatecustomcollectionsparamcustomcollectionid
        method: PUT
        description: Shopify Updates An Existing Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletecustomcollectionsparamcustomcollectionid
        method: DELETE
        description: Shopify Deletes A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
    - name: admin-api-2021-01-collects.json
      path: /admin/api/2021-01/collects.json
      operations:
      - name: deprecated202101createcollects
        method: POST
        description: Shopify Adds A Product To A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2021-01-custom_collections.json
      path: /admin/api/2021-01/custom_collections.json
      operations:
      - name: deprecated202101getcustomcollections
        method: GET
        description: Shopify Retrieves A List Of Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: string
          description: The maximum number of results to retrieve.
        - name: ids
          in: query
          type: string
          description: Show only collections specified by a comma-separated list of IDs.
        - name: since_id
          in: query
          type: string
          description: Restrict results to after the specified ID.
        - name: title
          in: query
          type: string
          description: Show custom collections with a given title.
        - name: product_id
          in: query
          type: string
          description: Show custom collections that include a given product.
        - name: handle
          in: query
          type: string
          description: Filter by custom collection handle.
        - name: updated_at_min
          in: query
          type: string
          description: 'Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_min
          in: query
          type: string
          description: 'Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_max
          in: query
          type: string
          description: 'Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_status
          in: query
          type: string
          description: Show custom collectsion with a given published status.
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
      - name: deprecated202101createcustomcollections
        method: POST
        description: Shopify Creates A Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2021-01-custom_collections-count.json
      path: /admin/api/2021-01/custom_collections/count.json
      operations:
      - name: deprecated202101getcustomcollectionscount
        method: GET
        description: Shopify Retrieves A Count Of Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: title
          in: query
          type: string
          description: Count custom collections with given title.
        - name: product_id
          in: query
          type: string
          description: Count custom collections that include a given product.
        - name: updated_at_min
          in: query
          type: string
          description: 'Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).'
        - name: updated_at_max
          in: query
          type: string
          description: 'Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_min
          in: query
          type: string
          description: 'Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_at_max
          in: query
          type: string
          description: 'Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).'
        - name: published_status
          in: query
          type: string
          description: Count custom collections with a given published status.
    - name: admin-api-2021-01-custom_collections-custom_collection_id}.json
      path: /admin/api/2021-01/custom_collections/{custom_collection_id}.json
      operations:
      - name: deprecated202101getcustomcollectionsparamcustomcollectionid
        method: GET
        description: Shopify Retrieves A Single Custom Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: custom_collection_id
          in: path
          type: string
          description: custom_collection_id
          required: true
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated lis

# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/capabilities/shopify-custom.yaml