shipment

id
string
required
label
object
required
id
string
required
url
string
required
invoice_url
string or null
qrcode
string or null
tracking_number
string
required
tracking_slug
string
required
tracking_status
string
required
tracking_status_updated_at
string<date-time>
item_selections
array[object]
required
id
string
quantity
integer
ship_from
contact_name
string or null

The name of the contact person associated with the address.

company_name
string or null

The name of the company or organization associated with the address.

address_line_1
string or null

First line of the street address.

address_line_2
string or null

Second line of the street address.

city
string or null

The location's city, town, or village.

state
string or null

The state or region of the location, such as a province, state, or prefecture.

postal_code
string or null

The postal code of the location (also known as zip code, postcode, Eircode, etc.).

country
string or null

The address country/region in ISO 3166-1 alpha-3 format.

Example:
USA
phone_number
string or null

The contact phone number associated with the address.

email
string or null

The email associated with the address.

ship_to
contact_name
string or null

The name of the contact person associated with the address.

company_name
string or null

The name of the company or organization associated with the address.

address_line_1
string or null

First line of the street address.

address_line_2
string or null

Second line of the street address.

city
string or null

The location's city, town, or village.

state
string or null

The state or region of the location, such as a province, state, or prefecture.

postal_code
string or null

The postal code of the location (also known as zip code, postcode, Eircode, etc.).

country
string or null

The address country/region in ISO 3166-1 alpha-3 format.

Example:
USA
phone_number
string or null

The contact phone number associated with the address.

email
string or null

The email associated with the address.

created_at
string<date-time>
required
updated_at
string<date-time>
required
Example
preparing...