API ReferenceTracking

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

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

current_substatusstring

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

current_substatus_codestring

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

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

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

historylist of objects

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

last_mile_carrierobject

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

proof_of_delivery_urlslist of strings

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

servicestring

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

shipment_idlong
The unique identifier of the shipment in ShipBob's system.
tracking_urlstring
A publicly accessible URL for tracking the shipment.
user_idlong
The ShipBob merchant user ID associated with the shipment.

Errors

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