List item amendments
Lists every amendment of an order item.
Lists every amendment of an order item.
Returns the whole list as an array, without paging. Each amendment has id, orderItemId,
status, productType, createdAt, amountToPay and amountToRefund. An item
of another partner, or an unknown id, returns 404 with code 10004.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
id*stringOrder item id (items[].id from the order response).
uuidOK
- response
[index: integer]?An amendment of an order item.
curl -X GET 'https://api.sandbox.openroam.com/v1/order-items/01a1432e-7121-7b0e-a0a0-c35454d3b883/amendments'[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orderItemId": "33207bce-c741-4896-a76b-8afcf6e4179a", "status": "pending", "productType": "esim", "createdAt": "2019-08-24T14:15:22Z", "amountToPay": { "amount": 0, "currency": "string" }, "amountToRefund": { "amount": 0, "currency": "string" } }]Get an amendment GET
Gets one amendment of an order item. Returns the same fields as the amendment list. An unknown amendment, or one that belongs to another item or partner, returns `404` with code `10004`.
Get an order item GET
Gets an order item: what was bought, its delivery, its refund and what you can do next. Requires the `read` order permission. Returns the item exactly as it appears in `items[]` of the order response, including `orderId`, the order it belongs to. `fulfillment.status` and `refund.status` give its state; `actions.cancellation` says whether it can be cancelled now, `actions.amendment` whether it can be amended and `actions.update` whether it can be updated. An item of another partner, or an unknown id, returns `404` with code `10004`; a malformed id or an unknown query parameter returns `400` with code `10001`.