Breaking Changes
Take action
If you are using any deprecated endpoints below, migrate to the recommended replacements.
The Carriyo Shipping API is constantly evolving. Although most of our changes are backwards compatible, we sometimes deprecate endpoints and attributes that we no longer intend to support, in favour of newer and better replacements.
Deprecated Endpoints
The following Shipping API endpoints are deprecated and may be removed in a future release.
| Deprecated Endpoint | Replaced By |
|---|---|
POST /shipments/shipment-id/reassign |
POST /shipments/shipment-id/reprocess |
PATCH /shipments/shipment-id/cancel |
POST /shipments/shipment-id/cancel |
PATCH /shipments/shipment-id/status |
POST /shipments/shipment-id/update-status |
PATCH /shipments/shipment-id/ready-to-ship |
POST /shipments/shipment-id/ready-to-ship |
New Mandatory Attributes
The following attributes are important for Create Shipment requests. To avoid validation issues and ensure predictable behavior, we recommend always passing these attributes explicitly.
| Mandatory Attribute | Description |
|---|---|
shipment.merchant |
The merchant attribute will be mandatory and will no longer be defaulted if this value is not passed. |
shipment.references.partner_shipment_reference |
The partner_shipment_reference will be mandatory and no longer be defauled from the partner_order_reference |