Changelog

Announcements of changes to the partner API. A breaking change takes effect at least 60 days after its date, under a new path version.

2026-11-04 (v1, compatible)

Clarification of catalogue update times, replacing the earlier "refreshed at least every 30 minutes": stock changes normally appear in /catalog/changes within 5 minutes; price, status, identifiers and attributes are re-read by a catalogue refresh scheduled every 15 minutes; the full snapshot is generated once a day starting at 02:00 UTC. Details on the catalogue page under Update times. No change to endpoints or fields.

2026-11-03 (v1, compatible)

When stock cannot be reserved at the moment an order with a single line is placed, that line is now rejected with out_of_stock instead of the whole attempt coming back not_created. Orders with several lines are unchanged: there the whole attempt can still come back not_created, except when, after other lines were removed for stock, only one line is left to create.

2026-11-03 (v1, compatible)

Clarification: in live, shipments[], tracking_number and the shipped status are provided through the API only when shipping.mode is own_awb. In live with included and flat_fee the API does not move a line beyond confirmed (shipments is an empty list) and tracking reaches you outside the API. The sandbox (test key) always simulates parcels, AWB and shipped, whatever the mode.

2026-11-03 (v1, compatible)

Exception to the compatibility rule, announced on the day it ships (these fields were never documented before): new optional fields ship_to.address2 and ship_to.province. A request that already sent address2 or province with a non-string, blank (spaces only) or over-long value used to have it ignored and is now refused with 400 invalid_request; an address2 that was sent before is now used for the shipment. When the country is US, CA, AU or BR, ship_to.province is required and must be the province code of that country (for example CA, ON, NSW or SP; Puerto Rico and the other US territories are sent as country US with their code in province): otherwise the order is refused with 400 invalid_request. This applies to destinations not yet enabled on any account. For other countries province is optional and informational only. Requests that sent neither field are unchanged. The error message for an invalid ship_to.company, zip or phone is reworded ("must be a non-empty string" or "must be at most 255 characters"); its code and status are unchanged.

2026-11-03 (v1, compatible)

New endpoint GET /v1/account/profile returns your configuration: environment, currency, extra fields, shipping mode, allowed countries and limits. Orders to a destination outside allowed_countries are refused with 422 destination_not_allowed.

2026-11-03 (v1, compatible)

Public documentation published at /partner/docs, with an OpenAPI description, raw Markdown pages, llms.txt and this changelog.