List all replacements in paginated result

Error

A valid request URL is required to generate request examples

[
  {
    "id": "123E4567-E89B-12D3-A456-426614174000",
    "status": "SUBMITTED",
    "createdAt": "2025-01-15",
    "person": {
      "id": "016fb454-066b-4ba5-9eca-a2fa14b7e7fc",
      "forename": "<string>",
      "surname": "<string>"
    },
    "submittedBy": {
      "id": "016fb454-066b-4ba5-9eca-a2fa14b7e7fc",
      "forename": "<string>",
      "surname": "<string>"
    },
    "order": {
      "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"
    },
    "returnOrder": {
      "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

replacements

Error

A valid request URL is required to generate request examples

[
  {
    "id": "123E4567-E89B-12D3-A456-426614174000",
    "status": "SUBMITTED",
    "createdAt": "2025-01-15",
    "person": {
      "id": "016fb454-066b-4ba5-9eca-a2fa14b7e7fc",
      "forename": "<string>",
      "surname": "<string>"
    },
    "submittedBy": {
      "id": "016fb454-066b-4ba5-9eca-a2fa14b7e7fc",
      "forename": "<string>",
      "surname": "<string>"
    },
    "order": {
      "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"
    },
    "returnOrder": {
      "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

replacementOrderStatus

enum<string>[]

Filter by replacement order status (calculated from order and return statuses).

Available options:

SUBMITTED,

PROCESSING,

COMPLETED,

PARTIALLY_COMPLETED,

CANCELLED,

SUBMITTED,

PROCESSING,

COMPLETED,

PARTIALLY_COMPLETED,

CANCELLED

country

string[]

Filter by country codes

submittedBy

string<uuid>[]

Filter by person IDs who submitted the replacement

shipmentStatus

enum<string>[]

Filter by the shipment order status of the replacement's linked order.

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,

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_DELIVERED,

RETURN_KIT_SENT_BACK,

RECEIVED_IN_WAREHOUSE,

RETURNED,

NOT_RETURNED,

OUT_FOR_DELIVERY,

DELIVERY_EXCEPTION,

SUBMITTED,

CANCELLED,

CONFIRMED,

NOT_COMPLETED,

PARTIALLY_COMPLETED

returnKitStatus

enum<string>[]

Filter by retrieval method (return kit) statuses.

Available options:

REQUESTED,

PROCESSED,

CANCELLED,

LABEL_CREATED,

SHIPPED,

DELIVERED,

SENT_BACK,

ARRIVED_AT_PROCESSING_FACILITY,

DELIVERY_EXCEPTION,

NOT_PROCESSED,

PARTIALLY_PROCESSED,

SCHEDULING_PICK_UP,

REQUESTED,

PROCESSED,

CANCELLED,

LABEL_CREATED,

SHIPPED,

DELIVERED,

SENT_BACK,

ARRIVED_AT_PROCESSING_FACILITY,

DELIVERY_EXCEPTION,

NOT_PROCESSED,

PARTIALLY_PROCESSED,

SCHEDULING_PICK_UP

vendorSku

string[]

Filter by vendor SKUs

skuId

string<uuid>[]

Filter by SKU IDs

serialNumber

string[]

Filter by serial numbers

startDate

string<date>

Filter replacements created after this date (ISO-8601)

Example:

"2024-01-01"

endDate

string<date>

Filter replacements created before this date (ISO-8601)

Example:

"2024-12-31"

sortBy

string

Field to sort by (createdAt, country, person, status)

Example:

"createdAt"

sortDirection

string

Sort direction (ASC, DESC)

Example:

"DESC"

Response

A paginated list of replacement orders matching the filter criteria.

string<uuid>

required

Replacement ID

Example:

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

status

enum<string>

required

Replacement status

Available options:

SUBMITTED,

PROCESSING,

COMPLETED,

PARTIALLY_COMPLETED,

CANCELLED

Example:

"SUBMITTED"

createdAt

string<date>

required

Date the replacement was created

Example:

"2025-01-15"

person

object

Person associated with the replacement

Show child attributes

submittedBy

object

Person who submitted the replacement

Show child attributes

order

object

Replacement order details

Show child attributes

returnOrder

object

Return order details

Show child attributes

Get a single return order by ID Create a replacement

⌘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 replacements in paginated result

Authorizations

Query Parameters

Response