Get shipment details
GET /shipping/api/v1/shipments/{id}
GET
/shipping/api/v1/shipments/{id}
Retrieve details and status of a booked shipment
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
The remote shipment ID or tracking number
Example
prb851f578fResponses
Section titled “ Responses ”Shipment details retrieved successfully
object
remote_shipment_id
Remote shipment ID
string
prb851f578f tracking_number
Tracking number
string
9341920111411169517859 carrier
Carrier identifier
string
USPS sub_carrier
Sub-carrier identifier
string
USPS service_name
Service name
string
USPS Bound Printed Matter service_id
Service identifier
string
USPS_PTP_BPM label_url
URL to download the label
string format: uri
/shipping/api/v1/shipments/prb851f578f/label.pdf external_shipment_id
External shipment ID from carrier
string
MSS3da64049-1f98-4113-8287-28d1c043c1a8 total_cost
object
value
string
4.04 unit
string
USD charges
Array<object>
object
chargeType
string
MANDATORY value
string
4.039999961853027 chargeId
string
BASE_RATE linked_account
Whether a linked account was used
boolean
booked_at
When the shipment was booked
string format: date-time
2025-12-11T16:24:36Z created_at
When the shipment record was created
string format: date-time
2025-12-11T16:24:38Z updated_at
When the shipment record was last updated
string format: date-time
2025-12-11T16:24:38ZBad request - invalid label format
object
error_messages
required
List of error messages
Array<string>
[ "to_address is required"]{ "error_messages": [ "Invalid request parameters" ]}Shipment not found
object
error_messages
required
List of error messages
Array<string>
[ "to_address is required"]{ "error_messages": [ "Invalid request parameters" ]}