Shopify Admin REST API — Inventory

naftiko: 1.0.0-alpha2
info:
  label: Shopify Admin REST API — Inventory
  description: 'Shopify Admin REST API — Inventory. 2 operations. Lead operation: List Inventory Items. Self-contained Naftiko
    capability covering one Shopify Admin business surface.'
  tags:
  - Shopify Admin
  - Inventory
  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-inventory
    baseUri: https://{store_name}.myshopify.com/admin/api/2024-10
    description: Shopify Admin REST API — Inventory business capability. Self-contained, no shared references.
    resources:
    - name: inventory_items.json
      path: /inventory_items.json
      operations:
      - name: listinventoryitems
        method: GET
        description: List Inventory Items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ids
          in: query
          type: string
          description: Show only inventory items specified by a comma-separated list of IDs
          required: true
        - name: limit
          in: query
          type: integer
          description: The maximum number of results to show
    - name: inventory_levels.json
      path: /inventory_levels.json
      operations:
      - name: listinventorylevels
        method: GET
        description: List Inventory Levels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inventory_item_ids
          in: query
          type: string
          description: Comma-separated list of inventory item IDs
        - name: location_ids
          in: query
          type: string
          description: Comma-separated list of location IDs
    authentication:
      type: apikey
      key: X-Shopify-Access-Token
      value: '{{env.SHOPIFY_ADMIN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-inventory-rest
    port: 8080
    description: REST adapter for Shopify Admin REST API — Inventory. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/inventory-items-json
      name: inventory-items-json
      description: REST surface for inventory_items.json.
      operations:
      - method: GET
        name: listinventoryitems
        description: List Inventory Items
        call: rest-inventory.listinventoryitems
        with:
          ids: rest.ids
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/inventory-levels-json
      name: inventory-levels-json
      description: REST surface for inventory_levels.json.
      operations:
      - method: GET
        name: listinventorylevels
        description: List Inventory Levels
        call: rest-inventory.listinventorylevels
        with:
          inventory_item_ids: rest.inventory_item_ids
          location_ids: rest.location_ids
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-inventory-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopify Admin REST API — Inventory. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-inventory-items
      description: List Inventory Items
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-inventory.listinventoryitems
      with:
        ids: tools.ids
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: list-inventory-levels
      description: List Inventory Levels
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-inventory.listinventorylevels
      with:
        inventory_item_ids: tools.inventory_item_ids
        location_ids: tools.location_ids
      outputParameters:
      - type: object
        mapping: $.