Retrieve Shipment
Retrieves a shipment by its id, or by the payment id it fulfills.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
Pins the request to a dated API version.
"2026-08-13"
Path Parameters
The shipment id (ship_), or the payment id (pay_) it fulfills.
Response
shipment retrieved
The account that owns this shipment, prefixed biz_.
"biz_xxxxxxxxxxxxxx"
The shipping carrier detected for this shipment. Null until a tracking update identifies it.
"ups"
The datetime the shipment was created (ISO 8601).
"2026-01-01T12:00:00.000Z"
Shipment ID, prefixed ship_.
"ship_xxxxxxxxxxxxxx"
The payment this shipment fulfills, prefixed pay_.
"pay_xxxxxxxxxxxxxx"
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 "in_transit"
The carrier-assigned tracking number used to look up shipment progress.
"1Z999AA10123456784"
A customer-facing URL to track this shipment's progress.
"https://track.aftership.com/xxxxxxxxxxxxxxxxxx"
The datetime the shipment was last updated (ISO 8601).
"2026-01-01T12:00:00.000Z"

