Skip to Content
OpenRoam Docs
Orders

Get fulfillment status

Gets the current fulfillment state of every item in an order.

GET
/v1/orders/{orderId}/fulfillment/status

Gets the current fulfillment state of every item in an order.

Returns the order id, its items (the same item shape as the order, with each item's fulfillment status, typed result and failure) and fulfillmentVersion. The version increases with every meaningful fulfillment change, including a later revision of an already delivered result, the cancellation of a delivered item and the completed refund of a delivered item, which changes the order's status, and matches fulfillmentVersion in the order.fulfillment.updated webhook: keep the highest version you have seen and use this endpoint to recover after a missed delivery. The refund of an item that was not delivered and an amendment do not change the version; read the order for those. An order 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

orderId*string

Order id.

Formatuuid

Response Body

OK

  1. response

The current fulfillment state of an order's items.

id*string

Order id.

Formatuuid
items*array<|||||>

The order items with their fulfillment.

fulfillmentVersion*integer

Increases with every fulfillment change; matches the order.fulfillment.updated webhook.

Formatint64
Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/orders/01a1432e-7121-7b0e-a0a0-c35454d3b883/fulfillment/status'
Example Response
{  "id": "01a1432e-7121-7b0e-a0a0-c35454d3b883",  "items": [    {      "id": "01a1432e-7121-70bc-800a-3f896e23b7c8",      "orderId": "01a1432e-7121-7b0e-a0a0-c35454d3b883",      "productType": "airtime",      "price": {        "amount": 25,        "currency": "USD"      },      "purchasedProduct": {        "name": "Test operator 40 AZN",        "countryCode": "AZ",        "logoUrl": "https://cdn.openroam.test/airtime/test-operator.png",        "value": {          "amount": 40,          "currency": "AZN"        },        "inputs": {          "phoneNumber": "+994***4567",          "minDeliveredValue": null        },        "details": {          "redemptionType": "directTopUp",          "estimatedDeliveredValue": {            "amount": 40,            "currency": "AZN"          },          "readMore": "Credit arrives within minutes."        }      },      "fulfillment": {        "status": "fulfilled",        "result": {          "deliveredValue": {            "amount": 40,            "currency": "AZN"          },          "details": {            "redemption": {              "type": "directTopUp",              "pin": null,              "instructions": null            }          }        },        "failure": null      },      "actions": {        "amendment": {          "availability": "notAvailable",          "reason": null        },        "cancellation": {          "availability": "notAvailable",          "reason": null        },        "update": {          "availability": "notAvailable",          "reason": null        }      },      "createdAt": "2026-10-16T05:27:59.521962Z",      "effectivePaidAmount": {        "amount": 25,        "currency": "USD"      }    },    {      "id": "01a1432e-7121-7829-a554-d8e2b22270c6",      "orderId": "01a1432e-7121-7b0e-a0a0-c35454d3b883",      "productType": "airtime",      "price": {        "amount": 31.25,        "currency": "USD"      },      "purchasedProduct": {        "name": "Test operator 50 AZN",        "countryCode": "AZ",        "logoUrl": "https://cdn.openroam.test/airtime/test-operator.png",        "value": {          "amount": 50,          "currency": "AZN"        },        "inputs": {          "phoneNumber": "+994***4567",          "minDeliveredValue": null        },        "details": {          "redemptionType": "directTopUp",          "estimatedDeliveredValue": {            "amount": 50,            "currency": "AZN"          },          "readMore": "Credit arrives within minutes."        }      },      "fulfillment": {        "status": "fulfilled",        "result": {          "deliveredValue": {            "amount": 50,            "currency": "AZN"          },          "details": {            "redemption": {              "type": "directTopUp",              "pin": null,              "instructions": null            }          }        },        "failure": null      },      "actions": {        "amendment": {          "availability": "notAvailable",          "reason": null        },        "cancellation": {          "availability": "notAvailable",          "reason": null        },        "update": {          "availability": "notAvailable",          "reason": null        }      },      "createdAt": "2026-10-16T05:27:59.521962Z",      "effectivePaidAmount": {        "amount": 31.25,        "currency": "USD"      }    }  ],  "fulfillmentVersion": 2}

Preview an order cancellation GET

Previews cancelling every item of an order now, with the totals. Requires the `read` order permission. Returns `{ orderId, currency, items, totals }`, every amount in the order currency. Each item has `orderItemId`, `productType` and `status`. `previewable` items carry `preview`, the same payload as `GET order-items/{id}/cancellation-preview` (`isRefundable: false` included). An item whose `actions.cancellation` is `available` is `previewable`, unless its refund failed; a rejected one previews a full refund with no penalty. `notCancellable` items carry a `reason`: `notFulfilled` (not delivered: unpaid, still being delivered, or rejected while its outcome is confirmed), `refunded`, `refundInProgress` (a refund was started and has not finished, or it failed and cancelling the item retries it), `amendmentInProgress`, `manualReview` (contact support) or `notAllowed` (the product's rules do not allow cancelling it now). `totals` sums `penaltyAmount`, `cancellationFee` and `refundAmount` over the `previewable` items; `totals.isComplete` is `true` only when every item is `previewable`. The preview cancels nothing, changes no state and locks no amount: cancelling an item prices its cancellation again. Only an item the item preview refuses is `notAllowed`: a booking system that cannot answer right now fails this whole call, with `503` when it is unavailable, as it fails the item preview. Retry later. An order of another partner, or an unknown id, returns `404` with code `10004`.

Quote an order POST

Prices a mixed order body with current prices, without placing an order. Takes the same body as order creation (one to five items of one or several product types, a total quantity of at most five) and needs no `Idempotency-Key`. Nothing is charged, held or created; `referenceId` is checked for its format and not for uniqueness. Returns `currency`, `items`, `total` and `expiresAt`. Each item is the quote item that its product's own quote route returns, with `productType`; its `publicId` can be a new one (gift cards, hotels and flights issue one), so order with the `publicId` of the quote. `total` is the sum of each item's `price` times its `quantity` in the quote currency. `expiresAt` is the earliest `details.expiresAt` of the items that have one, and `null` when none has. Items are checked as the order checks them: first the `inputs` of every item, then the offer of every item, then each item is priced in request order. The first failing item ends the quote with the code and path of its product's quote route, under `items[i]`, for example `409` / `11002` at `items[i].inputs.maxPrice` when the current price is above the guard. An eSIM top-up whose `inputs.iccid` is not one of your eSIMs returns `404` with code `10004` (`NOT_FOUND`). A quote does not reserve a price: to hold the quoted price, send it as `inputs.maxPrice` in the order.