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

Available options:
DRAFT,
PLACED,
IN_PRODUCTION,
READY_TO_SHIP,
IN_TRANSIT,
OUT_FOR_DELIVERY,
DELIVERED,
DELIVERY_FAILED,
EXCEPTION,
CANCELED
Example:

"DRAFT"

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