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
Cancel Labels
Get the cancelled labels
get
Cancel a label
post
Get a cancelled label
get
Pickups
Get pickups
get
Create a pickup
post
Get a pickup
get
Cancel Pickups
Get the cancelled pickups
get
Cancel a pickup
post
Get a cancelled pickup
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
Update a shipper account's settings
patch
Address Validations (Beta)
Create an address validation
post
Locations
Get locations
get
MODEL
Envelope
Meta
v3
Error
v3
Primitive
Billing
v3
Customs
v3
Shipment
v3
Address
v3
Parcel
v3
Item
v3
Courier
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
Location
v3
Pickup
v3
CancelPickup
v3
Carrier Guide
Supported Carriers
ENUM
Shipper Accounts Credentials
Service Types and Service Options List
All Service Options
Webhook
Webhook Overview
Webhook Specifications
Webhook Signature
Webhook Outgoing IPs
SDK
Java SDK
Node.js SDK
Open Source
phone
email-verifier
Support
Contact Support

Changelog

v0.32.0 (2024-10-31)

UpdateResources
Added address.tax_id_type, address.identification_number, address.identification_type, dangerous_goods.category_code for create label and calculate rates only applies to DHL eCommerce US.
POST /labels
POST /rates

v0.31.0 (2024-10-23)

UpdateResources
Added files.certificate_of_origin.content, files.commercial_invoice.content for create label, only applies to FedEx, DHL Express.
POST /labels

v0.30.0 (2024-09-25)

UpdateResources
Added expected_delivery_date for calculate rates.
POST /rates

v0.29.0 (2024-08-01)

UpdateResources
Create label field invoice.signature_name, invoice.declaration_statement applies to DHL Express.
POST /labels

v0.28.0 (2024-07-11)

UpdateResources
Added neutral_description_label in service option - general type.POST /labels
POST /rates

v0.27.0 (2024-06-19)

UpdateResources
Added non-merchandise value in label customs purpose.POST /labels

v0.26.0 (2024-06-04)

UpdateResources
Create label field customs.additional_charges applies to DHL and UPS.
POST /labels

v0.25.0 (2024-01-13)

UpdateResources
Added packing_slip field in label response files.GET /labels
POST /labels
GET /labels/:id

v0.24.0 (2023-10-19)

UpdateResources
Added return_reason param in label shipment item.POST /labels

v0.23.0 (2023-09-28)

UpdateResources
Added new carrier pandago.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id
GET /cancel-labels
POST /cancel-labels
GET /cancel-labels/:id
Added new carrier porter-express.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id
GET /cancel-labels
POST /cancel-labels
GET /cancel-labels/:id

v0.22.0 (2023-09-21)

UpdateResources
We are pleased to announce the addition of pickups API and cancel-pickups API supportPOST /pickups
GET /pickups
GET /pickups/:id
POST /cancel-pickups
GET /cancel-pickups
GET /cancel-pickups/:id

v0.21.0 (2023-08-28)

UpdateResources
Added new service type with chronopost-france_10_instance_agence, chronopost-france_13_instance_agence.
POST /labels
Added custom_fields param in label.
GET /labels
POST /labels
GET /labels/:id

v0.20.0 (2023-08-24)

UpdateResources
Added invoice.signature_name for create label, but it only available for FedEx.
POST /labels
Added api_key, api_secret for create dhl shipper account.
POST /shipper-accounts

v0.19.0 (2023-08-17)

UpdateResources
Supported change shipper account setting, but it only available for FedEx.
PATCH /shipper-accounts/:id/settings
Added customs.additional_charges for create label, but it only available for FedEx.
POST /labels
Added settings for create shipper account, but it only available for FedEx.
POST /shipper-accounts

v0.18.0 (2023-07-13)

UpdateResources
Removed the service_type with endicia_first_class_mail, endicia_first_class_mail_registered, endicia_standard_post, endicia_parcel_select, endicia_parcel_select_registered.
Added new service type with endicia_ground_advantage.
POST /labels

