Get Tracking by Shipment Ids

View as Markdown
Retrieves tracking information for one or more shipments by their ShipBob shipment Ids. Returns the current status, carrier details, estimated delivery time, and full tracking history for each shipment. Accepts between 1 and 25 shipment Ids per request.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

ShipmentIdslist of longsOptional
A list of ShipBob shipment IDs to retrieve tracking information for

Response

OK
current_statusstring

The current high-level status of the shipment.

current_timestampdatetime
The date and time of the most recent tracking event.
tracking_numberstring

The tracking number for the shipment. For ShipBob-carried shipments this is the ShipBob tracking number; for last-mile carrier shipments it is the carrier tracking number.

carrierstring or nullOptional

The name of the carrier handling the shipment (e.g., UPS, FedEx, USPS, ShipBob).

current_substatusstring or nullOptional

A human-readable label for the current granular status (e.g., ‘In Transit’).

current_substatus_codestring or nullOptional

A machine-readable code for the current granular status (e.g., ‘InTransit_001’).

delivery_signed_bystring or nullOptional
The name of the person who signed for the delivery, if applicable.
edddatetime or nullOptional
The estimated delivery date and time.
edd_sourcestring or nullOptional

The source of the estimated delivery date. Either ‘carrier’ (from carrier data) or ‘shipbob’ (ShipBob estimate).

historylist of objects or nullOptional

A list of historical tracking events for the shipment, ordered newest-first.

last_mile_carrierobjectOptional

Last-mile carrier details. Fields are null when no last-mile carrier is present.

proof_of_delivery_urlslist of strings or nullOptional

URLs to proof-of-delivery images, if available.

reference_idstring or nullOptional

Client-defined external unique id of the order from your upstream system.

servicestring or nullOptional

The carrier service level used for the shipment (e.g., Ground, Express).

shipment_idlong or nullOptional
The unique identifier of the shipment in ShipBob's system.
tracking_urlstring or nullOptional
A publicly accessible URL for tracking the shipment.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error