Skip to main content
GET
/
card-shipments
List card shipments
curl --request GET \
  --url https://sandbox.api.reap.global/card-shipments/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Reap-Version: <reap-version>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "DRAFT",
      "destinationAddress": {
        "line1": "<string>",
        "line2": "<string>",
        "zone": "<string>",
        "city": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
      },
      "recipient": {
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "dialCode": 123,
        "email": "jsmith@example.com"
      },
      "courier": {
        "type": "POSTAL",
        "name": "<string>"
      },
      "trackingNumber": "<string>",
      "trackingUrl": "<string>",
      "cutoffDate": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "submittedAt": "<string>",
      "deliveredAt": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

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

Array of items for current page

nextCursor
string | null
required

Cursor for next page, or null if no more items