API Referenceshipments

Get

Authentication

AuthorizationBearer

Your API key, sent as Authorization: Bearer usgmk_live_....

Path parameters

idstringRequired

Response

idstring

Shipment id (UUID).

typeenum
statusenum

Customer-facing status group — in_progress covers every internal workflow state between request and shipment.

item_countinteger0-9007199254740991
Number of mail items packed into the request.
created_ondatetime
When the request was made.
is_expeditedboolean
is_insuredboolean
declared_valuedouble
Total declared customs value of the packed items, in USD.
mail_itemslist of objects
tracking_numberstring or null
Carrier tracking number, once the shipment is on its way.
service_namestring or null

Carrier service used (e.g. “FedEx International Priority”).

destinationobject or null

Where it ships to. Only present for shipment and check_deposit types — returns go back to the sender and pickups happen at the facility.

requested_ship_datedatetime or null

The ship-out date the customer asked for.

deposit_check_slip_company_namestring or null

check_deposit only.

instructionsstring or null
Packing instructions given when the request was made.
insured_amountdouble or null
Insured value in USD. Null when the shipment is not insured.
reject_reasonstring or null

Why the request was rejected. Null unless status is rejected.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error