Skip to main content
POST
Create shipment draft

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"

Body

Request body for creating a card shipment

destinationAddress
object
required

Box-level destination address

recipient
object
required

Recipient details

courier
Postal · object
required

Courier selection

cards
object[]
required

Cards to include in this shipment

Minimum array length: 1

Response

Card shipment resource

id
string<uuid>
required

Unique shipment identifier

status
enum<string>
required

Shipment lifecycle status

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

"DRAFT"

destinationAddress
object
required

Box-level destination address

recipient
object
required

Recipient details

courier
object
required

Courier selection

trackingNumber
string | null
required

Courier tracking number

trackingUrl
string | null
required

Courier tracking URL

cutoffDate
string | null
required

ISO 8601 cutoff date returned by the manufacturer

createdAt
string
required

ISO 8601 creation timestamp

updatedAt
string
required

ISO 8601 last update timestamp

submittedAt
string | null
required

ISO 8601 timestamp when submitted to the manufacturer

deliveredAt
string | null
required

ISO 8601 timestamp when all cards were delivered