Shipment

Shipment object: the description of shipment information

refer to [shipment](../model/resource/label.v3.json) object.
ship_from
Address
required

Address object: the description of address information

street1
string
required

address_line1 of address

country
string
required

Country in ISO 3166-1 alpha 3 code

contact_name
string
required

contact_name of address

phone
string

contact_phone of address

fax
string or null

fax_number of address

email
string or null

email of address

company_name
string or null

company_name of address

street2
string or null

address_line2 of address

street3
string or null

address_line3 of address

city
string or null

city of address

state
string or null

state of address

postal_code
string or null

postal_code of address

type
string or null

type of address

Allowed values:
residentialbusiness
tax_id
string or null

tax id

eori_number
string or null

eori number

location
object or null
ship_to
Address
required

Address object: the description of address information

parcels
array[Parcel]
required

Parcels of shipment

box_type
string
required

Type of box for packaging

dimension
Dimension
required

Dimension object: the description of width/height/depth information

items
array[Item]
required

items of package Item object, use to describe product to ship

description
string

The description of the parcel

weight
Weight

Weight object: unit weight of the item

return_to
Address

Address object: the description of address information

delivery_instructions
string

Instructions to aid in prompt delivery of the shipment.

Example
preparing...