Shopify Admin REST API — Custom Collections

naftiko: 1.0.0-alpha2
info:
  label: Shopify Admin REST API — Custom Collections
  description: 'Shopify Admin REST API — Custom Collections. 2 operations. Lead operation: Shopify Retrieve a list of custom
    collections. Self-contained Naftiko capability covering one Shopify business surface.'
  tags:
  - Shopify
  - Custom Collections
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_API_KEY: SHOPIFY_API_KEY
capability:
  consumes:
  - type: http
    namespace: admin-rest-custom-collections
    baseUri: https://{store}.myshopify.com/admin/api/2025-01
    description: Shopify Admin REST API — Custom Collections business capability. Self-contained, no shared references.
    resources:
    - name: custom_collections.json
      path: /custom_collections.json
      operations:
      - name: listcustomcollections
        method: GET
        description: Shopify Retrieve a list of custom collections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of results (max 250, default 50)
        - name: since_id
          in: query
          type: integer
          description: Return collections after the specified ID
        - name: title
          in: query
          type: string
          description: Filter by collection title
        - name: product_id
          in: query
          type: integer
          description: Show collections containing this product
        - name: fields
          in: query
          type: string
          description: Comma-separated list of fields to include
      - name: createcustomcollection
        method: POST
        description: Shopify Create a custom collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-Shopify-Access-Token
      value: '{{env.SHOPIFY_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: admin-rest-custom-collections-rest
    port: 8080
    description: REST adapter for Shopify Admin REST API — Custom Collections. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/custom-collections-json
      name: custom-collections-json
      description: REST surface for custom_collections.json.
      operations:
      - method: GET
        name: listcustomcollections
        description: Shopify Retrieve a list of custom collections
        call: admin-rest-custom-collections.listcustomcollections
        with:
          limit: rest.limit
          since_id: rest.since_id
          title: rest.title
          product_id: rest.product_id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcustomcollection
        description: Shopify Create a custom collection
        call: admin-rest-custom-collections.createcustomcollection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: admin-rest-custom-collections-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopify Admin REST API — Custom Collections. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: shopify-retrieve-list-custom-collections
      description: Shopify Retrieve a list of custom collections
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-rest-custom-collections.listcustomcollections
      with:
        limit: tools.limit
        since_id: tools.since_id
        title: tools.title
        product_id: tools.product_id
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-create-custom-collection
      description: Shopify Create a custom collection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: admin-rest-custom-collections.createcustomcollection
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.