Response headers and paging limits in the reference
2026-11-18 · Not breaking · Upcoming: not yet in production
The reference now declares the response headers Location and Idempotent-Replayed and the default
and largest page size of every list, as the API already sends and applies them.
What changed
Locationis declared on the 201 ofPOST /api/v1/orders,POST /api/v1/orders/{id}/lines,POST /api/v1/orders/{id}/shipments,POST /api/v1/orders/{id}/shipments/{shipmentId}/void,POST /api/v1/fulfillment/nodesandPOST /api/v1/webhooks, and on the 409order-already-existsofPOST /api/v1/orders.Idempotent-Replayed: trueis declared on the 201 ofPOST /api/v1/orders,POST /api/v1/orders/{id}/shipments,POST /api/v1/orders/{id}/shipments/{shipmentId}/void,POST /api/v1/orders/{id}/lines/{lineId}/cancellations,POST /api/v1/orders/{id}/lines/{lineId}/returns,POST /api/v1/orders/{id}/payment-facts,POST /api/v1/orders/{id}/parcels/{parcelId}/tracking-eventsandPOST /api/v1/fulfillment/nodes. It is sent only when a request with the sameIdempotency-Keyand body is answered again, never on the 200 for a fact that was already reported.offsetandlimitofGET /api/v1/fulfillment/nodes,GET /api/v1/orders/{id}/shipmentsandGET /api/v1/orders/{id}/parcels/{parcelId}/tracking-eventsdeclare their default and maximum; alimitabove the maximum gives 400, as before.pageSizeofGET /api/v1/ordersandGET /api/v1/orders/{id}/timelineandlimitofGET /api/v1/orders/stats/top-articlesdeclare their default and maximum, and their descriptions say that a larger value is clamped to the maximum, as before.pageandpageSizeofGET /api/v1/orders/{orderId}/webhook-deliveriesandGET /api/v1/webhooks/{webhookId}/deliveriesdeclare their default.- The webhook operations describe the signature, the headers, the retries and the payload of a delivery, as the webhooks guide does.
- Nothing you send or read changes.
Affected operations
- Every operation named under What changed, in the reference only.
What you do
- Nothing. A client generated from the reference can now read
LocationandIdempotent-Replayedand knows the page sizes.