v0.17.0 (2023-07-06)

UpdateResources
Added new carrier gls-us.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id
GET /rates
POST /rates
GET /rates/:id
GET /cancel-labels
POST /cancel-labels
GET /cancel-labels/:id

v0.16.0 (2023-06-08)

UpdateResources
Added new carrier lbcexpress.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id

v0.15.0 (2023-04-28)

UpdateResources
We are pleased to announce the addition of get locations API supportGET /locations

v0.14.0 (2023-04-27)

UpdateResources
Added new carrier team-global-express.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id

v0.13.0 (2023-03-16)

UpdateResources
Added new carrier tnt-it.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id

v0.12.0 (2023-03-03)

UpdateResources
Added new carrier evri.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id

v0.11.0 (2023-02-22)

UpdateResources
We are pleased to announce the addition of address validation support in five countries: USA, AUS, BEL, DNK, and DEU (sandbox API available only). If you would like to use AUS, BEL, DNK, and DEU or need more country support, please contact our support team to enable it.POST /address-validations

v0.10.0 (2023-02-20)

UpdateResources
Added new carrier t-cat. In October 1999, Uni-President Group signed a technical cooperation contract with Yamato Transport Co., Ltd. of Japan, officially introducing TA-Q-BIN services into the local market. The tangible distance between people is no longer a problem. Through Black Cat TA-Q-BIN, it provides consumers with a convenient life and becomes a bridge of communication between people.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id

v0.9.0 (2022-12-28)

UpdateResources
Added new carrier thecourierguy. The Courier Guy is South Africa’s leading courier service provider. We’ve been around for over two decades and handle millions of packages every year, assisting thousands of businesses and customers each day by shipping their goods all over the country and internationally. Today we have over 170 Kiosks nationwide, 22 depots, and 1100 Pudo lockers. If you think you’re seeing us everywhere, it’s because we are!
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id

v0.8.0 (2022-12-23)

UpdateResources
Added new carrier kerry-express-tw. Focus-We focus on domestic last mile delivery, adding value to customers' products and services. Service quality-we strive for continuous improvement. Integrity-We value the interests of our customers, remain neutral and trustworthy. Sustainable development-Actively invest resources to build a stronger operating platform and create real value for employees and customers.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id

v0.7.0 (2022-12-16)

UpdateResources
Supported to create return label from existing order.GET /labels
POST /labels
GET /labels/:id

v0.6.0 (2022-11-11)

UpdateResources
Added new carrier tnt-au. We’ve been delivering our customers’ promises for over 70 years. Find out more about TNT.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id

v0.5.0 (2022-09-23)

UpdateResources
Added new carrier uber. As one of leading managed transportation providers in the world, Uber Freight combines advanced technology, a committed team of domain experts, and the industry’s broadest shipper-carrier network to increase agility, efficiency, and predictability, optimizing every aspect of your supply chain and logistics processes.
Please check all supported carriers here.

Added rule-based label API 1.0		GET /labels
POST /labels
GET /labels/:id

v0.4.0 (2022-09-16)

UpdateResources
Added new carrier lalamove. Lalamove is the leading same-day delivery app and courier service. We connect customers & delivery drivers in the Greater Manila Area, Cebu, & Pampanga.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id

v0.3.0 (2022-07-08)

UpdateResources
Added new carrier taqbin-sg. TA-Q-BIN provides free re-delivery to anywhere in Singapore, excluding No-Go Zones. You can keep track of your parcels with our real-time tracking system.
Please check all supported carriers here.		GET /labels
POST /labels
GET /labels/:id

v0.2.0 (2022-06-23)

UpdateResources
Added new carrier singapore-post. Making Every Delivery Count for People and Planet is our purpose, and what we do at Singapore Post (SingPost). Steeped in more than 160 years of rich history, we have grown from Singapore’s postal service provider to a global company with operations in 15 markets.
Please check all supported carriers here.

Updated API for yunexpress		GET /labels
POST /labels
GET /labels/:id

v0.1.0 (2022-05-19)

UpdateResources
First release-