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
Specific Shipper Accounts
Create a FedEx shipper account
post
Update a FedEx shipper account
post
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
Volume
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

UpdateResources
Supported create FedEx or FedEx Ground® Economy shipper account.
POST /couriers/fedex/shipper-accounts
Supported update FedEx or FedEx Ground® Economy shipper account.
POST /couriers/fedex/shipper-accounts/:id/update
Added new service type with fedex_economy, fedex_first, fedex_priority, fedex_priority_express.
POST /labels
Removed key, password, meter_number, preferred_currency field for fedex shipper account credentials, removed key, password, meter_number field for fedex-smartpost shipper account credentials,
POST /shipper-accounts
PATCH /shipper-accounts/:id/credentials
Removed paper size with 4x6.75 for fedex.POST /labels
Removed service options with print_return_label for fedex.POST /labels
UpdateResources
Added the service_option scheduled_delivery for taqbin-jp forward shipments. Supports specifying a delivery date (date), start time (start_time), and end time (end_time).POST /labels
Added the service_type gps_dpd_return for gps.POST /labels
UpdateResources
Added courier_specific field to the location object. For UPS locations, courier_specific.ups.public_access_point_id returns the UPS Public Access Point ID, which can be used to identify a specific UPS Access Point.GET /locations
UpdateResources
Added contract_number field for singapore-post shipper account credentials.
POST /shipper-accounts
PATCH /shipper-accounts/id/credentials
Added the service_type with singapore-post_speedpost_saver_international for singapore-post.POST /labels
UpdateResources
Added order_id for calculating rates which could be optionally consumed by supported slugs, including tiktok-shipping.
POST /rates
UpdateResources
Added the service_type with mondialrelay_point_relais for mondialrelay.POST /labels
Removed the service_type with mondialrelay_home_standard, mondialrelay_home_heavy for mondialrelay.POST /labels
Added the service_option hold_at_location for mondialrelay.POST /labels
Added the file_type with zpl for mondialrelay.POST /labels
Added the paper_size with a5, 4x6 for mondialrelay.POST /labels
Added login, password, customer_id field for mondialrelay shipper account credentials.
POST /shipper-accounts
PATCH /shipper-accounts/id/credentials
Removed key, merchant_id field for mondialrelay shipper account credentials.
POST /shipper-accounts
PATCH /shipper-accounts/id/credentials
UpdateResources
Added shipment_movement_type field for australia-post shipper account credentials.
POST /shipper-accounts
PATCH /shipper-accounts/id/credentials
UpdateResources
Added overnight_pre_alert_by_sms, overnight_pre_alert_by_email, receiver_milestone_alerts_by_sms, receiver_milestone_alerts_by_email, shipment_movement_type field for tnt-au shipper account credentials.
POST /shipper-accounts
PATCH /shipper-accounts/id/credentials
UpdateResources
Added piece_tracking_numbers field in label response which could be consumed by supported slugs, including dhl.
POST /labels
GET /labels
GET /labels/:id
UpdateResources
Added neighbour, leave_safe, pod in service option.POST /labels
Added ukims in address.tax_id_type.POST /labels
UpdateResources
Added shipment.ship_from_display for creating labels which could be optionally consumed by supported slugs, including purolator.
POST /labels
UpdateResources
Added carrier_references.pickup_location_code field in label resource.
GET /labels
POST /labels
GET /labels/:id
Added pickup_location_code field in pickup resource.
GET /pickups
POST /pickups
GET /pickups/:id
UpdateResources
Removed alert_notification and alert_notification_content field for nacex shipper account credentials.
POST /shipper-accounts
PATCH /shipper-accounts/id/credentials
UpdateResources
Added box_free field for canada-post shipper account credentials.
POST /shipper-accounts
PATCH /shipper-accounts/id/credentials
UpdateResources
Added notification in service option.
POST /labels
UpdateResources
Added carrier_redirect_link field in label response.
GET /labels
POST /labels
GET /labels/:id
Added customs.broker_address for creating labels which could be optionally consumed by supported slugs, including dhl, fedex.
POST /labels
UpdateResources
Added delivery_option, shipping_and_return in service option.
POST /labels
UpdateResources
Added outbound_hs_code for creating labels, that can be optionally consumed by supported slugs, including dhl.
POST /labels
UpdateResources
Added drop_off_link field in locations response.
GET /locations
UpdateResources
New parameters in GET /locations endpoint:
- street
- filters
New fields in Location model:
- location_type
- business_classification
- instructions
GET /locations
Added dangerous_goods.liquid_volume for creating labels and calculating rates which could be optionally consumed by supported slugs, including amazon-shipping.
POST /labels
POST /rates
UpdateResources
Added print_options.qr_code for creating labels that can be optionally consumed by supported slugs, including arvato, canada-post, dpd-uk, evri, vesyl, usps.
POST /labels
UpdateResources
Added shipment.tax_total for creating labels which could be optionally consumed by the Yamato Japan carrier.
POST /labels
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
UpdateResources
Added files.certificate_of_origin.content, files.commercial_invoice.content for create label, only applies to FedEx, DHL Express.
POST /labels
UpdateResources
Added expected_delivery_date for calculate rates.
POST /rates
UpdateResources
Create label field invoice.signature_name, invoice.declaration_statement applies to DHL Express.
POST /labels
UpdateResources
Added neutral_description_label in service option - general type.POST /labels
POST /rates
UpdateResources
Added non-merchandise value in label customs purpose.POST /labels
UpdateResources
Create label field customs.additional_charges applies to DHL and UPS.
POST /labels
UpdateResources
Added packing_slip field in label response files.GET /labels
POST /labels
GET /labels/:id
UpdateResources
Added return_reason param in label shipment item.POST /labels
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
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
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
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
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
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
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
UpdateResources
Added new carrier lbcexpress.
Please check all supported carriers here.
GET /labels
POST /labels
GET /labels/:id
UpdateResources
We are pleased to announce the addition of get locations API supportGET /locations
UpdateResources
Added new carrier team-global-express.
Please check all supported carriers here.
GET /labels
POST /labels
GET /labels/:id
UpdateResources
Added new carrier tnt-it.
Please check all supported carriers here.
GET /labels
POST /labels
GET /labels/:id
UpdateResources
Added new carrier evri.
Please check all supported carriers here.
GET /labels
POST /labels
GET /labels/:id
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
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
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
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
UpdateResources
Supported to create return label from existing order.GET /labels
POST /labels
GET /labels/:id
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
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
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
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
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
UpdateResources
First release-