Skip to Content
OpenRoam Docs
Order items

List item amendments

Lists every amendment of an order item.

GET
/v1/order-items/{id}/amendments

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.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Path Parameters

id*string

Order item id (items[].id from the order response).

Formatuuid

Response Body

OK

  1. response
[index: integer]?

An amendment of an order item.

Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/order-items/01a1432e-7121-7b0e-a0a0-c35454d3b883/amendments'
Example Response
[  {    "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"    }  }]