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.

label_file_type
string

The file type for the shipping label – one of PDF, PDF_A4, PDF_A6, PDF_4x6, PDF_4x8, PNG, ZPLII.

parcel_template
string | null

Expandable – The associated parcel template ID.

weight
string | null

The weight of the parcel.

weight_unit
string | null

The unit of the weight – one of g, kg, lb, oz.

inherit_weight
boolean

When true, inherit the weight from the fulfillment.

shipping_date
integer

The date the shipment will be tendered to the carrier. Measured in seconds since the Unix epoch.

dimensions
object | null

The dimensions of the parcel. Defaults to the parcel template's dimensions when parcel_template is set and no dimensions are given, and to the carrier's own preset when carrier_parcel_template_token resolves to a fixed-size package.

carrier_parcel_template_token
string | null

The token of a carrier parcel template (e.g. USPS_SmallFlatRateBox), resolved against this shipment's own shipping provider. Defaults to the parcel template's token when parcel_template is set, and can be cleared or overridden by passing it explicitly. When it resolves to a fixed-size package its dimensions are used, and quoted rates cover only that carrier — read the carrier itself from the parcel template, or from the selected rate once one is chosen. Cannot be changed after the label is purchased.

status
string

The current status of this shipment – one of draft, quoted, purchased, voided.

live_mode
boolean

Whether or not this shipment was created in live mode.

label_url
string | null

The URL for the purchased shipping label.

tracking_number
string | null

The tracking number for this shipment.

tracking_url
string | null

The URL to track this shipment.

carrier
string | null

The shipping carrier of the selected rate.

carrier_messages
object[] | null

Messages from carriers about this shipment.

contact_validations
object | null

Contact validation results returned by the shipping provider. Only available after quoting.

tracking_status
string | null

The current tracking status – one of unknown, pre_transit, in_transit, delivered, returned, failure.

eta
string | null

The estimated time of arrival.

rates
object[]

The available shipping rates for this shipment.

selected_rate
object | null

The selected shipping rate for this shipment.

fulfillment

Expandable – The associated fulfillment ID.

shipping_provider

Expandable – The associated shipping provider ID.

from_contact

Expandable – The associated contact ID.

to_contact

Expandable – The associated contact 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.