Blue Yonder Warehouse Management API — Inventory

naftiko: 1.0.0-alpha2
info:
  label: Blue Yonder Warehouse Management API — Inventory
  description: 'Blue Yonder Warehouse Management API — Inventory. 2 operations. Lead operation: List inventory positions.
    Self-contained Naftiko capability covering one Blue Yonder business surface.'
  tags:
  - Blue Yonder
  - Inventory
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BLUE_YONDER_API_KEY: BLUE_YONDER_API_KEY
capability:
  consumes:
  - type: http
    namespace: warehouse-management-inventory
    baseUri: https://api.blueyonder.example.com
    description: Blue Yonder Warehouse Management API — Inventory business capability. Self-contained, no shared references.
    resources:
    - name: wms-v1-inventory
      path: /wms/v1/inventory
      operations:
      - name: listinventory
        method: GET
        description: List inventory positions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: query
          type: string
          description: Filter by warehouse location
        - name: itemId
          in: query
          type: string
          description: Filter by item/SKU identifier
        - name: status
          in: query
          type: string
        - name: page
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
    - name: wms-v1-inventory-itemId
      path: /wms/v1/inventory/{itemId}
      operations:
      - name: getinventorybyitem
        method: GET
        description: Get inventory for item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: itemId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.BLUE_YONDER_API_KEY}}'
  exposes:
  - type: rest
    namespace: warehouse-management-inventory-rest
    port: 8080
    description: REST adapter for Blue Yonder Warehouse Management API — Inventory. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/wms/v1/inventory
      name: wms-v1-inventory
      description: REST surface for wms-v1-inventory.
      operations:
      - method: GET
        name: listinventory
        description: List inventory positions
        call: warehouse-management-inventory.listinventory
        with:
          locationId: rest.locationId
          itemId: rest.itemId
          status: rest.status
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wms/v1/inventory/{itemid}
      name: wms-v1-inventory-itemid
      description: REST surface for wms-v1-inventory-itemId.
      operations:
      - method: GET
        name: getinventorybyitem
        description: Get inventory for item
        call: warehouse-management-inventory.getinventorybyitem
        with:
          itemId: rest.itemId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: warehouse-management-inventory-mcp
    port: 9090
    transport: http
    description: MCP adapter for Blue Yonder Warehouse Management API — Inventory. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-inventory-positions
      description: List inventory positions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: warehouse-management-inventory.listinventory
      with:
        locationId: tools.locationId
        itemId: tools.itemId
        status: tools.status
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: get-inventory-item
      description: Get inventory for item
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: warehouse-management-inventory.getinventorybyitem
      with:
        itemId: tools.itemId
      outputParameters:
      - type: object
        mapping: $.