Skip to main content
GET
List shipments

Authorizations

Authorization
string
header
required

API key as Bearer token

Headers

Reap-Version
enum<string>
required

API version (YYYY-MM-DD)

Available options:
2025-02-14
Example:

"2025-02-14"

Query Parameters

limit
integer
default:20

Maximum number of items to return (1-100, default: 20)

Required range: x <= 100
Examples:

20

50

100

cursor
string

Opaque cursor for pagination. Pass nextCursor from previous response to get next page.

status
enum<string>[]

Filter shipments by status (comma-separated)

  • DRAFT: Shipment created locally but not yet placed with the manufacturer
  • PLACED: Shipment placed and awaiting production
  • IN_PRODUCTION: At least one card in the shipment is being produced
  • READY_TO_SHIP: All cards produced and awaiting courier pickup
  • IN_TRANSIT: Shipment is in transit to the recipient
  • OUT_FOR_DELIVERY: Shipment is with the courier for final delivery
  • DELIVERED: Shipment was delivered to the recipient
  • DELIVERY_FAILED: Delivery attempt failed, courier may re-attempt
  • EXCEPTION: Shipment encountered an exception that may still recover
  • CANCELED: Shipment was canceled and will not continue
Available options:
DRAFT,
PLACED,
IN_PRODUCTION,
READY_TO_SHIP,
IN_TRANSIT,
OUT_FOR_DELIVERY,
DELIVERED,
DELIVERY_FAILED,
EXCEPTION,
CANCELED
cardId
string<uuid>[]

Filter shipments by card ID(s) (comma-separated). Returns shipments that include any of the given cards as members.

include
string

Related resources to include. Pass cards to include all cards in each matching shipment.

Allowed value: "cards"

Response

200 - application/json

Response for status 200

items
object[]
required
nextCursor
string | null
required

Cursor for next page, or null if no more items