blue-yonder Inventory API

openapi: 3.1.0
info:
  title: Blue Yonder Warehouse Management Inventory API
  description: The Blue Yonder Warehouse Management API provides access to warehouse operations data including inventory positions, task management, labor optimization, and fulfillment workflows. REST APIs support integration with automation systems, robotics, and ERP platforms for distribution center operations.
  version: 1.0.0
  contact:
    name: Blue Yonder Platform
    url: https://blueyonder.com/solutions/blue-yonder-platform
servers:
- url: https://api.blueyonder.example.com
  description: Blue Yonder WMS API
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Inventory
  description: Inventory positions and stock management
paths:
  /wms/v1/inventory:
    get:
      operationId: listInventory
      summary: List inventory positions
      description: Retrieve current inventory levels and positions across warehouse locations.
      tags:
      - Inventory
      parameters:
      - name: locationId
        in: query
        description: Filter by warehouse location
        schema:
          type: string
      - name: itemId
        in: query
        description: Filter by item/SKU identifier
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
          enum:
          - Available
          - Reserved
          - Quarantine
          - Damaged
      - name: page
        in: query
        schema:
          type: integer
          default: 1
      - name: pageSize
        in: query
        schema:
          type: integer
          default: 50
      responses:
        '200':
          description: Inventory positions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /wms/v1/inventory/{itemId}:
    get:
      operationId: getInventoryByItem
      summary: Get inventory for item
      description: Get inventory levels and all warehouse locations for a specific item/SKU.
      tags:
      - Inventory
      parameters:
      - name: itemId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Item inventory details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemInventory'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Pagination:
      type: object
      properties:
        page:
          type: integer
        pageSize:
          type: integer
        totalPages:
          type: integer
        totalItems:
          type: integer
    InventoryList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/InventoryPosition'
        pagination:
          $ref: '#/components/schemas/Pagination'
    InventoryPosition:
      type: object
      properties:
        positionId:
          type: string
        itemId:
          type: string
        itemDescription:
          type: string
        locationId:
          type: string
        locationName:
          type: string
        zone:
          type: string
        quantityOnHand:
          type: number
        quantityAvailable:
          type: number
        quantityReserved:
          type: number
        unitOfMeasure:
          type: string
        lotNumber:
          type: string
        serialNumber:
          type: string
        expirationDate:
          type: string
          format: date
        status:
          type: string
          enum:
          - Available
          - Reserved
          - Quarantine
          - Damaged
        lastUpdated:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    ItemInventory:
      type: object
      properties:
        itemId:
          type: string
        itemDescription:
          type: string
        totalQuantityOnHand:
          type: number
        totalQuantityAvailable:
          type: number
        unitOfMeasure:
          type: string
        positions:
          type: array
          items:
            $ref: '#/components/schemas/InventoryPosition'
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.blueyonder.example.com/oauth/token
          scopes:
            wms:read: Read warehouse data
            wms:write: Write warehouse data
    bearerAuth:
      type: http
      scheme: bearer