Skip to main content
GET
Scope: ship:cards, granted on request · MCP tool: get_shipment, which takes the id as shipment_id One shipment on your account, with the same fields as in List shipments plus the cards and the address. It always has the current status, so it’s the place to check after a shipment.updated event or a SHIPMENT_OUTCOME_UNKNOWN.
string
required
The id that Create a shipment returned, or the shipment_id in an error. A UUID.

Response

Every field of a shipment in List shipments, plus:
object[]
The cards in the shipment. Empty until the order exists, and if we’ve removed the order.
object | null
Where it ships to. null until the order exists, and if we’ve removed the order. Also null after we’ve removed the address, when address_removed is true: how long we keep it.

Errors