List all orders for the authenticated organization

Error

A valid request URL is required to generate request examples

[
  {
    "id": "123E4567-E89B-12D3-A456-426614174000",
    "status": "COMPLETED",
    "orderItems": [
      {
        "id": "123E4567-E89B-12D3-A456-426614174000",
        "skuId": "123E4567-E89B-12D3-A456-426614174000",
        "title": "iPad Air - Silver, 64GB, WiFi",
        "categoryCode": "COMPUTER",
        "status": "PROCESSING",
        "statusHistory": [
          {
            "status": "APPROVED",
            "timestamp": "2023-01-01T12:00:00Z"
          }
        ],
        "shipment": {
          "trackingUrl": "<string>",
          "trackingCode": "1Z00000000",
          "carrier": "UPS",
          "status": "DELIVERED",
          "trackingHistory": [
            {
              "status": "IN_TRANSIT",
              "timestamp": "2023-11-07T05:31:56Z"
            }
          ]
        },
        "vendorSku": "APL-MK183LL/A",
        "vendorCode": "APPLE",
        "serialNumber": "C02XL0AAJG5L",
        "justification": "Need higher RAM for local development workflows",
        "purchaseOrderNumber": "PO-US-LAPTOPS-001"
      }
    ],
    "statusHistory": [
      {
        "status": "APPROVED",
        "timestamp": "2023-01-01T12:00:00Z"
      }
    ],
    "personId": "d7d0d906-425f-402f-bde1-39031c67c40b",
    "officeId": "d7d0d906-425f-402f-bde1-39031c67c40b",
    "shippingAddress": {
      "countryCode": "US",
      "addressLine1": 123,
      "addressLine2": "Suite 103",
      "administrativeArea": "NY",
      "locality": "New York City",
      "postalCode": 10123
    },
    "submittedBy": "John S. (Firstbase)",
    "approvedBy": "Jane Smith",
    "approvedAt": "2026-02-26",
    "deliverToOffice": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "NYC HQ",
      "address": {
        "countryCode": "US",
        "addressLine1": 123,
        "addressLine2": "Suite 103",
        "administrativeArea": "NY",
        "locality": "New York City",
        "postalCode": 10123
      }
    },
    "deliverToPerson": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com"
    },
    "createdAt": "2026-02-26T14:15:22.123Z",
    "updatedAt": "2026-03-15T09:00:00.000Z",
    "expectedBy": "2026-03-10",
    "packageSlug": "engineering-onboarding"
  }
]

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

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

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

GET

api

orders

Error

A valid request URL is required to generate request examples

[
  {
    "id": "123E4567-E89B-12D3-A456-426614174000",
    "status": "COMPLETED",
    "orderItems": [
      {
        "id": "123E4567-E89B-12D3-A456-426614174000",
        "skuId": "123E4567-E89B-12D3-A456-426614174000",
        "title": "iPad Air - Silver, 64GB, WiFi",
        "categoryCode": "COMPUTER",
        "status": "PROCESSING",
        "statusHistory": [
          {
            "status": "APPROVED",
            "timestamp": "2023-01-01T12:00:00Z"
          }
        ],
        "shipment": {
          "trackingUrl": "<string>",
          "trackingCode": "1Z00000000",
          "carrier": "UPS",
          "status": "DELIVERED",
          "trackingHistory": [
            {
              "status": "IN_TRANSIT",
              "timestamp": "2023-11-07T05:31:56Z"
            }
          ]
        },
        "vendorSku": "APL-MK183LL/A",
        "vendorCode": "APPLE",
        "serialNumber": "C02XL0AAJG5L",
        "justification": "Need higher RAM for local development workflows",
        "purchaseOrderNumber": "PO-US-LAPTOPS-001"
      }
    ],
    "statusHistory": [
      {
        "status": "APPROVED",
        "timestamp": "2023-01-01T12:00:00Z"
      }
    ],
    "personId": "d7d0d906-425f-402f-bde1-39031c67c40b",
    "officeId": "d7d0d906-425f-402f-bde1-39031c67c40b",
    "shippingAddress": {
      "countryCode": "US",
      "addressLine1": 123,
      "addressLine2": "Suite 103",
      "administrativeArea": "NY",
      "locality": "New York City",
      "postalCode": 10123
    },
    "submittedBy": "John S. (Firstbase)",
    "approvedBy": "Jane Smith",
    "approvedAt": "2026-02-26",
    "deliverToOffice": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "NYC HQ",
      "address": {
        "countryCode": "US",
        "addressLine1": 123,
        "addressLine2": "Suite 103",
        "administrativeArea": "NY",
        "locality": "New York City",
        "postalCode": 10123
      }
    },
    "deliverToPerson": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com"
    },
    "createdAt": "2026-02-26T14:15:22.123Z",
    "updatedAt": "2026-03-15T09:00:00.000Z",
    "expectedBy": "2026-03-10",
    "packageSlug": "engineering-onboarding"
  }
]

