Create a pickup

post
/pickups

Create a pickup. Only applicable for FedEx.

Content-Type
string
required

Content-Type

Default:
application/json
Example:
application/json

Create a pickup object.

pickup_date
string

Pickup Date should be provided in YYYY-MM-DD format. If it is not provided, it will default to today's date in the shipper account's timezone

pickup_start_time
string
required

Preferred start time for pickup in HH:mm:ss

pickup_end_time
string
required

Preferred end time for pickup in HH:mm:ss

pickup_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
label_ids
array[string]
required

The labels that need to be picked up

pickup_instructions
string

If you have any instructions for the pickup, they can be used as a note for some carriers

Auth
:
Parameters
:
Body
preparing...