List exchanges
GET/exchanges
The exchanges recorded at the outlet in X-Outlet-ID, newest first, including those made in the cashier app. Pages are keyset-based.
- Send
order_idto list only the exchanges of one order (an order can have more than one). - A
cursoris only valid with the samelimit, the sameorder_idand the same endpoint. - Needs a plan with exchanges.
Errors
| Status | Code | When |
|---|---|---|
| 400 | INVALID_CURSOR | The cursor came with another limit, another order_id or another endpoint. |
| 400 | VALIDATION_FAILED | order_id is not a UUID. |
| 403 | PLAN_FEATURE_REQUIRED | The plan has no exchanges. data.reason is not_in_plan or disabled (the merchant can turn it on in Settings > Features), and data.feature is the feature key. A missing Public API add-on answers the same code without data. |
Request
Responses
- 200
- 400
- 401
- 403
Exchanges
Error envelope
Error envelope
Error envelope