Retrieve Shipment details

GET /v5/shipment/details/ returns everything stored for one Shipment: identifiers, carrier, status and phase, all five address objects, costs and dimensions, linked Shipments, documents, and the complete event history. Identify the Shipment with either shipment_uuid or shipment_id as a query parameter — there is no path parameter.

curl --request GET \
  --url 'https://api.perform.ai/v5/shipment/details/?shipment_id=SHP-2026-000002' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Every response field and nested object (carrier, order, address, money, dimensions, events…) is specified in the API reference.

Working with the response

all_events is the full event history. Each event carries the description (standard English or the original carrier text), the standard event_key and phase_key when mapped, a time whose format reflects the known precision, and a timezone when known — see timestamps.
Money fields come back as objects — { "amount": 150, "currency": "SGD" } — even though you send them as strings ("150 SGD").
Dimensions are returned in centimeters and weight in grams, whatever units you sent.
Address objects include a full field combining all parts into one display string.
A 4041 (HTTP 404) means no Shipment matched the identifier; a 4030 means the identifier was missing or malformed.

Version 5.2: returns, line items, and more

GET /v5-2-0/shipment/details/ — same parameters — returns everything above plus:

Addition	What it is
`shipment_type`	`"return"` for Return Shipments, otherwise `null`.
`returns`	The full return record (status across its 9-state lifecycle, methods, refund amounts, proofs, booking ID). Only for Return Shipments.
`line_items`	The Shipment’s products, costs, and per-item return data.
`collection_point`	The latest drop-off/collection location, with address and operating hours.
`rating`	The consumer’s latest delivery rating.
`parcel_recipient_information`	Recipient info captured at delivery.
`pod_url`	Carrier proof of delivery. Expires after 7 days; a fresh URL is generated on every response — fetch it when you need it rather than storing it.
Enriched `event.location`	Each event’s location expands from a single `place` string to a full address object with coordinates and timezone.

Use v5.2 if you work with returns, line items, or need event geolocation; the v5.0 shape stays available and unchanged.

Retrieve responses are point-in-time reads. If you’re calling this endpoint on a schedule to detect changes, webhooks push the same data on every update cycle and cost none of your rate budget.

Next steps

List and search Shipments to find UUIDs in bulk.
Shipment documents for downloadable files, including labels.

Get Started

Core Concepts

API Essentials

Shipments

Booking & Labels

Returns

Events

Webhooks

Checkout

Customer Experience

Integrations

Resources

Retrieve Shipment details

Working with the response

Version 5.2: returns, line items, and more

Next steps

​Working with the response

​Version 5.2: returns, line items, and more

​Next steps

Working with the response

Version 5.2: returns, line items, and more

Next steps