Create Shipment
Attaches a carrier tracking number to a payment and begins tracking it.
Authorizations
A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-07-27"
Body
Response
shipment created
The account that owns this shipment, prefixed biz_.
The shipping carrier detected for this shipment. Null until a tracking update identifies it.
The datetime the shipment was created (ISO 8601).
Shipment ID, prefixed ship_.
The payment this shipment fulfills, prefixed pay_.
The current delivery status of this shipment.
unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error "unknown"
The carrier-assigned tracking number used to look up shipment progress.
A customer-facing URL to track this shipment's progress.
The datetime the shipment was last updated (ISO 8601).

