Sign in
track

Tracking endpoint to retrieve tracking info about shipments using carrierId and carrierTrackingId

get/api/v1/tracking/carrier/{carrierId}/{carrierTrackingId}

Path parameters

carrierIdstring required
carrierTrackingIdstring required

Query parameters

excludeEventsboolean

Response

Result

shipiumTrackingIdstring
shipiumShipmentIdstring
partnerShipmentIdstring
shipiumTenantIdstring
partnerTenantIdstring
carrierIdstring
carrierTrackingIdstring
carrierServiceMethodIdstring
shipmentStatus'Registered' | 'Label Printed' | 'In Transit' | 'Out For Delivery' | 'Delivered' | 'Exception' | 'Return to Sender: In Transit' | 'Return to Sender: Out For Delivery' | 'Return to Sender: Delivered' | 'Return to Sender: Exception'
shippedDateTimestring date-time
deliveredAtDateTimestring date-time
carrierEstimatedDeliveryDatestring date-time
originalCarrierEstimatedDeliveryDatestring date-time
partnerReferenceIdstring
partnerReferenceId2string
carrierTrackingLinkstring

Changes

No recorded changes to this endpoint across all 1 revision of this API.