Returns details of a specific shipment
JavaScript
const options = { method: 'GET', headers: {'x-spree-api-key': '<api-key>', Authorization: 'Bearer <token>'} }; fetch('http://{defaultHost}/api/v3/store/orders/{order_id}/shipments/{id}', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));
{ "id": "ship_UkLWZg9DAJ", "number": "H66940748259", "state": "pending", "tracking": "U10000", "tracking_url": null, "cost": "100.0", "display_cost": "$100.00", "shipped_at": null, "created_at": "2026-03-05T20:52:41.395Z", "updated_at": "2026-03-05T20:52:41.412Z", "shipping_method": { "id": "shpm_UkLWZg9DAJ", "name": "UPS Ground", "code": "UPS_GROUND" }, "stock_location": { "id": "sloc_UkLWZg9DAJ", "state_abbr": "STATE_ABBR_298", "name": "Dyan Bernhard", "address1": "1600 Pennsylvania Ave NW", "city": "Washington", "zipcode": "20500", "country_iso": "US", "country_name": "United States of America", "state_text": "STATE_ABBR_298" }, "shipping_rates": [ { "id": "shpr_UkLWZg9DAJ", "shipping_method_id": "shpm_UkLWZg9DAJ", "name": "UPS Ground", "selected": true, "cost": "100.0", "display_cost": "$100.00", "shipping_method": { "id": "shpm_UkLWZg9DAJ", "name": "UPS Ground", "code": "UPS_GROUND" } } ] }
Publishable API key for store access
JWT token for authenticated customers
Order token for guest access
Shipment ID
Expand shipping_rates
shipment found
Show child attributes
Was this page helpful?