Modify an inventory order

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"
    }
  ]
}

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

PATCH

api

inventory-orders

{inventoryOrderId}

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"
    }
  ]
}

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

Authorizations

Authorization

string

header

required

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

Path Parameters

inventoryOrderId

string<uuid>

required

Body

application/json

Request body for modifying an inventory order. All five top-level fields are optional. Omit a field to leave it unchanged. Behaviour depends on the order's current status:

SUBMITTED: all five fields are writable.
PROCESSING or SHIPPED: only customerPoNumber may be present in the body. Sending any other field (even with a value equal to the current one) returns 409 Conflict.
Any other status (ORDERED, RECEIVED, PARTIALLY_RECEIVED, COMPLETE, CANCELLED): the endpoint returns 409 Conflict.

Sending {} (no fields) returns 400 Bad Request. Items semantics: if items is omitted entirely, the existing lines are left unchanged. If items is sent as [], the request is rejected (an order must have at least one active line). Per entry: omit id to add a new line; include id (with any subset of other fields) to update — server prefills skuId, pricingId, discountedPrice, warrantyPricingId, and type from the existing row. Send {"id": "...", "delete": true} to cancel a specific line. Existing lines whose id is not mentioned are left alone.

warehouseId

object

required

New warehouse for the order. Writable only when status is SUBMITTED.

Show child attributes

regionId

object

required

New region. Writable only when status is SUBMITTED.

Show child attributes

customerPoNumber

object

required

Customer PO number. Writable when status is SUBMITTED, PROCESSING, or SHIPPED. Send an explicit JSON null to clear the existing value; omit the key to leave it unchanged.

Show child attributes

billingType

object

required

Billing type. Writable only when status is SUBMITTED.

Show child attributes

items

object[]

Optional list of item changes. Omit the key to leave items unchanged. Sending an empty array returns 409 (orders must keep at least one active line).

Show child attributes

Response

Inventory order updated

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"

Cancel an inventory order Get an inventory order by ID

⌘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

Modify an inventory order

Authorizations

Path Parameters

Body

Response