# Quick Start
## Authentication
- [SignString](/content/docs/shipping/quickstart/authentication/sign-string/index.html)
## OAuth
- [Overview](/content/docs/shipping/quickstart/authentication/oauth/overview/index.html)
- [Getting Started](/content/docs/shipping/quickstart/authentication/oauth/getting-started/index.html)
- [Scope List](/content/docs/shipping/quickstart/authentication/oauth/available-scopes/index.html)
- [Rate Limit](/content/docs/shipping/quickstart/rate-limit/index.html)
- [Body Envelope](/content/docs/shipping/quickstart/body-envelope/index.html)
- [Request Errors](/content/docs/shipping/quickstart/request-errors/index.html)
# Changelog
## [v0.56.0 (2026-06-22)](/content/docs/shipping/changelog#v0560-2026-06-22/index.html)
| Update | Resources |
| --- | --- |
| Added `regulatory_data` field for item, supporting `CPSC` regulation code (UPS, FedEx). | POST /labels |
## [v0.55.0 (2026-06-17)](/content/docs/shipping/changelog#v0550-2026-06-17/index.html)
| Update | Resources |
| --- | --- |
| Supported `cancel-label` for `usps`. | DELETE /labels/:id |
| Supported `rates` for `usps`. | POST /rates |
| Supported `manifest` for `usps`. | POST /manifests |
| Removed the service_type with `usps_bound_printed_matter` for `usps`. | POST /labels |
## [v0.54.0 (2026-06-11)](/content/docs/shipping/changelog#v0540-2026-06-11/index.html)
| Update | Resources |
| --- | --- |
| Added the file_type with `zpl` for `bpost`. | POST /labels |
| Added the paper_size with `a6` for `bpost`. | POST /labels |
## [v0.53.0 (2026-05-21)](/content/docs/shipping/changelog#v0530-2026-05-21/index.html)
| Update | Resources |
| --- | --- |
| Added the service_type with `gps_fedex_ground` for `gps`. | POST /labels |
| Added the service_type with `hubbed_returns` for `hubbed`. | POST /labels |
| Added the service_type with `arrowxl_diary` for `arrowxl`. | POST /labels |
| Added new service types with `dpd-prt_home_export_marketplace_eu`, `dpd-prt_seur_home_export_marketplace_es`, `dpd-prt_home_18_islands_marketplace_pr` for `dpd-prt`. | POST /labels |
| Added the service_type with `chronopost-france_2shop_retoure_europe` for `chronopost-france`. | POST /labels |
| Added the service_option `hold_at_location` for `chronopost-france`. | POST /labels |
| Added the file_type with `zpl` for `dhl-supplychain-in`. | POST /labels |
## [v0.52.0 (2026-04-09)](/content/docs/shipping/changelog#v0520-2026-04-09/index.html)
| Update | Resources |
| --- | --- |
| 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 |
## [v0.51.0 (2026-03-19)](/content/docs/shipping/changelog#v0510-2026-03-19/index.html)
| Update | Resources |
| --- | --- |
| 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 |
## [v0.50.0 (2026-03-16)](/content/docs/shipping/changelog#v0500-2026-03-16/index.html)
| Update | Resources |
| --- | --- |
| 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 |
## [v0.49.0 (2026-02-13)](/content/docs/shipping/changelog#v0490-2026-02-13/index.html)
| Update | Resources |
| --- | --- |
| 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 |
## [v0.48.0 (2026-01-29)](/content/docs/shipping/changelog#v0480-2026-01-29/index.html)
| Update | Resources |
| --- | --- |
| Added `order_id` for calculating rates which could be optionally consumed by supported slugs, including `tiktok-shipping`. | POST /rates |
## [v0.47.0 (2025-12-31)](/content/docs/shipping/changelog#v0470-2025-12-31/index.html)
| Update | Resources |
| --- | --- |
| 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 |
## [v0.46.0 (2025-12-18)](/content/docs/shipping/changelog#v0460-2025-12-18/index.html)
| Update | Resources |
| --- | --- |
| Added `shipment_movement_type` field for `australia-post` shipper account credentials. | POST /shipper-accounts
PATCH /shipper-accounts/id/credentials |
## [v0.45.0 (2025-11-13)](/content/docs/shipping/changelog#v0450-2025-11-13/index.html)
| Update | Resources |
| --- | --- |
| 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 |
## [v0.44.0 (2025-10-14)](/content/docs/shipping/changelog#v0440-2025-10-14/index.html)
| Update | Resources |
| --- | --- |
| Added `piece_tracking_numbers` field in label response which could be consumed by supported slugs, including `dhl`. | POST /labels
GET /labels
GET /labels/:id |
## [v0.43.0 (2025-09-25)](/content/docs/shipping/changelog#v0430-2025-09-25/index.html)
| Update | Resources |
| --- | --- |
| Added `neighbour`, `leave_safe`, `pod` in service option. | POST /labels |
| Added `ukims` in `address.tax_id_type`. | POST /labels |
## [v0.42.0 (2025-08-14)](/content/docs/shipping/changelog#v0420-2025-08-14/index.html)
| Update | Resources |
| --- | --- |
| Added `shipment.ship_from_display` for creating labels which could be optionally consumed by supported slugs, including `purolator`. | POST /labels |
## [v0.41.2 (2025-08-07)](/content/docs/shipping/changelog#v0412-2025-08-07/index.html)
| Update | Resources |
| --- | --- |
| 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 |
## [v0.41.1 (2025-07-17)](/content/docs/shipping/changelog#v0411-2025-07-17/index.html)
| Update | Resources |
| --- | --- |
| Removed `alert_notification` and `alert_notification_content` field for `nacex` shipper account credentials. | POST /shipper-accounts
PATCH /shipper-accounts/id/credentials |
## [v0.41.0 (2025-07-08)](/content/docs/shipping/changelog#v0410-2025-07-08/index.html)
| Update | Resources |
| --- | --- |
| Added `box_free` field for `canada-post` shipper account credentials. | POST /shipper-accounts
PATCH /shipper-accounts/id/credentials |
## [v0.40.0 (2025-06-26)](/content/docs/shipping/changelog#v0400-2025-06-26/index.html)
| Update | Resources |
| --- | --- |
| Added `notification` in service option. | POST /labels |
## [v0.39.0 (2025-06-25)](/content/docs/shipping/changelog#v0390-2025-06-25/index.html)
| Update | Resources |
| --- | --- |
| 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 |
## [v0.38.0 (2025-06-24)](/content/docs/shipping/changelog#v0380-2025-06-24/index.html)
| Update | Resources |
| --- | --- |
| Added `delivery_option`, `shipping_and_return` in service option. | POST /labels |
## [v0.37.0 (2025-05-29)](/content/docs/shipping/changelog#v0370-2025-05-29/index.html)
| Update | Resources |
| --- | --- |
| Added `outbound_hs_code` for creating labels, that can be optionally consumed by supported slugs, including `dhl`. | POST /labels |
## [v0.36.0 (2025-05-13)](/content/docs/shipping/changelog#v0360-2025-05-13/index.html)
| Update | Resources |
| --- | --- |
| Added `drop_off_link` field in locations response. | GET /locations |
## [v0.35.0 (2025-05-06)](/content/docs/shipping/changelog#v0350-2025-05-06/index.html)
| Update | Resources |
| --- | --- |
| 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 |
## [v0.34.0 (2025-04-17)](/content/docs/shipping/changelog#v0340-2025-04-17/index.html)
| Update | Resources |
| --- | --- |
| 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 |
## [v0.33.0 (2025-01-10)](/content/docs/shipping/changelog#v0330-2025-01-10/index.html)
| Update | Resources |
| --- | --- |
| Added `shipment.tax_total` for creating labels which could be optionally consumed by the Yamato Japan carrier. | POST /labels |
## [v0.32.0 (2024-10-31)](/content/docs/shipping/changelog#v0320-2024-10-31/index.html)
| Update | Resources |
| --- | --- |
| 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)](/content/docs/shipping/changelog#v0310-2024-10-23/index.html)
| Update | Resources |
| --- | --- |
| 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)](/content/docs/shipping/changelog#v0300-2024-09-25/index.html)
| Update | Resources |
| --- | --- |
| Added `expected_delivery_date` for calculate rates. | POST /rates |
## [v0.29.0 (2024-08-01)](/content/docs/shipping/changelog#v0290-2024-08-01/index.html)
| Update | Resources |
| --- | --- |
| Create label field `invoice.signature_name`, `invoice.declaration_statement` applies to DHL Express. | POST /labels |
## [v0.28.0 (2024-07-11)](/content/docs/shipping/changelog#v0280-2024-07-11/index.html)
| Update | Resources |
| --- | --- |
| Added `neutral_description_label` in service option - general type. | POST /labels
POST /rates |
## [v0.27.0 (2024-06-19)](/content/docs/shipping/changelog#v0270-2024-06-19/index.html)
| Update | Resources |
| --- | --- |
| Added `non-merchandise` value in label customs purpose. | POST /labels |
## [v0.26.0 (2024-06-04)](/content/docs/shipping/changelog#v0260-2024-06-04/index.html)
| Update | Resources |
| --- | --- |
| Create label field `customs.additional_charges` applies to DHL and UPS. | POST /labels |
## [v0.25.0 (2024-01-13)](/content/docs/shipping/changelog#v0250-2024-01-13/index.html)
| Update | Resources |
| --- | --- |
| Added `packing_slip` field in label response files. | GET /labels
POST /labels
GET /labels/:id |
## [v0.24.0 (2023-10-19)](/content/docs/shipping/changelog#v0240-2023-10-19/index.html)
| Update | Resources |
| --- | --- |
| Added `return_reason` param in label shipment item. | POST /labels |
## [v0.23.0 (2023-09-28)](/content/docs/shipping/changelog#v0230-2023-09-28/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [pandago](https://pandago.ph/).
Please check all supported carriers [here](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id
GET /cancel-labels
POST /cancel-labels
GET /cancel-labels/:id |
| Added new carrier [porter-express](https://porterex.com/).
Please check all supported carriers [here](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id
GET /cancel-labels
POST /cancel-labels
GET /cancel-labels/:id |
## [v0.22.0 (2023-09-21)](/content/docs/shipping/changelog#v0220-2023-09-21/index.html)
| Update | Resources |
| --- | --- |
| We are pleased to announce the addition of **pickups API** and **cancel-pickups API** support | POST /pickups
GET /pickups
GET /pickups/:id
POST /cancel-pickups
GET /cancel-pickups
GET /cancel-pickups/:id |
## [v0.21.0 (2023-08-28)](/content/docs/shipping/changelog#v0210-2023-08-28/index.html)
| Update | Resources |
| --- | --- |
| 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)](/content/docs/shipping/changelog#v0200-2023-08-24/index.html)
| Update | Resources |
| --- | --- |
| 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)](/content/docs/shipping/changelog#v0190-2023-08-17/index.html)
| Update | Resources |
| --- | --- |
| 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)](/content/docs/shipping/changelog#v0180-2023-07-13/index.html)
| Update | Resources |
| --- | --- |
| 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)](/content/docs/shipping/changelog#v0170-2023-07-06/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [gls-us](https://www.gls-us.com/).
Please check all supported carriers [here](/content/shipping/carriers/index.html). | 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)](/content/docs/shipping/changelog#v0160-2023-06-08/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [lbcexpress](https://www.lbcexpress.com/).
Please check all supported carriers [here](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id |
## [v0.15.0 (2023-04-28)](/content/docs/shipping/changelog#v0150-2023-04-28/index.html)
| Update | Resources |
| --- | --- |
| We are pleased to announce the addition of get locations API support | GET /locations |
## [v0.14.0 (2023-04-27)](/content/docs/shipping/changelog#v0140-2023-04-27/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [team-global-express](https://teamglobalexp.com/).
Please check all supported carriers [here](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id |
## [v0.13.0 (2023-03-16)](/content/docs/shipping/changelog#v0130-2023-03-16/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [tnt-it](https://www.tnt.it/).
Please check all supported carriers [here](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id |
## [v0.12.0 (2023-03-03)](/content/docs/shipping/changelog#v0120-2023-03-03/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [evri](https://www.evri.com/).
Please check all supported carriers [here](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id |
## [v0.11.0 (2023-02-22)](/content/docs/shipping/changelog#v0110-2023-02-22/index.html)
| Update | Resources |
| --- | --- |
| 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)](/content/docs/shipping/changelog#v0100-2023-02-20/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [t-cat](https://www.t-cat.com.tw/default.aspx). 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](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id |
## [v0.9.0 (2022-12-28)](/content/docs/shipping/changelog#v090-2022-12-28/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [thecourierguy](https://www.thecourierguy.co.za/). 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](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id |
## [v0.8.0 (2022-12-23)](/content/docs/shipping/changelog#v080-2022-12-23/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [kerry-express-tw](https://www.kerryexpress.com.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](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id |
## [v0.7.0 (2022-12-16)](/content/docs/shipping/changelog#v070-2022-12-16/index.html)
| Update | Resources |
| --- | --- |
| Supported to create return label from existing order. | GET /labels
POST /labels
GET /labels/:id |
## [v0.6.0 (2022-11-11)](/content/docs/shipping/changelog#v060-2022-11-11/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [tnt-au](https://www.tnt.com/express/en_au/site/home.html). We’ve been delivering our customers’ promises for over 70 years. Find out more about TNT.
Please check all supported carriers [here](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id |
## [v0.5.0 (2022-09-23)](/content/docs/shipping/changelog#v050-2022-09-23/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [uber](https://www.uberfreight.com/). 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](/content/shipping/carriers/index.html).
Added rule-based label API 1.0 | GET /labels
POST /labels
GET /labels/:id |
## [v0.4.0 (2022-09-16)](/content/docs/shipping/changelog#v040-2022-09-16/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [lalamove](https://www.lalamove.com/en-ph/). 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](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id |
## [v0.3.0 (2022-07-08)](/content/docs/shipping/changelog#v030-2022-07-08/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [taqbin-sg](https://www.yamatosingapore.com/uat/courier/ta-q-bin/). 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](/content/shipping/carriers/index.html). | GET /labels
POST /labels
GET /labels/:id |
## [v0.2.0 (2022-06-23)](/content/docs/shipping/changelog#v020-2022-06-23/index.html)
| Update | Resources |
| --- | --- |
| Added new carrier [singapore-post](https://www.singpost.com/). 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](/content/shipping/carriers/index.html).
Updated API for yunexpress | GET /labels
POST /labels
GET /labels/:id |
## [v0.1.0 (2022-05-19)](/content/docs/shipping/changelog#v010-2022-05-19/index.html)
| Update | Resources |
| --- | --- |
| First release | - |