Skip to content

Track Shipment

GET /shipments/{id}/tracking query api-key

Returns the current carrier tracking status and estimated delivery window for a dispatched shipment.


Overview

ID track-shipment-api
Method GET
Path /shipments/{id}/tracking
Classification query
Domain fulfillment
Capability fulfillment-execution
Service track-order
Application carrier-platform — Carrier Platform
Auth api-key

Response

Business Object shipment
Description Fulfillment movement or collection unit used to complete customer delivery or pickup.
Lifecycle pending → label-created → collected → in-transit → out-for-delivery → delivery-attempted → held-at-depot → delivered → returned-to-sender → lost

Integration Patterns

Pattern Flow Style Description
FMS → Carrier Platform Label & Tracking fmscarrier-platform synchronous-api At dispatch, the FMS calls the Carrier Platform to generate a shipping label and obtain a tracking number. Carrier updates are received via webhook.

Scenarios using fulfillment-execution

Scenario Description
Buy Online, Pick Up In Store Customer browses and purchases online, then collects the order from a physical store. The canonical
Endless Aisle Store associate helps a customer order an item that is not physically stocked in the current store b
Ship From Store An online order is fulfilled by shipping the goods directly from a physical store rather than a cent
Ship To Store Customer places an online order for collection at a chosen store while stock is sourced from a wareh
Unified Return Customer returns an item regardless of the original purchase channel. The return may be initiated on
API Method Path Type
Get Fulfillment Order GET /fulfillment/orders/{id} query
Dispatch Fulfillment Order POST /fulfillment/orders/{id}/dispatch action
Create Return POST /returns command
Create Picking Order POST /picking-orders command
Update Picking Status PUT /picking-orders/{id}/status action
Generate Shipping Label POST /shipments/{id}/label command