Shopify Admin REST API — Collections

naftiko: 1.0.0-alpha2
info:
  label: Shopify Admin REST API — Collections
  description: 'Shopify Admin REST API — Collections. 2 operations. Lead operation: List Collects. Self-contained Naftiko
    capability covering one Shopify Admin business surface.'
  tags:
  - Shopify Admin
  - Collections
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_ADMIN_API_KEY: SHOPIFY_ADMIN_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-collections
    baseUri: https://{store_name}.myshopify.com/admin/api/2024-10
    description: Shopify Admin REST API — Collections business capability. Self-contained, no shared references.
    resources:
    - name: collects.json
      path: /collects.json
      operations:
      - name: listcollects
        method: GET
        description: List Collects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection_id
          in: query
          type: integer
          description: Filter by collection ID
        - name: product_id
          in: query
          type: integer
          description: Filter by product ID
    - name: custom_collections.json
      path: /custom_collections.json
      operations:
      - name: listcustomcollections
        method: GET
        description: List Custom Collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: The maximum number of results to show
    authentication:
      type: apikey
      key: X-Shopify-Access-Token
      value: '{{env.SHOPIFY_ADMIN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-collections-rest
    port: 8080
    description: REST adapter for Shopify Admin REST API — Collections. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/collects-json
      name: collects-json
      description: REST surface for collects.json.
      operations:
      - method: GET
        name: listcollects
        description: List Collects
        call: rest-collections.listcollects
        with:
          collection_id: rest.collection_id
          product_id: rest.product_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/custom-collections-json
      name: custom-collections-json
      description: REST surface for custom_collections.json.
      operations:
      - method: GET
        name: listcustomcollections
        description: List Custom Collections
        call: rest-collections.listcustomcollections
        with:
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-collections-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopify Admin REST API — Collections. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-collects
      description: List Collects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-collections.listcollects
      with:
        collection_id: tools.collection_id
        product_id: tools.product_id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-custom-collections
      description: List Custom Collections
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-collections.listcustomcollections
      with:
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.