Get an inventory order by ID

Error

A valid request URL is required to generate request examples

{
  "id": "123E4567-E89B-12D3-A456-426614174000",
  "status": "PROCESSING",
  "warehouse": {
    "id": "123E4567-E89B-12D3-A456-426614174000",
    "name": "SF Main Warehouse"
  },
  "reason": "ONE_OFF",
  "inventoryOrderItems": [
    {
      "id": "123E4567-E89B-12D3-A456-426614174000",
      "status": "RECEIVED",
      "sku": "123E4567-E89B-12D3-A456-426614174000",
      "pricing": {
        "id": "123E4567-E89B-12D3-A456-426614174000",
        "price": 99900,
        "unitPrice": 999
      },
      "quantity": 2,
      "type": "PHYSICAL",
      "discountedPrice": 999,
      "warranty": "<unknown>",
      "expectedShipDate": "2026-01-20"
    }
  ],
  "inventoryOrderShipments": [
    {
      "id": "123E4567-E89B-12D3-A456-426614174000",
      "status": "SHIPPED",
      "inventoryOrderShipmentItems": [
        {
          "id": "123E4567-E89B-12D3-A456-426614174000",
          "inventoryOrderItem": "123E4567-E89B-12D3-A456-426614174000",
          "quantity": 2,
          "status": "RECEIVED",
          "inventories": [
            {
              "id": "123E4567-E89B-12D3-A456-426614174000",
              "deployStatus": "DEPLOYED",
              "serialNumber": "SN123456789",
              "warehouse": "Main Warehouse"
            }
          ]
        }
      ],
      "shippingCarrier": "UPS",
      "trackingCode": "1Z00000000",
      "trackingUrl": "https://tracking.example.com/1Z00000000",
      "trackingStatus": "IN_TRANSIT",
      "trackingShipmentId": "123E4567-E89B-12D3-A456-426614174000",
      "estimatedDeliveryDate": "2024-01-15",
      "etaStart": "2024-01-14",
      "etaEnd": "2024-01-16"
    }
  ],
  "friendlyOrderId": "ORD-000123",
  "customerPoNumber": "PO-12345",
  "billingType": "SUBSCRIPTION",
  "submittedBy": {
    "id": "123E4567-E89B-12D3-A456-426614174000",
    "forename": "Jane",
    "surname": "Doe"
  },
  "createdAt": "2026-02-26T14:15:22.123Z",
  "updatedAt": "2026-03-15T09:00:00.000Z",
  "expectedShipDate": "2026-03-10"
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

GET

api

inventory-orders

{id}

Error

A valid request URL is required to generate request examples

{
  "id": "123E4567-E89B-12D3-A456-426614174000",
  "status": "PROCESSING",
  "warehouse": {
    "id": "123E4567-E89B-12D3-A456-426614174000",
    "name": "SF Main Warehouse"
  },
  "reason": "ONE_OFF",
  "inventoryOrderItems": [
    {
      "id": "123E4567-E89B-12D3-A456-426614174000",
      "status": "RECEIVED",
      "sku": "123E4567-E89B-12D3-A456-426614174000",
      "pricing": {
        "id": "123E4567-E89B-12D3-A456-426614174000",
        "price": 99900,
        "unitPrice": 999
      },
      "quantity": 2,
      "type": "PHYSICAL",
      "discountedPrice": 999,
      "warranty": "<unknown>",
      "expectedShipDate": "2026-01-20"
    }
  ],
  "inventoryOrderShipments": [
    {
      "id": "123E4567-E89B-12D3-A456-426614174000",
      "status": "SHIPPED",
      "inventoryOrderShipmentItems": [
        {
          "id": "123E4567-E89B-12D3-A456-426614174000",
          "inventoryOrderItem": "123E4567-E89B-12D3-A456-426614174000",
          "quantity": 2,
          "status": "RECEIVED",
          "inventories": [
            {
              "id": "123E4567-E89B-12D3-A456-426614174000",
              "deployStatus": "DEPLOYED",
              "serialNumber": "SN123456789",
              "warehouse": "Main Warehouse"
            }
          ]
        }
      ],
      "shippingCarrier": "UPS",
      "trackingCode": "1Z00000000",
      "trackingUrl": "https://tracking.example.com/1Z00000000",
      "trackingStatus": "IN_TRANSIT",
      "trackingShipmentId": "123E4567-E89B-12D3-A456-426614174000",
      "estimatedDeliveryDate": "2024-01-15",
      "etaStart": "2024-01-14",
      "etaEnd": "2024-01-16"
    }
  ],
  "friendlyOrderId": "ORD-000123",
  "customerPoNumber": "PO-12345",
  "billingType": "SUBSCRIPTION",
  "submittedBy": {
    "id": "123E4567-E89B-12D3-A456-426614174000",
    "forename": "Jane",
    "surname": "Doe"
  },
  "createdAt": "2026-02-26T14:15:22.123Z",
  "updatedAt": "2026-03-15T09:00:00.000Z",
  "expectedShipDate": "2026-03-10"
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

Authorizations

Authorization

string

header

required

Prefix the value with "ApiKey" to indicate the custom authorization type

Path Parameters

string<uuid>

required

Response

Inventory order found

Inventory order information

string<uuid>

required

Order ID

Example:

"123E4567-E89B-12D3-A456-426614174000"

status

enum<string>

required

Order status

Available options:

CANCELLED,

COMPLETE,

ORDERED,

PARTIALLY_RECEIVED,

PROCESSING,

RECEIVED,

SHIPPED,

SUBMITTED

Example:

"PROCESSING"

warehouse

object

required

Warehouse information

Show child attributes

reason

enum<string>

required

Order reason

Available options:

ONE_OFF,

RESTOCK

Example:

"ONE_OFF"

inventoryOrderItems

object[]

required

Inventory order items

Show child attributes

inventoryOrderShipments

object[]

required

Inventory order shipments

Show child attributes

friendlyOrderId

string

Human-readable friendly order ID (order number shown to customers). Null for orders created before this field was populated.

Example:

"ORD-000123"

customerPoNumber

string

Customer PO number

Example:

"PO-12345"

billingType

enum<string>

Billing type

Available options:

SUBSCRIPTION,

PURCHASED

Example:

"SUBSCRIPTION"

submittedBy

object

Person who submitted the order

Show child attributes

createdAt

string<date-time>

UTC ISO-8601 timestamp when the inventory order was created.

Example:

"2026-02-26T14:15:22.123Z"

updatedAt

string<date-time>

UTC ISO-8601 timestamp when the inventory order was last updated.

Example:

"2026-03-15T09:00:00.000Z"

expectedShipDate

string<date>

Date by which the inventory order is expected to ship (calendar date, no time component).

Example:

"2026-03-10"

Modify an inventory order List inventory level configurations for the authenticated organization

⌘I

People

Shipment Notices V1

Returns

Replacements

People — Lifecycle

Packages

Orders

New Joiners

ITAD

Inventory

Inventory Orders

Inventory Levels

Assets

Return Orders

Offices

Warehouses V1

Shipment

Regions V1

Categories

Catalog

Brands

Get an inventory order by ID

Authorizations

Path Parameters

Response