Skip to main content
POST
/
card-shipments
/
{id}
/
submit
Submit a card shipment to the manufacturer
curl --request POST \
  --url https://sandbox.api.reap.global/card-shipments/{id}/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Reap-Version: <reap-version>' \
  --header 'idempotency-key: <idempotency-key>'
{
  "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>",
  "cards": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cardDesignId": "<string>",
      "shippingAddress": {
        "line1": "<string>",
        "line2": "<string>",
        "zone": "<string>",
        "city": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
      },
      "productionStatus": "PENDING",
      "rejectedAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<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"

​
Idempotency-Key
string

Unique key for safely retrying this request. Up to 255 characters; we recommend a UUIDv4. The first request executes and its response is cached; subsequent requests with the same key replay the cached response (24h retention).

Required string length: 1 - 255
​
idempotency-key
string
required

Unique key for safely retrying this request. Up to 255 characters; we recommend a UUIDv4. The first request executes and its response is cached; subsequent requests with the same key replay the cached response (24h retention).

Required string length: 1 - 255

Path Parameters

​
id
string<uuid>
required

Response

Response for status 200

​
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

​
cards
object[]
required

Cards included in this shipment