Skip to main content
GET
Retrieve

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

number
string

The tracking number provided by the courier.

url
string | null

The URL to track this shipment on the courier's website. (This is inferred from the tracking number for some couriers.)

courier_name
string | null

The name of the courier for this shipment. (This is inferred from the tracking number for some couriers.)

fulfillment

Expandable – The associated fulfillment ID.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.