Create a label - AfterShip Shipping API

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.

Request

Security: API Key

Headers

Content-Type

string

required

Content-Type

Default:

application/json

Example:

application/json

Body

Create a label object.

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:

giftmerchandisepersonalsamplereturnrepairnon-merchandise

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

additional_charges

array[object]

This array contains additional_charges object. Additional charge to be added to the commercial invoice of this shipment. Only applies to FedEx, DHL Express, UPS currently.

<= 3 items

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

string

references

array[string]

shipment

Shipment

Shipment object: the description of shipment information

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

tax_total

Money

The money object is used to represent the currency amount.

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

signature_name

string

Signature name showing on invoice. Only applies to FedEx, DHL Express currently.

declaration_statement

string

Declaration statement showing on invoice. Only applies to FedEx, DHL Express currently.

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.

file_type

string

Allowed values:

pdfzpl

ship_date

string

Ship Date in YYYY-MM-DD, if not provided, will be today of the shipper account timezone

order_number

string

A user-defined order number used to identify an order.

order_id

string

Unique identification of the order.

custom_fields

object

Custom fields that accept an object with string field.Show all...

files

InputFiles

Files object: additional shipping documents to upload with label generation. Only applies to FedEx, DHL Express currently.

certificate_of_origin

object

Certificate of Origin

commercial_invoice

object

Commercial Invoice

customs_declaration

object

Customs Declaration

print_options

object

qr_code

object

Whether to return the qr_code when creating a label

Supported slug: arvato, canada-post, dpd-uk, evri, vesyl, usps