QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
REFERENCE
API Overview
v3
Rates
Get rates
get
Calculate rates
post
Get a rate
get
Labels
Get labels
get
Create a label
post
Get a label
get
Manifests
Get manifests
get
Create a manifest
post
Get a manifest
get
Couriers
Get all couriers
get
Shipper Accounts
Get shipper accounts
get
Create a shipper account
post
Get a shipper account
get
Delete a shipper account
delete
Update a shipper account's information
put
Update a shipper account's credentials
patch
Cancel Labels
Get the canceled labels
get
Cancel a label
post
Get a canceled label
get
Address Validations (Beta)
Create an address validation
post
MODEL
Envelope
Meta
v3
Error
v3
Primitive
Billing
v3
Customs
v3
Shipment
v3
Address
v3
Parcel
v3
Item
v3
Courier
v3
Files
v3
Reference
v3
Money
v3
PaymentMethodAccount
v3
Dimension
v3
Weight
v3
Aes
v3
NoEei
v3
Resource
Rate
v3
RateRecord
v3
Label
v3
Manifest
v3
ShipperAccount
v3
CancelLabel
v3
AddressValidation (Beta)
v3
ENUM
Shipper Accounts Credentials
Service Types and Service Options List
All Service Options
Webhook
Webhook Overview
Webhook Specifications
Webhook Signature
Webhook Outgoing IPs
OTHERS
Supported Couriers
SDK
Java SDK
Node.js SDK
Open Source
phone
email-verifier
Support
Contact Support

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.

order_id
string

Unique identification of the order.

Example
preparing...