Shopify API — Products

naftiko: 1.0.0-alpha2
info:
  label: Shopify  API — Products
  description: 'Shopify  API — Products. 27 operations. Lead operation: Shopify Retrieve A List Of Products Belonging To A
    Collection. Self-contained Naftiko capability covering one Shopify business surface.'
  tags:
  - Shopify
  - Products
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_API_KEY: SHOPIFY_API_KEY
capability:
  consumes:
  - type: http
    namespace: shopify-products
    baseUri: ''
    description: Shopify  API — Products business capability. Self-contained, no shared references.
    resources:
    - name: admin-api-2020-01-collections-collection_id-products.json
      path: /admin/api/2020-01/collections/{collection_id}/products.json
      operations:
      - name: deprecated202001getcollectionsparamcollectionidproducts
        method: GET
        description: Shopify Retrieve A List Of Products Belonging To A Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection_id
          in: path
          type: string
          description: collection_id
          required: true
        - name: limit
          in: query
          type: string
          description: The number of products to retrieve.
    - name: admin-api-2020-01-product_listings-count.json
      path: /admin/api/2020-01/product_listings/count.json
      operations:
      - name: deprecated202001getproductlistingscount
        method: GET
        description: Shopify Retrieve A Count Of Products That Are Published To Your App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: admin-api-2020-01-products.json
      path: /admin/api/2020-01/products.json
      operations:
      - name: deprecated202001getproducts
        method: GET
        description: Shopify Retrieves A List Of Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ids
          in: query
          type: string
          description: Return only products specified by a comma-separated list of product IDs.
        - name: limit
          in: query
          type: string
          description: Return up to this many results per page.
        - name: since_id
          in: query
          type: string
          description: Restrict results to after the specified ID.
        - name: title
          in: query
          type: string
          description: Filter results by product title.
        - name: vendor
          in: query
          type: string
          description: Filter results by product vendor.
        - name: handle
          in: query
          type: string
          description: Filter results by product handle.
        - name: product_type
          in: query
          type: string
          description: Filter results by product type.
        - name: status
          in: query
          type: string
          description: Return products by their status.
        - name: collection_id
          in: query
          type: string
          description: Filter results by product collection ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: created_at_max
          in: query
          type: string
          description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_min
          in: query
          type: string
          description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_max
          in: query
          type: string
          description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_status
          in: query
          type: string
          description: Return products by their published status
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
        - name: presentment_currencies
          in: query
          type: string
          description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217
            currency codes.
    - name: admin-api-2020-01-products-count.json
      path: /admin/api/2020-01/products/count.json
      operations:
      - name: deprecated202001getproductscount
        method: GET
        description: Shopify Retrieves A Count Of Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vendor
          in: query
          type: string
          description: Filter results by product vendor.
        - name: product_type
          in: query
          type: string
          description: Filter results by product type.
        - name: collection_id
          in: query
          type: string
          description: Filter results by collection ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: created_at_max
          in: query
          type: string
          description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_min
          in: query
          type: string
          description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_max
          in: query
          type: string
          description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_status
          in: query
          type: string
          description: Return products by their published status
    - name: admin-api-2020-01-smart_collections-smart_collection_id-order.json
      path: /admin/api/2020-01/smart_collections/{smart_collection_id}/order.json
      operations:
      - name: deprecated202001updatesmartcollectionsparamsmartcollectionidorder
        method: PUT
        description: Shopify Updates The Ordering Type Of Products In A Smart Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: smart_collection_id
          in: path
          type: string
          description: smart_collection_id
          required: true
        - name: products
          in: query
          type: string
          description: An array of product IDs, in the order that you want them to appear at the top of the collection. When
            products is specified but empty, any previously sorted pro
        - name: sort_order
          in: query
          type: string
          description: The type of sorting to apply. Valid values are listed in the Properties section above.
        - name: products[]
          in: query
          type: integer
          description: products[]
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-collections-collection_id-products.json
      path: /admin/api/2020-04/collections/{collection_id}/products.json
      operations:
      - name: deprecated202004getcollectionsparamcollectionidproducts
        method: GET
        description: Shopify Retrieve A List Of Products Belonging To A Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection_id
          in: path
          type: string
          description: collection_id
          required: true
        - name: limit
          in: query
          type: string
          description: The number of products to retrieve.
    - name: admin-api-2020-04-product_listings-count.json
      path: /admin/api/2020-04/product_listings/count.json
      operations:
      - name: deprecated202004getproductlistingscount
        method: GET
        description: Shopify Retrieve A Count Of Products That Are Published To Your App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: admin-api-2020-04-products.json
      path: /admin/api/2020-04/products.json
      operations:
      - name: deprecated202004getproducts
        method: GET
        description: Shopify Retrieves A List Of Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ids
          in: query
          type: string
          description: Return only products specified by a comma-separated list of product IDs.
        - name: limit
          in: query
          type: string
          description: Return up to this many results per page.
        - name: since_id
          in: query
          type: string
          description: Restrict results to after the specified ID.
        - name: title
          in: query
          type: string
          description: Filter results by product title.
        - name: vendor
          in: query
          type: string
          description: Filter results by product vendor.
        - name: handle
          in: query
          type: string
          description: Filter results by product handle.
        - name: product_type
          in: query
          type: string
          description: Filter results by product type.
        - name: status
          in: query
          type: string
          description: Return products by their status.
        - name: collection_id
          in: query
          type: string
          description: Filter results by product collection ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: created_at_max
          in: query
          type: string
          description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_min
          in: query
          type: string
          description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_max
          in: query
          type: string
          description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_status
          in: query
          type: string
          description: Return products by their published status
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
        - name: presentment_currencies
          in: query
          type: string
          description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217
            currency codes.
    - name: admin-api-2020-04-products-count.json
      path: /admin/api/2020-04/products/count.json
      operations:
      - name: deprecated202004getproductscount
        method: GET
        description: Shopify Retrieves A Count Of Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vendor
          in: query
          type: string
          description: Filter results by product vendor.
        - name: product_type
          in: query
          type: string
          description: Filter results by product type.
        - name: collection_id
          in: query
          type: string
          description: Filter results by collection ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: created_at_max
          in: query
          type: string
          description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_min
          in: query
          type: string
          description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_max
          in: query
          type: string
          description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_status
          in: query
          type: string
          description: Return products by their published status
    - name: admin-api-2020-04-smart_collections-smart_collection_id-order.json
      path: /admin/api/2020-04/smart_collections/{smart_collection_id}/order.json
      operations:
      - name: deprecated202004updatesmartcollectionsparamsmartcollectionidorder
        method: PUT
        description: Shopify Updates The Ordering Type Of Products In A Smart Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: smart_collection_id
          in: path
          type: string
          description: smart_collection_id
          required: true
        - name: products
          in: query
          type: string
          description: An array of product IDs, in the order that you want them to appear at the top of the collection. When
            products is specified but empty, any previously sorted pro
        - name: sort_order
          in: query
          type: string
          description: The type of sorting to apply. Valid values are listed in the Properties section above.
        - name: products[]
          in: query
          type: integer
          description: products[]
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-collections-collection_id-products.json
      path: /admin/api/2020-07/collections/{collection_id}/products.json
      operations:
      - name: deprecated202007getcollectionsparamcollectionidproducts
        method: GET
        description: Shopify Retrieve A List Of Products Belonging To A Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection_id
          in: path
          type: string
          description: collection_id
          required: true
        - name: limit
          in: query
          type: string
          description: The number of products to retrieve.
    - name: admin-api-2020-07-product_listings-count.json
      path: /admin/api/2020-07/product_listings/count.json
      operations:
      - name: deprecated202007getproductlistingscount
        method: GET
        description: Shopify Retrieve A Count Of Products That Are Published To Your App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: admin-api-2020-07-products.json
      path: /admin/api/2020-07/products.json
      operations:
      - name: deprecated202007getproducts
        method: GET
        description: Shopify Retrieves A List Of Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ids
          in: query
          type: string
          description: Return only products specified by a comma-separated list of product IDs.
        - name: limit
          in: query
          type: string
          description: Return up to this many results per page.
        - name: since_id
          in: query
          type: string
          description: Restrict results to after the specified ID.
        - name: title
          in: query
          type: string
          description: Filter results by product title.
        - name: vendor
          in: query
          type: string
          description: Filter results by product vendor.
        - name: handle
          in: query
          type: string
          description: Filter results by product handle.
        - name: product_type
          in: query
          type: string
          description: Filter results by product type.
        - name: status
          in: query
          type: string
          description: Return products by their status.
        - name: collection_id
          in: query
          type: string
          description: Filter results by product collection ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: created_at_max
          in: query
          type: string
          description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_min
          in: query
          type: string
          description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_max
          in: query
          type: string
          description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_status
          in: query
          type: string
          description: Return products by their published status
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
        - name: presentment_currencies
          in: query
          type: string
          description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217
            currency codes.
    - name: admin-api-2020-07-products-count.json
      path: /admin/api/2020-07/products/count.json
      operations:
      - name: deprecated202007getproductscount
        method: GET
        description: Shopify Retrieves A Count Of Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vendor
          in: query
          type: string
          description: Filter results by product vendor.
        - name: product_type
          in: query
          type: string
          description: Filter results by product type.
        - name: collection_id
          in: query
          type: string
          description: Filter results by collection ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: created_at_max
          in: query
          type: string
          description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_min
          in: query
          type: string
          description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_max
          in: query
          type: string
          description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_status
          in: query
          type: string
          description: Return products by their published status
    - name: admin-api-2020-07-smart_collections-smart_collection_id-order.json
      path: /admin/api/2020-07/smart_collections/{smart_collection_id}/order.json
      operations:
      - name: deprecated202007updatesmartcollectionsparamsmartcollectionidorder
        method: PUT
        description: Shopify Updates The Ordering Type Of Products In A Smart Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: smart_collection_id
          in: path
          type: string
          description: smart_collection_id
          required: true
        - name: products
          in: query
          type: string
          description: An array of product IDs, in the order that you want them to appear at the top of the collection. When
            products is specified but empty, any previously sorted pro
        - name: sort_order
          in: query
          type: string
          description: The type of sorting to apply. Valid values are listed in the Properties section above.
        - name: products[]
          in: query
          type: integer
          description: products[]
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-10-collections-collection_id-products.json
      path: /admin/api/2020-10/collections/{collection_id}/products.json
      operations:
      - name: getcollectionsparamcollectionidproducts
        method: GET
        description: Shopify Retrieve A List Of Products Belonging To A Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection_id
          in: path
          type: string
          description: collection_id
          required: true
        - name: limit
          in: query
          type: string
          description: The number of products to retrieve.
    - name: admin-api-2020-10-products.json
      path: /admin/api/2020-10/products.json
      operations:
      - name: getproducts
        method: GET
        description: Shopify Retrieves A List Of Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ids
          in: query
          type: string
          description: Return only products specified by a comma-separated list of product IDs.
        - name: limit
          in: query
          type: string
          description: Return up to this many results per page.
        - name: since_id
          in: query
          type: string
          description: Restrict results to after the specified ID.
        - name: title
          in: query
          type: string
          description: Filter results by product title.
        - name: vendor
          in: query
          type: string
          description: Filter results by product vendor.
        - name: handle
          in: query
          type: string
          description: Filter results by product handle.
        - name: product_type
          in: query
          type: string
          description: Filter results by product type.
        - name: status
          in: query
          type: string
          description: Return products by their status.
        - name: collection_id
          in: query
          type: string
          description: Filter results by product collection ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: created_at_max
          in: query
          type: string
          description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_min
          in: query
          type: string
          description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_max
          in: query
          type: string
          description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_status
          in: query
          type: string
          description: Return products by their published status
        - name: fields
          in: query
          type: string
          description: Show only certain fields, specified by a comma-separated list of field names.
        - name: presentment_currencies
          in: query
          type: string
          description: Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217
            currency codes.
    - name: admin-api-2020-10-products-count.json
      path: /admin/api/2020-10/products/count.json
      operations:
      - name: getproductscount
        method: GET
        description: Shopify Retrieves A Count Of Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vendor
          in: query
          type: string
          description: Filter results by product vendor.
        - name: product_type
          in: query
          type: string
          description: Filter results by product type.
        - name: collection_id
          in: query
          type: string
          description: Filter results by collection ID.
        - name: created_at_min
          in: query
          type: string
          description: 'Show products created after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: created_at_max
          in: query
          type: string
          description: 'Show products created before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_min
          in: query
          type: string
          description: 'Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: updated_at_max
          in: query
          type: string
          description: 'Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_min
          in: query
          type: string
          description: 'Show products published after date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_at_max
          in: query
          type: string
          description: 'Show products published before date. (format: 2014-04-25T16:15:47-04:00)'
        - name: published_status
          in: query
          type: string
          description: Return products by their published status
    - name: admin-api-2020-10-smart_collections-smart_collection_id-order.json
      path: /admin/api/2020-10/smart_collections/{smart_collection_id}/order.json
      operations:
      - name: updatesmartcollectionsparamsmartcollectionidorder
        method: PUT
        description: Shopify Updates The Ordering Type Of Products In A Smart Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: smart_collection_id
          in: path
          type: string
          description: smart_collection_id
          required: true
        - name: products
          in: query
          type: string
          description: An array of product IDs, in the order that you want them to appear at the top of the collection. When
            products is specified but empty, any previously sorted pro
        - name: sort_order
          in: query
          type: string
          description: The type of sorting to apply. Valid values are listed in the Properties section above.
        - name: products[]
          in: query
          type: integer
          description: products[]
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2021-01-collections-collection_id-products.json
      path: /admin/api/2021-01/collections/{collection_id}/products.json
      operations:
      - name: deprecated202101getcollectionsparamcollectionidproducts
        method: GET
        description: Shopify Retrieve A List Of Products Belonging To A Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection_id
          in: path
          type: string
          description: collection_id
          required: true
        - name: limit
          in: query
          type: string
          description: The number of products to retrieve.
    - name: admin-api-2021-01-products.json
      path: /admin/api/2021-01/products.json
      operations:
      - name: deprecated202101getproducts
        method: GET
        description: Shopify Retrieves A List Of Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ids
          in: query
          type: string
          description: Return only products specified by a comma-separated list of product IDs.
        - name: limit
          in: query
          type: string
          description: Return up to this many results per page.
        - name: since_id
          in: query
          type: string
          description: Restrict results to after the specified ID.
        - name: title
          in: query
          type: string
          description: Filter results by product title.
        - name: vendor
          in: query
          type: string
          description: Filter results by product vendor.
        - name: handle
          in: query
          type: string
          description: Filter results by product handle.
        - name: product_type
          in: query
          type: string
          description: Filter results by product type.
        - name: status
          in: query
          type: string
          description: Return products by their status.
        - name: collection_id
          in: query
          type: string
          description: Filter results by product collection ID.
        - name: create

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