Pickup

Pickup object: the description of pickup information

Pickup object: the description of pickup information

id
string

Pickup ID

status
Allowed values:
creatingcreatedfailedcancellingcancelled
pickup_confirmation_numbers
array[string]

The confirmation numbers dispatch from carrier when pickup success

pickup_date
string

Pickup Date in YYYY-MM-DD

pickup_start_time
string

A formatted date

pickup_end_time
string

A formatted date

pickup_from
Address

Address object: the description of pickup 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

tax_id_type
string or null

tax id type. Only applies to DHL Express, DHL eCommerce US.

  • vat: Value-Added tax
  • gst: Goods and Service Tax
  • eori: European Union Registration and Identification
  • ioss: Import One Stop Shop
  • pan: Pan-Aarav
  • other: Other
Allowed values:
vatgsteoriiosspanother
identification_number
string or null

identification number

identification_type
string or null

identification type

  • mil: Military Number
  • nid: National Identity Card
  • pas: Passport
  • other: Other
Allowed values:
milnidpasother
eori_number
string or null

eori number

location
object or null
ship_to
Address

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

tax_id_type
string or null

tax id type. Only applies to DHL Express, DHL eCommerce US.

  • vat: Value-Added tax
  • gst: Goods and Service Tax
  • eori: European Union Registration and Identification
  • ioss: Import One Stop Shop
  • pan: Pan-Aarav
  • other: Other
Allowed values:
vatgsteoriiosspanother
identification_number
string or null

identification number

identification_type
string or null

identification type

  • mil: Military Number
  • nid: National Identity Card
  • pas: Passport
  • other: Other
Allowed values:
milnidpasother
eori_number
string or null

eori number

location
object or null
label_ids
array[string]

Labels array, it contains all the label need to pickup

pickup_parcels
array[PickupParcel]

Parcel detail information

weight
Weight
required

Weight object: unit weight of the item

quantity
integer
required

The quantity of the packages. Minimum: 1

service_type
string

Service Type. Required for UPS and DHL Express

dimension
Dimension

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

shipper_account
Reference

Reference object: the description of reference information

id
string

id of referring object

created_at
string

A formatted date

updated_at
string

A formatted date

Example
preparing...