Changelog
Back to All

v1.024

1 day ago

carrier fields now document the known set of carrier names.
The carrier field returned on orders' shipment data and on the Shipment Notification webhook payload now documents its possible values as an enum of known carrier display names, instead of an unconstrained string. The field remains open to any string value: shipments using custom labels or freight carriers can still report a carrier name outside of the documented list. This is a documentation-only, additive change — no existing value is rejected or removed.

🚀 New Endpoints

None

🛠 Schema & Property Updates

  • Retrieve List of Orders / Get Order (shipment data carrier field) and the Shipment Notification webhook carrier field now validate as Custom_PublicApi_Enum_CarrierIdentifier (one of CanadaPost, Cirro, DHL eCommerce, DHL Express, DPD, FedEx, Global-E, International Bridge, OnTrac, Passport, Royal Mail, ShipMonk, SpeedX, UPS, USPS) or any other string, so custom/freight carrier names keep working unchanged.

📦 New Support Schemas

  • Custom_PublicApi_Enum_CarrierIdentifier — a new enum schema listing the known, non-deprecated carrier display names. It mirrors the carrier table already documented on the Shipment Notification webhook, so both stay in sync automatically.

📖 Documentation & Constraints Changes

  • The Shipment Notification webhook's carrier table now also lists International Bridge, which had been added to the list of supported carriers but was missing from the documented table.

No endpoints, fields, or required-status were removed or changed — fully backward-compatible.