Create a label

post
/labels

Create a label.

This array contains service_options object. Please refer to [all service options](../../docs/enum/all-service-options.md) and [service options list](../../docs/enum/service-types-and-service-options-lists.md) for details. This array contains reference data. Please refer to [reference](../model/premitive/reference.v3.json) object for label object details.
Content-Type
string
required

Content-Type

Default:
application/json
Example:
application/json

Create a label object

async
boolean

enable async mode or not (set to false if not provided)

billing
Billing

Billing object: the description of billing information

paid_by
string
required
Allowed values:
shipperthird_partyrecipient
method
PaymentMethodAccount

PaymentMethodAccount object: the description of account information

customs
Customs

Customs object: the description of customs information

purpose
string
required
Allowed values:
giftmerchandisepersonalsamplereturnrepair
terms_of_trade
string
Allowed values:
datdduddpdapexwfcafobcipcifcptcfrdpu
eei

AES object: the description of EEI Type - aes

billing
Billing

Billing object: the description of billing information

importer_address
Address

Address object: the description of address information

passport
object

Passport Object

return_shipment
boolean

(set to false if not provided)

is_document
boolean

If the shipment is document type. (set to false if not provided)

service_type
string
paper_size
string
shipper_account
object
id
string
references
array[string]
shipment
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

ship_to
Address
required

Address object: the description of address information

parcels
array[Parcel]
required

Parcels of shipment

return_to
Address

Address object: the description of address information

delivery_instructions
string

Instructions to aid in prompt delivery of the shipment.

invoice
Invoice or null

Invoice object: the description of invoice type, commercial invoice will be generated if field is present in the request body

date
string
required

Invoice date in YYYY-MM-DD

number
string

Invoice number

type
string
Allowed values:
commercialproforma
number_of_copies
integer
>= 1<= 4
service_options
array[object]

This array contains service_options object. Please refer to all service options and service types and service options list for details.

Auth
:
Parameters
:
Body
preparing...