{
  "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

Query Parameters

page

integer<int32>

The page number to request (1 based)

Example:

1

size

integer<int32>

The number of results to return in a page

Example:

100

personId

string<uuid>

The ID of the person to return orders for

Example:

"d7d0d906-425f-402f-bde1-39031c67c40b"

startDate

string<date-time>

UTC Date-time to filter orders created after (ISO-8601 without timezone)

Example:

"2007-12-03T10:15:30"

endDate

string<date-time>

UTC Date-time to filter orders created before (ISO-8601 without timezone)

Example:

"2007-12-03T10:15:30"

status

enum<string>[]

Filter by order statuses

Available options:

AWAITING_APPROVAL,

ORDERED,

PROCESSING,

ORDERED_NOT_SHIPPED,

SHIPPED,

COMPLETED,

PARTIALLY_SHIPPED,

DECLINED,

AWAITING_DELIVERY_SCHEDULING,

DELIVERY_SCHEDULED,

DELIVERED,

NONE,

APPROVED,

AWAITING_FULFILLMENT,

PENDING,

RETURN_KIT_SENT,

RETURN_KIT_DELIVERED,

RETURN_KIT_SENT_BACK,

RECEIVED_IN_WAREHOUSE,

RETURNED,

NOT_RETURNED,

OUT_FOR_DELIVERY,

DELIVERY_EXCEPTION,

SUBMITTED,

CANCELLED,

CONFIRMED,

NOT_COMPLETED,

PARTIALLY_COMPLETED

expectedByFrom

string<date>

Filter by earliest expected-by date (requires expectedByTo)

Example:

"2024-01-01"

expectedByTo

string<date>

Filter by latest expected-by date (requires expectedByFrom)

Example:

"2024-12-31"

packageSlug

string[]

Filter by package slug

submittedBy

string<uuid>[]

Filter by person IDs who submitted the order

approvedBy

string<uuid>[]

Filter by person IDs who approved the order

country

string[]

Filter by destination country codes

recipientType

enum<string>

Filter by recipient type (PERSON, OFFICE)

Available options:

PERSON,

OFFICE

deliveryLocation

enum<string>

Filter by delivery location type (corresponds to the FE 'Delivery location' toggle on the Orders page, where PERSON is shown to users as 'Employee'). Allowed values: PERSON, OFFICE.

Available options:

PERSON,

OFFICE,

PERSON,

OFFICE

vendorSku

string[]

Filter by vendor SKUs

skuId

string<uuid>[]

Filter by SKU IDs

serialNumber

string[]

Filter by serial numbers

sortBy

string

Field to sort by

Example:

"createdAt"

sortDirection

string

Sort direction (ASC, DESC)

Example:

"DESC"

Response

Paginated list of orders

string<uuid>

required

Order's ID

Example:

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

status

enum<string>

required

Order's status

Available options:

AWAITING_APPROVAL,

ORDERED,

PROCESSING,

ORDERED_NOT_SHIPPED,

SHIPPED,

COMPLETED,

PARTIALLY_SHIPPED,

DECLINED,

AWAITING_DELIVERY_SCHEDULING,

DELIVERY_SCHEDULED,

DELIVERED,

NONE,

APPROVED,

AWAITING_FULFILLMENT,

PENDING,

RETURN_KIT_SENT,

RETURN_KIT_DELIVERED,

RETURN_KIT_SENT_BACK,

RECEIVED_IN_WAREHOUSE,

RETURNED,

NOT_RETURNED,

OUT_FOR_DELIVERY,

DELIVERY_EXCEPTION,

SUBMITTED,

CANCELLED,

CONFIRMED,

NOT_COMPLETED,

PARTIALLY_COMPLETED

Example:

"COMPLETED"

orderItems

object[]

required

All order item rows on the order, including lines in terminal states such as CANCELLED. Replacing products via PATCH cancels superseded rows rather than deleting them, so consumers should filter by each item's status when they care only about active lines.

Show child attributes

statusHistory

object[]

required

Chronological history of status changes

Show child attributes

orderType

enum<string>

required

Type of order based on lifecycle context

Available options:

ONE_OFF,

ONBOARDING,

REPLACEMENT

personId

string<uuid>

The ID of the Person

Example:

"d7d0d906-425f-402f-bde1-39031c67c40b"

officeId

string<uuid>

The ID of the Office

Example:

"d7d0d906-425f-402f-bde1-39031c67c40b"

shippingAddress

object

Order item's shipping address

Show child attributes

submittedBy

string

Name of the person who submitted the order

Example:

"John S. (Firstbase)"

approvedBy

string

Name of the person who approved the order

Example:

"Jane Smith"

approvedAt

string<date>

Date when the order was approved

Example:

"2026-02-26"

deliverToOffice

object

Office to which the order is delivered, when different from the assigned office

Show child attributes

deliverToPerson

object

Person to whom the order is delivered, when different from the assigned person

Show child attributes

createdAt

string<date-time>

UTC ISO-8601 timestamp when the order was created.

Example:

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

updatedAt

string<date-time>

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

Example:

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

expectedBy

string<date>

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

Example:

"2026-03-10"

packageSlug

string

Slug of the product package this order was created from, if any.

Example:

"engineering-onboarding"

deliveryLocation

enum<string>

The order's delivery location type (mirrors the FE Orders 'Delivery location' column, where PERSON is shown as 'Employee'). Derived from deliverToOffice / deliverToPerson: OFFICE when deliverToOffice is set, otherwise PERSON when deliverToPerson is set.

Available options:

PERSON,

OFFICE

Approve an order Create a new equipment order for a person or office

⌘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

List all orders for the authenticated organization

Authorizations

Query Parameters

Response