Label

Label object: the description of label object

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-options-lists.md) for details. This array contains reference data. Please refer to [reference](../model/premitive/reference.v3.json) object for label object details.
id
string

Label ID

status
string
Allowed values:
creatingcreatedcancellingcancelledmanifestingmanifestedfailed
ship_date
string
tracking_numbers
array[string]
carrier_references
array[object]
booking_reference
string
files
Files

Files object: the description of 5 different file objects(label, qr_code, invoice, customs_declaration, manifest)

label
object or null
qr_code
object or null
invoice
object or null
customs_declaration
object or null
manifest
object or null
rate
Rate

Rate object: the description of rate information

charge_weight
Weight

Weight object: unit weight of the item

total_charge
Money

Money object: unit price of the item

shipper_account
object
required

Shipper Account (brief information for rate and manifest responses)

service_type
string
required

Service Types

service_name
string
required

name of service

pickup_deadline
string or null

A formatted date.

booking_cut_off
string or null

A formatted date.

delivery_date
string or null

A formatted date.

transit_time
integer or null

transit time

detailed_charges
array[object]

Courier charges, it may be different for different couriers

error_message
string or null

error information

info_message
string or null

other information of request/response

created_at
string

A formatted date.

updated_at
string

A formatted date.

references
array[string] or null

Reference information for a label

shipper_account
Reference

Reference object: the description of reference information

id
string

id of referring object

service_type
string

Service Types

order_number
string

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

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.

Example
preparing...