Shipment to Shipping API migration guide
Shipment is becoming shipping. Old keys and paths are deprecated and will be removed in October 2026
shipment previously represented two different things: the customer's shipping selection (method, contact, address) and a concrete outbound shipment (tracking code, carrier, weight, dispatch date). Ahead of the dedicated shipping module, we've made this distinction clear.
As part of the same change, dispatchDate on shipping payloads has been renamed to expectedDispatchDate, differentiating it from the concrete dispatch date which will be attached to a concrete shipment.
The old shipment names still work today but are deprecated and will be removed in October 2026. Every row below is a straight find-and-replace.
| Old | New |
|---|---|
/api/manufacturer/v1/shipment, /shipment/{id}, /shipment/rates | /api/manufacturer/v1/shipping, /shipping/{id}, /shipping/rates |
PATCH /api/manufacturer/v1/order/{id}/shipment | PATCH /api/manufacturer/v1/order/{id}/shipping |
GET /api/manufacturer/v1/tracking?shipmentId= | GET /api/manufacturer/v1/tracking?shippingId= |
order.shipment, quote.shipment, activity.shipment | order.shipping, quote.shipping, activity.shipping |
quote.dispatchDate, shipping.dispatchDate | quote.expectedDispatchDate, shipping.expectedDispatchDate |
tracking.shipmentId, and shipmentId when creating tracking | tracking.shippingId, shippingId |
You are done once your integration reads and sends no shipment, shipmentId, or dispatchDate key and calls no /shipment path.
Last updated on