Release Notes

September 2026

BETA: Added the orderItem.cancelled.3 webhook, emitted when an order item is cancelled.
BETA: Added the shipment-tracking webhook, initially named shipment.tracking.3 and subsequently renamed to tracking.updated.3. Its payload includes normalized status and optional carrier sub-status information.

Return merchandise authorizations are production-ready: POST /v3/returnMerchandiseAuthorizations, GET /v3/returnMerchandiseAuthorizations/{id}, PUT /v3/returnMerchandiseAuthorizations/{id}, and DELETE /v3/returnMerchandiseAuthorizations/{id}. Request payloads exclude server-managed status and timestamps.
GET /v3/stockMutations responses include attributes.quarantine when a mutation places stock in quarantine.
Webhook event names use the .3 suffix, for example inbound.processed.3.

Added GET /settings/get, which returns the authenticated client's current settings.

BETA: Added return authorization operations: POST /v3/returnAuthorizations, GET /v3/returnAuthorizations/{id}, PUT /v3/returnAuthorizations/{id}, and DELETE /v3/returnAuthorizations/{id}. They were renamed and released for general use in July.
JSON:API endpoints accept application/json as well as application/vnd.api+json.
shipment.created.3 and shipment.readyToPick.3 webhooks are publicly available.
Webhook deliveries include X-Hook0-Signature for payload verification and X-Hook0-EventId for duplicate-delivery detection.

GET /v3/orders and GET /v3/shipments support filter[reference][in] to find resources by order reference.
Order-item prices may be negative.
Shipment tracking information includes the carrier.

Added public inbound webhooks: inbound.processing, inbound.checking, inbound.checkingUpdate, inbound.checked, and inbound.processed. These event names were updated to use the .3 suffix in July 2026.

Added POST /v3/products/{id}/image for product images. The image field was removed from product create and update payloads.

GET /v3/shipments and GET /v3/shipments/{id} expose shipment status and the readyToPickOn and readyToShipOn timestamps.

GET /v3/stockMutations became publicly available.
v2 deprecation: Migrate GET /v2/stockmutation/get and POST /v2/stockmutation/sync to GET /v3/stockMutations; v3 does not require syncing.
Published the public v3 endpoint documentation for authentication and status; orders, order items and attachments; shipments; inbounds and inbound packing slips; products; return items; stock and stock levels; and webhook management. The initial public webhook events were shipment.readyToShip.3 and shipment.shipped.3.
v2 deprecation: Migrate POST /order/add, GET /v2/order/search, and POST /order/search to POST /v3/orders and GET /v3/orders.
v2 deprecation: Migrate the legacy shipment retrieval and sync endpoints (/v2/shipment/* and POST /shipment/search) to GET /v3/shipments or GET /v3/shipments/{id}. V3 does not require sync operations.
v2 deprecation: Migrate product endpoints (POST /product/add, POST /product/edit, POST /product/search, and GET /v2/product/search) to the /v3/products endpoints.
v2 deprecation: Migrate stock endpoints (GET /stock/get/{sku}, GET /stock/bulk/{all}, GET /v2/stock/get/{sku}, and GET /v2/stock/bulk) to GET /v3/stock; filter by SKU where needed.
v2 deprecation: Migrate POST /v2/returnitem/get to GET /v3/returnItems.