{"openapi":"3.2.0","info":{"title":"OpenRoam Partner API","description":"Official OpenRoam Partner API client: eSIMs, airtime, utility payments, gift cards, hotels and flights.","contact":{"name":"OpenRoam Support","email":"support@openroam.com"},"version":"v1"},"servers":[{"url":"https://api.sandbox.openroam.com","description":"Sandbox"},{"url":"https://api.openroam.com","description":"Production"}],"paths":{"/v1/account/services":{"get":{"tags":["Account"],"summary":"List account services","description":"Lists every service OpenRoam sells through the Partner API, with whether the account may sell it.\n\nReturns `{ services }`, one entry per service, ordered by `productType`, without paging. Each entry is\n`{ productType, enabled, requestable }`. `enabled` is `true` when the account may search, quote\nand order the service now; any other request that sells it returns `403` with code `10003`.\n`requestable` is `true` when the account can ask OpenRoam to enable the service; an enabled service is\nnever requestable. A service OpenRoam does not offer at the moment is not listed. The endpoint takes no query\nparameters; an unknown parameter returns `400` with code `10001`.","operationId":"accountGetServices","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AccountServiceList"}},"application/json":{"schema":{"$ref":"#/components/schemas/AccountServiceList"}},"text/json":{"schema":{"$ref":"#/components/schemas/AccountServiceList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Account"}},"/v1/airtime/catalog":{"get":{"tags":["Airtime"],"summary":"Airtime catalog","description":"Returns the operator directory, page by page, for partner inventory.\n\nReturns `{ items: [{ id, name, countryCode, category, logoUrl }], nextCursor }`, ordered by operator ID.\nPass `nextCursor` back as `cursor` with the same `countryCode` until it is null; a page can hold\nfewer items than `limit`, and the cursor does not expire. A cursor reused with another `countryCode`,\nor a blank or invalid `countryCode`, gives 400 / 10001. Offers are not exported: they depend on whether\nthe operator is detected or chosen, so read them with `operators/{id}?phoneNumber=`.","operationId":"airtimeCatalog","parameters":[{"name":"countryCode","in":"query","description":"Optional ISO 3166-1 alpha-2 country filter, in either case; every country when omitted. A blank or invalid value gives 400 / 10001.","schema":{"type":"string"},"examples":{"default":{"value":"AZ"}}},{"name":"cursor","in":"query","description":"The `nextCursor` of the previous page; omit it for the first page. Reuse it only with the same `countryCode`.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 100.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AirtimeCatalogPage"}},"application/json":{"schema":{"$ref":"#/components/schemas/AirtimeCatalogPage"}},"text/json":{"schema":{"$ref":"#/components/schemas/AirtimeCatalogPage"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Airtime"}},"/v1/airtime/search":{"get":{"tags":["Airtime"],"summary":"Search airtime by phone number","description":"Searches for a phone number's operator by carrier lookup and returns it with its offers (detected flow).\n\nReturns `{ items, pagination, details: { phoneLookup: { status, carrierName, countryCode } } }`.\n`items` holds at most the detected operator with its offers. It is empty when `status` is not\n`detected` or no offer remains after the filters; then let the customer choose the operator with\n`GET operators?countryCode=`, using `details.phoneLookup.countryCode`. Each call makes exactly one\ncarrier lookup and returns at most one item, so `page` must be 1. A `phoneNumber` that is not in\ninternational format gives 400 / 10001; a carrier lookup that fails gives 503 / 10007, retry later.","operationId":"airtimeSearch","parameters":[{"name":"phoneNumber","in":"query","description":"The recipient's number in international format, starting with + or 00; spaces, hyphens and parentheses are allowed.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"+994501234567"}}},{"name":"valueType","in":"query","description":"Keep only `fixed` or only `range` offers.","schema":{"enum":["fixed","range"],"type":"string"},"examples":{"default":{"value":"range"}}},{"name":"valueCurrency","in":"query","description":"Currency of `minValue` and `maxValue`, three letters; required with either of them.","schema":{"type":"string"},"examples":{"default":{"value":"AZN"}}},{"name":"minValue","in":"query","description":"Keep the offers whose value reaches at least this amount, in `valueCurrency`.","schema":{"type":"number","format":"decimal"},"examples":{"default":{"value":10}}},{"name":"maxValue","in":"query","description":"Keep the offers whose value starts at or below this amount, in `valueCurrency`.","schema":{"type":"number","format":"decimal"},"examples":{"default":{"value":200}}},{"name":"minPrice","in":"query","description":"Keep the offers whose indicative price reaches at least this amount, in the price currency.","schema":{"type":"number","format":"decimal"},"examples":{"default":{"value":5}}},{"name":"maxPrice","in":"query","description":"Keep the offers whose indicative price starts at or below this amount, in the price currency. A filter, not the `inputs.maxPrice` limit of a purchase.","schema":{"type":"number","format":"decimal"},"examples":{"default":{"value":130}}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}},{"name":"page","in":"query","description":"Must be 1: search returns at most one operator.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":1}}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 10.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AirtimeSearchResult"},"examples":{"detectedOperator":{"summary":"The number's operator, with a fixed-amount offer and a range offer.","value":{"items":[{"id":"operator_tq7vbm2xk4hdn6wzr3pyjc5fae","name":"Test operator","countryCode":"AZ","category":null,"logoUrl":"https://cdn.openroam.test/airtime/test-operator.png","description":null,"offers":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","name":"Test operator 40 AZN","description":"Top-up for **Test operator** numbers.","value":{"type":"fixed","amount":40,"currency":"AZN"},"price":{"amount":25,"currency":"USD"},"requiredInputs":[{"name":"phoneNumber","type":"phone","required":true,"description":"The recipient's mobile number in international format, starting with + or 00."}],"details":{"redemptionType":"directTopUp","readMore":"Credit arrives within minutes."}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","name":"Test operator 10 - 200 AZN","description":"Top-up for **Test operator** numbers.","value":{"type":"range","min":10,"max":200,"step":0.01,"currency":"AZN"},"price":{"min":6.25,"max":125,"currency":"USD"},"requiredInputs":[{"name":"phoneNumber","type":"phone","required":true,"description":"The recipient's mobile number in international format, starting with + or 00."}],"details":{"redemptionType":"directTopUp","readMore":"Credit arrives within minutes."}}]}],"pagination":{"currentCount":1,"totalCount":1,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1},"details":{"phoneLookup":{"status":"detected","carrierName":"Test operator","countryCode":"AZ"}}}},"operatorNotInCatalog":{"summary":"The number's carrier is not sold: no items. Pick an operator of the country instead.","value":{"items":[],"pagination":{"currentCount":0,"totalCount":0,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":0},"details":{"phoneLookup":{"status":"notInCatalog","carrierName":"Unmapped operator","countryCode":"AZ"}}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/AirtimeSearchResult"},"examples":{"detectedOperator":{"summary":"The number's operator, with a fixed-amount offer and a range offer.","value":{"items":[{"id":"operator_tq7vbm2xk4hdn6wzr3pyjc5fae","name":"Test operator","countryCode":"AZ","category":null,"logoUrl":"https://cdn.openroam.test/airtime/test-operator.png","description":null,"offers":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","name":"Test operator 40 AZN","description":"Top-up for **Test operator** numbers.","value":{"type":"fixed","amount":40,"currency":"AZN"},"price":{"amount":25,"currency":"USD"},"requiredInputs":[{"name":"phoneNumber","type":"phone","required":true,"description":"The recipient's mobile number in international format, starting with + or 00."}],"details":{"redemptionType":"directTopUp","readMore":"Credit arrives within minutes."}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","name":"Test operator 10 - 200 AZN","description":"Top-up for **Test operator** numbers.","value":{"type":"range","min":10,"max":200,"step":0.01,"currency":"AZN"},"price":{"min":6.25,"max":125,"currency":"USD"},"requiredInputs":[{"name":"phoneNumber","type":"phone","required":true,"description":"The recipient's mobile number in international format, starting with + or 00."}],"details":{"redemptionType":"directTopUp","readMore":"Credit arrives within minutes."}}]}],"pagination":{"currentCount":1,"totalCount":1,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1},"details":{"phoneLookup":{"status":"detected","carrierName":"Test operator","countryCode":"AZ"}}}},"operatorNotInCatalog":{"summary":"The number's carrier is not sold: no items. Pick an operator of the country instead.","value":{"items":[],"pagination":{"currentCount":0,"totalCount":0,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":0},"details":{"phoneLookup":{"status":"notInCatalog","carrierName":"Unmapped operator","countryCode":"AZ"}}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/AirtimeSearchResult"},"examples":{"detectedOperator":{"summary":"The number's operator, with a fixed-amount offer and a range offer.","value":{"items":[{"id":"operator_tq7vbm2xk4hdn6wzr3pyjc5fae","name":"Test operator","countryCode":"AZ","category":null,"logoUrl":"https://cdn.openroam.test/airtime/test-operator.png","description":null,"offers":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","name":"Test operator 40 AZN","description":"Top-up for **Test operator** numbers.","value":{"type":"fixed","amount":40,"currency":"AZN"},"price":{"amount":25,"currency":"USD"},"requiredInputs":[{"name":"phoneNumber","type":"phone","required":true,"description":"The recipient's mobile number in international format, starting with + or 00."}],"details":{"redemptionType":"directTopUp","readMore":"Credit arrives within minutes."}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","name":"Test operator 10 - 200 AZN","description":"Top-up for **Test operator** numbers.","value":{"type":"range","min":10,"max":200,"step":0.01,"currency":"AZN"},"price":{"min":6.25,"max":125,"currency":"USD"},"requiredInputs":[{"name":"phoneNumber","type":"phone","required":true,"description":"The recipient's mobile number in international format, starting with + or 00."}],"details":{"redemptionType":"directTopUp","readMore":"Credit arrives within minutes."}}]}],"pagination":{"currentCount":1,"totalCount":1,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1},"details":{"phoneLookup":{"status":"detected","carrierName":"Test operator","countryCode":"AZ"}}}},"operatorNotInCatalog":{"summary":"The number's carrier is not sold: no items. Pick an operator of the country instead.","value":{"items":[],"pagination":{"currentCount":0,"totalCount":0,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":0},"details":{"phoneLookup":{"status":"notInCatalog","carrierName":"Unmapped operator","countryCode":"AZ"}}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Airtime"}},"/v1/airtime/number-lookup":{"get":{"tags":["Airtime"],"summary":"Look up a phone number","description":"Describes a phone number and returns its carrier from a carrier lookup when the number is valid.\n\nDescribes the number from numbering-plan data and, for a valid number, adds carrier information from a live\ncarrier lookup. A number without the international shape gives 400 / 10001; a number its country does not\nassign returns 200 with `isValid: false` and `carrier: null`, without a carrier lookup. Returns\n503 / 10007 when the carrier lookup is unavailable. The carrier is for display only and nothing is stored; use\nsearch to find a sellable operator.","operationId":"airtimeLookupNumber","parameters":[{"name":"phoneNumber","in":"query","description":"The number in international format, starting with + or 00; spaces, hyphens and parentheses are allowed.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"+994501234567"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/NumberLookup"}},"application/json":{"schema":{"$ref":"#/components/schemas/NumberLookup"}},"text/json":{"schema":{"$ref":"#/components/schemas/NumberLookup"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Service Unavailable","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Airtime"}},"/v1/airtime/operators":{"get":{"tags":["Airtime"],"summary":"List airtime operators","description":"Lists the operators of a country that the customer can choose manually (manual flow, step 1).\n\nReturns the complete list, without paging or prices, as\n`{ items: [{ id, name, countryCode, category, logoUrl }] }`, ordered by name. Only operators with an\noffer that can be sold for a chosen operator are listed. An invalid `countryCode` gives 400 / 10001.\nContinue with `operators/{id}?phoneNumber=`.","operationId":"airtimeGetOperators","parameters":[{"name":"countryCode","in":"query","description":"Required ISO 3166-1 alpha-2 country code, in either case, for example the `details.phoneLookup.countryCode` of a search.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"AZ"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AirtimeOperatorList"}},"application/json":{"schema":{"$ref":"#/components/schemas/AirtimeOperatorList"}},"text/json":{"schema":{"$ref":"#/components/schemas/AirtimeOperatorList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Airtime"}},"/v1/airtime/operators/{id}":{"get":{"tags":["Airtime"],"summary":"Get an airtime operator","description":"Returns one operator with its offers for a phone number of its country (manual flow, step 2).\n\nReturns the operator in the item shape that search returns, without a carrier lookup. A number of another\ncountry than the operator's gives 400 / 10001 with `COUNTRY_MISMATCH` at `phoneNumber`. An unknown\nID, including any value that is not an operator ID, or an operator without an orderable offer, gives\n404 / 10004. Offer filters that match none of the operator's offers leave `offers` empty. A manual choice\nis not checked against the number's carrier, so have the customer confirm the operator before ordering.","operationId":"airtimeGetOperator","parameters":[{"name":"id","in":"path","description":"The operator ID (`operator_…`) from the operator list, the catalog or search.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"operator_tq7vbm2xk4hdn6wzr3pyjc5fae"}}},{"name":"phoneNumber","in":"query","description":"The recipient's number in international format, starting with + or 00. It must belong to the operator's country.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"+994501234567"}}},{"name":"valueType","in":"query","description":"Keep only `fixed` or only `range` offers.","schema":{"enum":["fixed","range"],"type":"string"},"examples":{"default":{"value":"range"}}},{"name":"valueCurrency","in":"query","description":"Currency of `minValue` and `maxValue`, three letters; required with either of them.","schema":{"type":"string"},"examples":{"default":{"value":"AZN"}}},{"name":"minValue","in":"query","description":"Keep the offers whose value reaches at least this amount, in `valueCurrency`.","schema":{"type":"number","format":"decimal"},"examples":{"default":{"value":10}}},{"name":"maxValue","in":"query","description":"Keep the offers whose value starts at or below this amount, in `valueCurrency`.","schema":{"type":"number","format":"decimal"},"examples":{"default":{"value":200}}},{"name":"minPrice","in":"query","description":"Keep the offers whose indicative price reaches at least this amount, in the price currency.","schema":{"type":"number","format":"decimal"},"examples":{"default":{"value":5}}},{"name":"maxPrice","in":"query","description":"Keep the offers whose indicative price starts at or below this amount, in the price currency. A filter, not the `inputs.maxPrice` limit of a purchase.","schema":{"type":"number","format":"decimal"},"examples":{"default":{"value":130}}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AirtimeOperator"}},"application/json":{"schema":{"$ref":"#/components/schemas/AirtimeOperator"}},"text/json":{"schema":{"$ref":"#/components/schemas/AirtimeOperator"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Airtime"}},"/v1/airtime/quote":{"post":{"tags":["Airtime"],"summary":"Quote airtime","description":"Prices the order body with current prices, without placing an order.\n\nTakes the same body as order and resolves the number's operator as the order does, with a carrier lookup per\nitem. Each item is priced on its own, in request order; the first failing item aborts the quote and is named at\n`items[i]`, for example 409 / 11002 at `items[i].inputs.maxPrice` when the current price is above\nit. 409 / 20000 means the lookup shows that the offer's operator cannot be the number's: search again. A\ncarrier lookup that fails gives 503 / 10007. A quote reserves nothing and does not expire; to hold the quoted\nprice, send it as `inputs.maxPrice` in the order.","operationId":"airtimeQuote","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AirtimeOrderRequest"}],"description":"The body B2B airtime quote and order both take."},"examples":{"fixedAndRangeOffers":{"summary":"A fixed-amount offer and a range offer, each with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567","maxPrice":{"amount":25,"currency":"USD"}}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","quantity":1,"inputs":{"phoneNumber":"+994501234567","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":31.25,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AirtimeOrderRequest"}],"description":"The body B2B airtime quote and order both take."},"examples":{"fixedAndRangeOffers":{"summary":"A fixed-amount offer and a range offer, each with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567","maxPrice":{"amount":25,"currency":"USD"}}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","quantity":1,"inputs":{"phoneNumber":"+994501234567","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":31.25,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AirtimeOrderRequest"}],"description":"The body B2B airtime quote and order both take."},"examples":{"fixedAndRangeOffers":{"summary":"A fixed-amount offer and a range offer, each with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567","maxPrice":{"amount":25,"currency":"USD"}}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","quantity":1,"inputs":{"phoneNumber":"+994501234567","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":31.25,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AirtimeQuote"},"examples":{"twoOffers":{"summary":"The prices of the two offers and their total.","value":{"currency":"USD","items":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"name":"Test operator 40 AZN","value":{"amount":40,"currency":"AZN"},"price":{"amount":25,"currency":"USD"},"details":{"estimatedDeliveredValue":{"amount":40,"currency":"AZN"}}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","quantity":1,"name":"Test operator 50 AZN","value":{"amount":50,"currency":"AZN"},"price":{"amount":31.25,"currency":"USD"},"details":{"estimatedDeliveredValue":{"amount":50,"currency":"AZN"}}}],"total":{"amount":56.25,"currency":"USD"}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/AirtimeQuote"},"examples":{"twoOffers":{"summary":"The prices of the two offers and their total.","value":{"currency":"USD","items":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"name":"Test operator 40 AZN","value":{"amount":40,"currency":"AZN"},"price":{"amount":25,"currency":"USD"},"details":{"estimatedDeliveredValue":{"amount":40,"currency":"AZN"}}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","quantity":1,"name":"Test operator 50 AZN","value":{"amount":50,"currency":"AZN"},"price":{"amount":31.25,"currency":"USD"},"details":{"estimatedDeliveredValue":{"amount":50,"currency":"AZN"}}}],"total":{"amount":56.25,"currency":"USD"}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/AirtimeQuote"},"examples":{"twoOffers":{"summary":"The prices of the two offers and their total.","value":{"currency":"USD","items":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"name":"Test operator 40 AZN","value":{"amount":40,"currency":"AZN"},"price":{"amount":25,"currency":"USD"},"details":{"estimatedDeliveredValue":{"amount":40,"currency":"AZN"}}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","quantity":1,"name":"Test operator 50 AZN","value":{"amount":50,"currency":"AZN"},"price":{"amount":31.25,"currency":"USD"},"details":{"estimatedDeliveredValue":{"amount":50,"currency":"AZN"}}}],"total":{"amount":56.25,"currency":"USD"}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"409":{"description":"Conflict","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Airtime"}},"/v1/airtime/order":{"post":{"tags":["Airtime"],"summary":"Order airtime","description":"Places an airtime top-up order and returns the accepted order.\n\nTakes the same body as quote and needs the `manage` order permission (403 / 10003 without it). An\n`Idempotency-Key` header with a new UUID is required for every purchase: a retry with the same key and body\nreturns the order already accepted, 409 / 12002 with `Retry-After` while it is still being accepted, and a\nchanged body gives 409 / 12001. The number's operator is looked up again, as in quote; item errors are named\nat `items[i]`, and a current price above `inputs.maxPrice` gives 409 / 11002 before anything is\ncharged. Track fulfillment with the order routes or the `order.fulfillment.updated` webhook. A wallet\ncharge that fails creates no order and gives 402 / 16000, with `details[0]` naming `wallet` and\n`INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`; send the same request with the same key after a top-up.","operationId":"airtimeCreateOrder","parameters":[{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AirtimeOrderRequest"}],"description":"The body B2B airtime quote and order both take."},"examples":{"fixedAndRangeOffers":{"summary":"A fixed-amount offer and a range offer, each with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567","maxPrice":{"amount":25,"currency":"USD"}}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","quantity":1,"inputs":{"phoneNumber":"+994501234567","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":31.25,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AirtimeOrderRequest"}],"description":"The body B2B airtime quote and order both take."},"examples":{"fixedAndRangeOffers":{"summary":"A fixed-amount offer and a range offer, each with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567","maxPrice":{"amount":25,"currency":"USD"}}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","quantity":1,"inputs":{"phoneNumber":"+994501234567","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":31.25,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AirtimeOrderRequest"}],"description":"The body B2B airtime quote and order both take."},"examples":{"fixedAndRangeOffers":{"summary":"A fixed-amount offer and a range offer, each with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567","maxPrice":{"amount":25,"currency":"USD"}}},{"publicId":"airtime_ms45o6lwxtqgrsculqdhop74zq","quantity":1,"inputs":{"phoneNumber":"+994501234567","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":31.25,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AirtimeOrder"},"examples":{"paidOrderWithTwoItems":{"summary":"The order as placed: paid from the wallet and processing, both top-ups still pending.","value":{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"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":"pending","result":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":"pending","result":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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}},"application/json":{"schema":{"$ref":"#/components/schemas/AirtimeOrder"},"examples":{"paidOrderWithTwoItems":{"summary":"The order as placed: paid from the wallet and processing, both top-ups still pending.","value":{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"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":"pending","result":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":"pending","result":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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}},"text/json":{"schema":{"$ref":"#/components/schemas/AirtimeOrder"},"examples":{"paidOrderWithTwoItems":{"summary":"The order as placed: paid from the wallet and processing, both top-ups still pending.","value":{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"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":"pending","result":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":"pending","result":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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"402":{"description":"Payment Required","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}}}},"409":{"description":"The offer changed since it was quoted: its price rose (11002, for products that check the quoted price) or it is no longer available (11003). Or the idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; it was used for a different request (12001); or its history is ambiguous.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Airtime"}},"/v1/common/countries":{"get":{"tags":["Common"],"summary":"List countries","description":"Lists every country and territory with its codes, English name, calling code and flag.\n\nReturns `{ items }`, the whole list ordered by `countryCode`, without paging. `countryCode` is\nthe ISO 3166-1 alpha-2 code every service filters and reports by. The endpoint takes no query parameters; an\nunknown parameter returns `400` with code `10001`.","operationId":"commonGetCountries","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CountryList"}},"application/json":{"schema":{"$ref":"#/components/schemas/CountryList"}},"text/json":{"schema":{"$ref":"#/components/schemas/CountryList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Reference data"}},"/v1/common/mccmnc":{"get":{"tags":["Common"],"summary":"List mobile networks","description":"Lists mobile network codes (MCC/MNC) with their operator, country and calling code.\n\nReturns `{ items }` ordered by `mcc` then `mnc`, without paging. Optional filters:\n`countryCode` (ISO 3166-1 alpha-2, either case) and `mcc` (3 digits); both together return the\nnetworks matching both. A malformed filter or an unknown query parameter returns `400` with code\n`10001`.","operationId":"commonGetMobileNetworks","parameters":[{"name":"countryCode","in":"query","description":"Only networks of this country: an ISO 3166-1 alpha-2 code, in either case.","schema":{"type":"string"}},{"name":"mcc","in":"query","description":"Only networks with this 3-digit mobile country code, for example `400`.","schema":{"type":"string"},"examples":{"default":{"value":"400"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/MobileNetworkList"}},"application/json":{"schema":{"$ref":"#/components/schemas/MobileNetworkList"}},"text/json":{"schema":{"$ref":"#/components/schemas/MobileNetworkList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Reference data"}},"/v1/currencies":{"get":{"tags":["Currencies"],"summary":"List currencies","description":"Lists every supported currency with its current rate to USD.\n\nReturns `{ currencies }`, the whole list without paging. Use a currency's `code` wherever a\nrequest takes a `currency`, and its `id` as `currencyId` when creating a wallet.\n`rateToUsd` is the USD value of one unit of the currency, as of `rateDate`.","operationId":"currenciesGetAll","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CurrencyList"}},"application/json":{"schema":{"$ref":"#/components/schemas/CurrencyList"}},"text/json":{"schema":{"$ref":"#/components/schemas/CurrencyList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Currencies"}},"/v1/esims/search":{"get":{"tags":["Esims"],"summary":"Search eSIM plans","description":"Searches eSIM destinations and returns them with their plans, one page at a time.\n\nReturns `{ items, pagination }`. `countryCode` keeps the destinations whose coverage includes that\ncountry, so local, regional and global destinations can match; `category` and `region` select\ndestinations, and `validityDays` and `isUnlimited` select plans within them. Pages count destinations\nwith an orderable plan. With `iccid` it returns the plans that can top up that eSIM instead, under its\ndestination, and takes no filter other than `currency` (400 / 10001, `NOT_ALLOWED`); an unknown or\nforeign ICCID gives 404 / 10004. Prices are indicative, in `currency`.","operationId":"esimsSearch","parameters":[{"name":"countryCode","in":"query","description":"Optional ISO 3166-1 alpha-2 country, in either case: keeps the destinations whose coverage includes it, regional and global ones too. A blank value is rejected.","schema":{"type":"string"},"examples":{"default":{"value":"FR"}}},{"name":"category","in":"query","description":"Keep `local`, `regional` or `global` destinations.","schema":{"enum":["local","regional","global"],"type":"string"},"examples":{"default":{"value":"regional"}}},{"name":"region","in":"query","description":"Keep the destinations of this region, in display or slug form, for example `North America` or `north-america`.","schema":{"type":"string"},"examples":{"default":{"value":"Europe"}}},{"name":"validityDays","in":"query","description":"Keep the plans valid for exactly this many days; at least 1.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":7}}},{"name":"isUnlimited","in":"query","description":"Keep the unlimited (`true`) or the limited (`false`) plans.","schema":{"type":"boolean"},"examples":{"default":{"value":false}}},{"name":"iccid","in":"query","description":"Top-up search: the ICCID (18 to 22 digits) of your eSIM to list the plans that can top it up. No other filter than `currency` is allowed with it.","schema":{"type":"string"}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}},{"name":"page","in":"query","description":"Page number, from 1; default 1.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":1}}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 10.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimSearchResult"},"examples":{"regionalDestination":{"summary":"A regional destination with one plan and the countries it covers.","value":{"items":[{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","countryCode":null,"category":"regional","logoUrl":"https://cdn.openroam.test/esims/europe.png","description":null,"offers":[{"publicId":"esim_eu_3gb_7d","name":"Europe 3 GB 7 days","description":null,"price":{"amount":25,"currency":"USD"},"requiredInputs":[{"name":"isInstant","type":"boolean","required":false,"description":"Defaults to true, which creates the eSIM when the order is fulfilled. False delivers an entitlement, and the eSIM is created later through provisioning."}],"details":{"validityDays":7,"data":{"amount":3072,"unit":"MB","isUnlimited":false,"label":"3 GB"},"voice":null,"sms":null,"apn":{"apn":"internet","apnUsername":null,"apnPassword":null},"properties":{"withKyc":false,"withTopUp":true,"withHotspot":true,"withDataRoaming":true,"withSubscription":false,"withDestinationInstall":false,"withUsageCheck":true,"technology":"eSIM","activation":"first-use","charge":"one-time"},"restrictions":{"throttle":false,"throttleSpeed":null,"throttleUnit":null,"throttleThreshold":null,"throttleThresholdUnit":null,"expireInDays":30},"notes":["Data only. Calls and SMS are not included."],"plan":null}}],"details":{"destinationCode":"EU","region":"Europe","coverage":[{"countryCode":"DE","name":"Germany","networks":["4G"],"carriers":["Telekom"]},{"countryCode":"FR","name":"France","networks":["4G","5G"],"carriers":["Orange"]},{"countryCode":"IT","name":"Italy","networks":["4G"],"carriers":["TIM"]}]}}],"pagination":{"currentCount":1,"totalCount":1,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimSearchResult"},"examples":{"regionalDestination":{"summary":"A regional destination with one plan and the countries it covers.","value":{"items":[{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","countryCode":null,"category":"regional","logoUrl":"https://cdn.openroam.test/esims/europe.png","description":null,"offers":[{"publicId":"esim_eu_3gb_7d","name":"Europe 3 GB 7 days","description":null,"price":{"amount":25,"currency":"USD"},"requiredInputs":[{"name":"isInstant","type":"boolean","required":false,"description":"Defaults to true, which creates the eSIM when the order is fulfilled. False delivers an entitlement, and the eSIM is created later through provisioning."}],"details":{"validityDays":7,"data":{"amount":3072,"unit":"MB","isUnlimited":false,"label":"3 GB"},"voice":null,"sms":null,"apn":{"apn":"internet","apnUsername":null,"apnPassword":null},"properties":{"withKyc":false,"withTopUp":true,"withHotspot":true,"withDataRoaming":true,"withSubscription":false,"withDestinationInstall":false,"withUsageCheck":true,"technology":"eSIM","activation":"first-use","charge":"one-time"},"restrictions":{"throttle":false,"throttleSpeed":null,"throttleUnit":null,"throttleThreshold":null,"throttleThresholdUnit":null,"expireInDays":30},"notes":["Data only. Calls and SMS are not included."],"plan":null}}],"details":{"destinationCode":"EU","region":"Europe","coverage":[{"countryCode":"DE","name":"Germany","networks":["4G"],"carriers":["Telekom"]},{"countryCode":"FR","name":"France","networks":["4G","5G"],"carriers":["Orange"]},{"countryCode":"IT","name":"Italy","networks":["4G"],"carriers":["TIM"]}]}}],"pagination":{"currentCount":1,"totalCount":1,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimSearchResult"},"examples":{"regionalDestination":{"summary":"A regional destination with one plan and the countries it covers.","value":{"items":[{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","countryCode":null,"category":"regional","logoUrl":"https://cdn.openroam.test/esims/europe.png","description":null,"offers":[{"publicId":"esim_eu_3gb_7d","name":"Europe 3 GB 7 days","description":null,"price":{"amount":25,"currency":"USD"},"requiredInputs":[{"name":"isInstant","type":"boolean","required":false,"description":"Defaults to true, which creates the eSIM when the order is fulfilled. False delivers an entitlement, and the eSIM is created later through provisioning."}],"details":{"validityDays":7,"data":{"amount":3072,"unit":"MB","isUnlimited":false,"label":"3 GB"},"voice":null,"sms":null,"apn":{"apn":"internet","apnUsername":null,"apnPassword":null},"properties":{"withKyc":false,"withTopUp":true,"withHotspot":true,"withDataRoaming":true,"withSubscription":false,"withDestinationInstall":false,"withUsageCheck":true,"technology":"eSIM","activation":"first-use","charge":"one-time"},"restrictions":{"throttle":false,"throttleSpeed":null,"throttleUnit":null,"throttleThreshold":null,"throttleThresholdUnit":null,"expireInDays":30},"notes":["Data only. Calls and SMS are not included."],"plan":null}}],"details":{"destinationCode":"EU","region":"Europe","coverage":[{"countryCode":"DE","name":"Germany","networks":["4G"],"carriers":["Telekom"]},{"countryCode":"FR","name":"France","networks":["4G","5G"],"carriers":["Orange"]},{"countryCode":"IT","name":"Italy","networks":["4G"],"carriers":["TIM"]}]}}],"pagination":{"currentCount":1,"totalCount":1,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/destinations":{"get":{"tags":["Esims"],"summary":"List eSIM destinations","description":"Lists every destination with an orderable plan, as summaries without plans.\n\nReturns the complete list `{ items }`, ordered by name, without paging or prices. Read a destination's plans\nwith `destinations/{id}`.","operationId":"esimsGetDestinations","parameters":[{"name":"category","in":"query","description":"Filter by category: local, regional or global.","schema":{"enum":["local","regional","global"],"type":"string"},"examples":{"default":{"value":"regional"}}},{"name":"region","in":"query","description":"Filter by region name (e.g. \"Europe\", \"North America\"), in display or slug form.","schema":{"type":"string"},"examples":{"default":{"value":"Europe"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimDestinationList"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimDestinationList"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimDestinationList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/destinations/{id}":{"get":{"tags":["Esims"],"summary":"Get an eSIM destination","description":"Returns one destination with its plans, in the item shape that search returns.\n\nAn unknown ID, or a destination that search does not list, gives 404 / 10004. After a purchase, the order item's\n`purchasedProduct.details.destination.id` gives the coverage of the destination the eSIM was bought for.","operationId":"esimsGetDestination","parameters":[{"name":"id","in":"path","description":"The destination `id` from search, the destination list or the catalog.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq"}}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimDestination"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimDestination"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimDestination"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/catalog":{"get":{"tags":["Esims"],"summary":"eSIM catalog","description":"Returns every destination with its plans, page by page, for partner inventory.\n\nReturns `{ items, nextCursor }`, in a fixed order, with the search filters except `iccid`.\nContinue with `nextCursor` as `cursor`, the same filters and the same `currency` until it is\nnull. A cursor reused with other filters or another currency gives 400 / 10001. Quote confirms the final price\nand availability.","operationId":"esimsGetCatalog","parameters":[{"name":"countryCode","in":"query","description":"Optional ISO 3166-1 alpha-2 country, in either case: keeps the destinations whose coverage includes it, regional and global ones too. A blank value is rejected.","schema":{"type":"string"},"examples":{"default":{"value":"FR"}}},{"name":"category","in":"query","description":"Keep `local`, `regional` or `global` destinations.","schema":{"enum":["local","regional","global"],"type":"string"},"examples":{"default":{"value":"regional"}}},{"name":"region","in":"query","description":"Keep the destinations of this region, in display or slug form, for example `North America` or `north-america`.","schema":{"type":"string"},"examples":{"default":{"value":"Europe"}}},{"name":"validityDays","in":"query","description":"Keep the plans valid for exactly this many days; at least 1.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":7}}},{"name":"isUnlimited","in":"query","description":"Keep the unlimited (`true`) or the limited (`false`) plans.","schema":{"type":"boolean"},"examples":{"default":{"value":false}}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}},{"name":"cursor","in":"query","description":"The `nextCursor` of the previous page; omit it for the first page. Reuse it only with the same filters and currency.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 100.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimCatalogPage"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimCatalogPage"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimCatalogPage"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/compatible-devices":{"get":{"tags":["Esims"],"summary":"List compatible devices","description":"Lists the devices known to support eSIM.\n\nReturns an array of `{ brand, model, os, deviceType, name, notes }`, without paging.","operationId":"esimsGetCompatibleDevices","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EsimCompatibleDevice"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EsimCompatibleDevice"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EsimCompatibleDevice"}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/order":{"post":{"tags":["Esims"],"summary":"Order eSIMs","description":"Places an order for new eSIMs or a top-up and returns the accepted order.\n\nTakes the same body as quote and needs the `manage` order permission (403 / 10003 without it).\nAn `Idempotency-Key` header with a new UUID is required for every purchase: a retry with the same key and body\nreturns the order already accepted, 409 / 12002 with `Retry-After` while it is still being accepted, and a\nchanged body gives 409 / 12001.\nA top-up is an offer from `search?iccid=` ordered with `inputs.iccid` and quantity 1; without\n`inputs.iccid` the same offer is bought as a new eSIM. A new eSIM is instant unless `inputs.isInstant`\nis false, which delivers an entitlement to provision later. Every price is recalculated: a current price above\n`inputs.maxPrice` gives 409 / 11002 before anything is charged. A wallet charge that fails creates no\norder and gives 402 / 16000, with `details[0]` naming `wallet` and `INSUFFICIENT_BALANCE` or\n`WALLET_BLOCKED`; send the same request with the same key after a top-up. An unknown or foreign\n`inputs.iccid` gives 404 / 10004 and charges nothing.","operationId":"esimsCreateOrder","parameters":[{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimOrderRequest"}],"description":"The body B2B eSIM quote and order both take."},"examples":{"instantEsim":{"summary":"One eSIM plan, installed at once, with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true,"maxPrice":{"amount":25,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimOrderRequest"}],"description":"The body B2B eSIM quote and order both take."},"examples":{"instantEsim":{"summary":"One eSIM plan, installed at once, with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true,"maxPrice":{"amount":25,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimOrderRequest"}],"description":"The body B2B eSIM quote and order both take."},"examples":{"instantEsim":{"summary":"One eSIM plan, installed at once, with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true,"maxPrice":{"amount":25,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimOrder"},"examples":{"paidOrderWithOneEsim":{"summary":"The order as placed: paid from the wallet and processing, the eSIM still pending.","value":{"id":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":25,"currency":"USD"}},"failure":null},"items":[{"id":"01a14329-9cc4-73a3-8ca6-22a3efdde687","orderId":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","productType":"esim","price":{"amount":25,"currency":"USD"},"purchasedProduct":{"name":"Europe 3 GB 7 days","countryCode":null,"logoUrl":"https://cdn.openroam.test/esims/europe.png","inputs":{"eid":null,"imei2":null,"iccid":null,"travelStartDate":null,"isInstant":true},"details":{"orderType":"esim","isInstant":true,"destination":{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","code":"EU"}}},"fulfillment":{"status":"pending","result":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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimOrder"},"examples":{"paidOrderWithOneEsim":{"summary":"The order as placed: paid from the wallet and processing, the eSIM still pending.","value":{"id":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":25,"currency":"USD"}},"failure":null},"items":[{"id":"01a14329-9cc4-73a3-8ca6-22a3efdde687","orderId":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","productType":"esim","price":{"amount":25,"currency":"USD"},"purchasedProduct":{"name":"Europe 3 GB 7 days","countryCode":null,"logoUrl":"https://cdn.openroam.test/esims/europe.png","inputs":{"eid":null,"imei2":null,"iccid":null,"travelStartDate":null,"isInstant":true},"details":{"orderType":"esim","isInstant":true,"destination":{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","code":"EU"}}},"fulfillment":{"status":"pending","result":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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimOrder"},"examples":{"paidOrderWithOneEsim":{"summary":"The order as placed: paid from the wallet and processing, the eSIM still pending.","value":{"id":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":25,"currency":"USD"}},"failure":null},"items":[{"id":"01a14329-9cc4-73a3-8ca6-22a3efdde687","orderId":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","productType":"esim","price":{"amount":25,"currency":"USD"},"purchasedProduct":{"name":"Europe 3 GB 7 days","countryCode":null,"logoUrl":"https://cdn.openroam.test/esims/europe.png","inputs":{"eid":null,"imei2":null,"iccid":null,"travelStartDate":null,"isInstant":true},"details":{"orderType":"esim","isInstant":true,"destination":{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","code":"EU"}}},"fulfillment":{"status":"pending","result":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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"402":{"description":"Payment Required","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"The offer changed since it was quoted: its price rose (11002, for products that check the quoted price) or it is no longer available (11003). Or the idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; it was used for a different request (12001); or its history is ambiguous.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/quote":{"post":{"tags":["Esims"],"summary":"Quote eSIMs","description":"Prices the order body with current prices, without placing an order.\n\nTakes the same body as order and, as the order does, checks each item completely (its inputs, its\n`publicId` and its price) before the next one, in request order. The first failure aborts the quote, and an\nitem error is named at `items[i]`, for example 409 / 11002 at `items[i].inputs.maxPrice` when the\ncurrent price is above it. An eSIM has no monetary value, so `inputs.value` is an unknown member\n(400 / 10001). An unknown or foreign `inputs.iccid` gives 404 / 10004. A quote reserves nothing and does\nnot expire.","operationId":"esimsQuote","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimOrderRequest"}],"description":"The body B2B eSIM quote and order both take."},"examples":{"instantEsim":{"summary":"One eSIM plan, installed at once, with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true,"maxPrice":{"amount":25,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimOrderRequest"}],"description":"The body B2B eSIM quote and order both take."},"examples":{"instantEsim":{"summary":"One eSIM plan, installed at once, with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true,"maxPrice":{"amount":25,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimOrderRequest"}],"description":"The body B2B eSIM quote and order both take."},"examples":{"instantEsim":{"summary":"One eSIM plan, installed at once, with a price guard.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true,"maxPrice":{"amount":25,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimQuote"},"examples":{"onePlan":{"summary":"The price of the plan.","value":{"currency":"USD","items":[{"publicId":"esim_eu_3gb_7d","quantity":1,"name":"Europe 3 GB 7 days","price":{"amount":25,"currency":"USD"}}],"total":{"amount":25,"currency":"USD"}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimQuote"},"examples":{"onePlan":{"summary":"The price of the plan.","value":{"currency":"USD","items":[{"publicId":"esim_eu_3gb_7d","quantity":1,"name":"Europe 3 GB 7 days","price":{"amount":25,"currency":"USD"}}],"total":{"amount":25,"currency":"USD"}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimQuote"},"examples":{"onePlan":{"summary":"The price of the plan.","value":{"currency":"USD","items":[{"publicId":"esim_eu_3gb_7d","quantity":1,"name":"Europe 3 GB 7 days","price":{"amount":25,"currency":"USD"}}],"total":{"amount":25,"currency":"USD"}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"Conflict","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/{iccid}/profile":{"get":{"tags":["Esims"],"summary":"Get an eSIM","description":"Returns one of your eSIMs by its ICCID, with its installation details, plan and top-ups.\n\nReturns the eSIM as last recorded, without a live refresh: `esimStatus` and `profileStatus` as the\norder item names them, the SIM details (LPA code, QR code URL and quick-install links), the plan, its data\n(MB), SMS (messages) and voice (minutes) allowances, any top-ups, and `expiresAt`, null until the eSIM is\nactivated. An ICCID that is not one of your eSIMs gives 404 / 10004.","operationId":"esimsGetEsim","parameters":[{"name":"iccid","in":"path","description":"The eSIM's ICCID, from the order item's `fulfillment.result.details.iccid`.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"8944501234567890123"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimProfile"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimProfile"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimProfile"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/{iccid}/usage":{"get":{"tags":["Esims"],"summary":"Get eSIM usage","description":"Returns the current data, SMS and voice usage of an eSIM.\n\nReads the live usage when the request is made and returns `esimStatus`, `profileStatus` and the allowed\nand remaining data (MB), SMS (messages) and voice (minutes), including top-ups. An amount is null when it is\nunlimited (`isDataUnlimited`, `isSmsUnlimited`, `isVoiceUnlimited`), not reported or not\nincluded. When the usage cannot be read live, or the plan does not report live usage, it returns the last known\nusage. An ICCID that is not one of your eSIMs gives 404 / 10004.","operationId":"esimsGetUsage","parameters":[{"name":"iccid","in":"path","description":"The eSIM's ICCID, from the order item's `fulfillment.result.details.iccid`.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"8944501234567890123"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimCurrentUsage"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimCurrentUsage"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimCurrentUsage"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/{iccid}/usage/details":{"get":{"tags":["Esims"],"summary":"Get eSIM usage by day","description":"Returns the current usage of an eSIM with a per-day breakdown.\n\nReturns the same summary as `usage` plus `usages`, the per-day consumption entries\n`{ date, usage, location }` with the data used in MB and `location` null when no country was reported.\n`usages` is empty when the eSIM's plan does not report a per-day breakdown or it cannot be read.","operationId":"esimsGetUsageDetails","parameters":[{"name":"iccid","in":"path","description":"The eSIM's ICCID, from the order item's `fulfillment.result.details.iccid`.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"8944501234567890123"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimDailyUsage"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimDailyUsage"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimDailyUsage"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/{iccid}/usage/history":{"get":{"tags":["Esims"],"summary":"List eSIM usage history","description":"Lists the recorded usage readings of an eSIM, newest first.\n\nReturns `{ items, pagination }`, one item per usage reading, with its allowances, remaining amounts and\nusage and expiry bands. `from` and `to` limit the readings by `capturedAt`, both inclusive. An\nICCID that is not one of your eSIMs gives 404 / 10004.","operationId":"esimsGetUsageHistory","parameters":[{"name":"iccid","in":"path","description":"The eSIM's ICCID, from the order item's `fulfillment.result.details.iccid`.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"8944501234567890123"}}},{"name":"page","in":"query","description":"Page number, from 1; default 1.","schema":{"type":"integer","format":"int32","default":1},"examples":{"default":{"value":1}}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 10.","schema":{"type":"integer","format":"int32","default":10},"examples":{"default":{"value":10}}},{"name":"from","in":"query","description":"Only readings captured at or after this UTC time. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-01T00:00:00Z"}}},{"name":"to","in":"query","description":"Only readings captured at or before this UTC time. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-31T23:59:59Z"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimUsageReadingList"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimUsageReadingList"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimUsageReadingList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/{iccid}/status-events":{"get":{"tags":["Esims"],"summary":"List eSIM status events","description":"Lists the status changes of an eSIM, newest first.\n\nReturns `{ items, pagination }`, one item per status change with `esimStatus`, `profileStatus` and\n`occurredAt`. `from` and `to` limit the events by\n`occurredAt`, both inclusive. An ICCID that is not one of your eSIMs gives 404 / 10004.","operationId":"esimsGetStatusEvents","parameters":[{"name":"iccid","in":"path","description":"The eSIM's ICCID, from the order item's `fulfillment.result.details.iccid`.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"8944501234567890123"}}},{"name":"page","in":"query","description":"Page number, from 1; default 1.","schema":{"type":"integer","format":"int32","default":1},"examples":{"default":{"value":1}}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 10.","schema":{"type":"integer","format":"int32","default":10},"examples":{"default":{"value":10}}},{"name":"from","in":"query","description":"Only events that occurred at or after this UTC time. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-01T00:00:00Z"}}},{"name":"to","in":"query","description":"Only events that occurred at or before this UTC time. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-31T23:59:59Z"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimStatusEventList"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimStatusEventList"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimStatusEventList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/{iccid}/location-events":{"get":{"tags":["Esims"],"summary":"List eSIM location events","description":"Lists the networks and locations where an eSIM registered, newest first.\n\nReturns `{ items, pagination }`, one item per registration with its MCC, MNC, location, network and\n`occurredAt`. `from` and `to` limit the events by `occurredAt`, both inclusive. An ICCID that\nis not one of your eSIMs gives 404 / 10004.","operationId":"esimsGetLocationEvents","parameters":[{"name":"iccid","in":"path","description":"The eSIM's ICCID, from the order item's `fulfillment.result.details.iccid`.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"8944501234567890123"}}},{"name":"page","in":"query","description":"Page number, from 1; default 1.","schema":{"type":"integer","format":"int32","default":1},"examples":{"default":{"value":1}}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 10.","schema":{"type":"integer","format":"int32","default":10},"examples":{"default":{"value":10}}},{"name":"from","in":"query","description":"Only events that occurred at or after this UTC time. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-01T00:00:00Z"}}},{"name":"to","in":"query","description":"Only events that occurred at or before this UTC time. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-31T23:59:59Z"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimLocationEventList"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimLocationEventList"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimLocationEventList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/{id}/provisioning":{"post":{"tags":["Esims"],"summary":"Provision a deferred eSIM","description":"Provisions a deferred eSIM bought with `inputs.isInstant: false` and returns it.\n\nCreates the eSIM for an order item that delivered an entitlement, and returns it as `GET /esims/{iccid}`\ndoes. The item's result moves to `provisioning.status` `processing` and then `ready`, and each\nchange sends an `order.fulfillment.updated` webhook. An `Idempotency-Key` header with a UUID is\nrequired: a retry with the same key and body after the call finished returns the eSIM as it reads now and starts\nnothing again, 409 / 12002 with `Retry-After` while the call is still running, and a changed body gives\n409 / 12001. The optional body\n`{ travelStartDate }` is needed when the plan requires the first day of travel and the order did not send\nit (400 / 10001 without it); a date other than the one recorded, or a new date once provisioning has started,\ngives 409 / 10005. An instant eSIM gives 400 / 10001, and an ID that names no eSIM purchase of yours, such as a\ntop-up item, gives 404 / 10004.","operationId":"esimsProvision","parameters":[{"name":"id","in":"path","description":"The order item ID of the deferred eSIM purchase.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"description":"Optional: `{ travelStartDate }`, the first day of travel.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimProvisioningRequest"}],"description":"The optional body of `POST /esims/{id}/provisioning`."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimProvisioningRequest"}],"description":"The optional body of `POST /esims/{id}/provisioning`."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimProvisioningRequest"}],"description":"The optional body of `POST /esims/{id}/provisioning`."}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimProfile"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimProfile"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimProfile"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"The idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; or it was used for a different request (12001). A finished request sent again with the same key and body returns 200 with the result of the first call, rebuilt from the record that call created as it reads now: nothing runs again, and a status that has moved on since shows its current value.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/esims/{iccid}/sms":{"post":{"tags":["Esims"],"summary":"Send an SMS to an eSIM","description":"Sends a text message to one of your eSIMs.\n\nTakes `{ message }`, which must not be empty, and returns `{ iccid }` only when the message was sent.\nAn eSIM whose plan cannot be sent messages this way gives 422 / 22000 (`ESIM_SMS_NOT_SUPPORTED`); do not\nretry it. A message that was not sent gives 502 / 10008. An ICCID that is not one of your eSIMs gives\n404 / 10004.","operationId":"esimsSendSms","parameters":[{"name":"iccid","in":"path","description":"The eSIM's ICCID, from the order item's `fulfillment.result.details.iccid`.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"8944501234567890123"}}}],"requestBody":{"description":"The message to send.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimSmsRequest"}],"description":"A text message to send to an eSIM; the ICCID comes from the route."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimSmsRequest"}],"description":"A text message to send to an eSIM; the ICCID comes from the route."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsimSmsRequest"}],"description":"A text message to send to an eSIM; the ICCID comes from the route."}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/EsimSmsResult"}},"application/json":{"schema":{"$ref":"#/components/schemas/EsimSmsResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/EsimSmsResult"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"smsNotSupported":{"summary":"This eSIM's plan cannot be sent text messages; do not retry.","value":{"code":22000,"name":"ESIM_SMS_NOT_SUPPORTED","message":"This eSIM cannot be sent text messages.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"smsNotSupported":{"summary":"This eSIM's plan cannot be sent text messages; do not retry.","value":{"code":22000,"name":"ESIM_SMS_NOT_SUPPORTED","message":"This eSIM cannot be sent text messages.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"smsNotSupported":{"summary":"This eSIM's plan cannot be sent text messages; do not retry.","value":{"code":22000,"name":"ESIM_SMS_NOT_SUPPORTED","message":"This eSIM cannot be sent text messages.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"502":{"description":"Bad Gateway","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"requestNotCompleted":{"summary":"The request could not be completed.","value":{"code":10008,"name":"REQUEST_NOT_COMPLETED","message":"The request could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"requestNotCompleted":{"summary":"The request could not be completed.","value":{"code":10008,"name":"REQUEST_NOT_COMPLETED","message":"The request could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"requestNotCompleted":{"summary":"The request could not be completed.","value":{"code":10008,"name":"REQUEST_NOT_COMPLETED","message":"The request could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/eSIMs"}},"/v1/flights/search":{"post":{"tags":["Flights"],"summary":"Search flights","description":"Searches flight itineraries and the fares bookable on them.\n\nSend one slice per flight (one for one-way, two for a return, more for a multi-city trip) and every passenger;\nat least one passenger must be an `adult`, and children and infants need an `age`. Optional\n`filters`: `maxStops`, `preferredAirlines` and `excludedAirlines` select itineraries;\n`refundableOnly` and `maxPrice` select fares, and an itinerary left without a fare is not returned.\nThe body rejects an unknown field at every level, and the route takes no query parameters.\n            \nReturns `{ items, pagination }`. Each item is one itinerary, the same flights sold by the same airline, with\nits fares as `offers`, cheapest first; items are ordered by their cheapest fare, then total duration.\n`page` and `limit` (defaults 1 and 10, `limit` at most 100) page through itineraries, and\n`pagination.totalCount` counts them. Each page runs a new airline search, so fares can change between pages.\n            \nAn item's `id` is valid only within this response and cannot be ordered; quote and order an offer's\n`publicId` before its `details.expiresAt`. Prices are for all passengers, in `currency` or the API\nkey's currency, and are indicative.\n            \nErrors: an invalid or unknown field, or a query parameter, 400 / 10001; an unsupported `currency`\n404 / 10004.","operationId":"flightsSearch","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FlightSearchRequest"}],"description":"Flight search body: the trip, the passengers, optional filters, the page of itineraries and an optional price\ncurrency. Unknown fields are rejected at every level."},"examples":{"returnTripWithFilters":{"summary":"A return trip for an adult and a child, with filters.","value":{"currency":"USD","slices":[{"origin":"LHR","destination":"JFK","departureDate":"2026-12-12"},{"origin":"JFK","destination":"LHR","departureDate":"2026-12-19"}],"passengers":[{"type":"adult"},{"type":"child","age":7}],"cabinClass":"economy","filters":{"maxStops":1,"preferredAirlines":["BA"],"refundableOnly":false,"maxPrice":1500},"page":1,"limit":10}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FlightSearchRequest"}],"description":"Flight search body: the trip, the passengers, optional filters, the page of itineraries and an optional price\ncurrency. Unknown fields are rejected at every level."},"examples":{"returnTripWithFilters":{"summary":"A return trip for an adult and a child, with filters.","value":{"currency":"USD","slices":[{"origin":"LHR","destination":"JFK","departureDate":"2026-12-12"},{"origin":"JFK","destination":"LHR","departureDate":"2026-12-19"}],"passengers":[{"type":"adult"},{"type":"child","age":7}],"cabinClass":"economy","filters":{"maxStops":1,"preferredAirlines":["BA"],"refundableOnly":false,"maxPrice":1500},"page":1,"limit":10}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FlightSearchRequest"}],"description":"Flight search body: the trip, the passengers, optional filters, the page of itineraries and an optional price\ncurrency. Unknown fields are rejected at every level."},"examples":{"returnTripWithFilters":{"summary":"A return trip for an adult and a child, with filters.","value":{"currency":"USD","slices":[{"origin":"LHR","destination":"JFK","departureDate":"2026-12-12"},{"origin":"JFK","destination":"LHR","departureDate":"2026-12-19"}],"passengers":[{"type":"adult"},{"type":"child","age":7}],"cabinClass":"economy","filters":{"maxStops":1,"preferredAirlines":["BA"],"refundableOnly":false,"maxPrice":1500},"page":1,"limit":10}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/FlightSearchResult"}},"application/json":{"schema":{"$ref":"#/components/schemas/FlightSearchResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/FlightSearchResult"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Flights"}},"/v1/flights/quote":{"post":{"tags":["Flights"],"summary":"Quote flights","description":"Prices flight fares again with the airline, without placing an order.\n\nTakes the same body as order: `{ currency, referenceId, items[] }` with 1 to 5 items, each\n`{ publicId, quantity, inputs }` and `quantity` 1. `inputs` may be left out: the quote then prices\nthe fare alone. Inputs that are sent are checked as the order checks them, and their paid extras are added to\nthe price. Prices are in `currency`, or in the API key's currency when it is omitted. Nothing is charged or\nheld.\n            \nReturns `{ currency, items, total }`. Each item has a new `publicId`: order with it before\n`details.expiresAt`. It keeps the fare's price, which caps an order without `inputs.maxPrice`.\n`details` carries the fare's conditions, included baggage and price breakdown, `hasSeatMaps`, the paid\nextras (`availableServices`) that can be sent in the order's `inputs.selectedServices`, and\n`fareOptions`: the fares for the same flights and airline, cheapest first and including the quoted one, each\nwith its own `publicId` that can be quoted or ordered.\n            \nA higher airline price is returned with 200; only `inputs.maxPrice` stops a quote. Each item is checked\ncompletely, its inputs, its `publicId` and its price, before the next one, and the first failure names its\nitem: an invalid input or a `quantity` other than 1 gives 400 / 10001 at its path under `items[i]`; a\nprice above `inputs.maxPrice` 409 / 11002 at `items[i].inputs.maxPrice`; an offer the airline no\nlonger sells 409 / 11003 at `items[i]`; an unknown, expired or another partner's `publicId`, or a\nsearch itinerary `id`, 400 / 11004 at `items[i]`. An unsupported `currency` gives 400 / 10001 at\n`currency`.","operationId":"flightsQuote","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FlightOrderRequest"}],"description":"The body B2B flight quote and order both take."},"examples":{"twoPassengersWithSeatAndBag":{"summary":"Two passengers, one with a seat and a checked bag, and a price guard.","value":{"currency":"USD","referenceId":"partner-trip-7","items":[{"publicId":"flight_k3m9q2x7v4b8n6c1z5r0t2w8y4","quantity":1,"inputs":{"passengers":[{"passengerIndex":1,"title":"mr","givenName":"Tom","familyName":"Lee","gender":"m","bornOn":"1988-04-02","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380006","issuingCountryCode":"GB","expiresOn":"2031-06-30"}],"selectedSeats":[{"sliceIndex":1,"segmentIndex":1,"seatDesignator":"32A"}]},{"passengerIndex":2,"title":"ms","givenName":"Mia","familyName":"Lee","gender":"f","bornOn":"2019-03-14","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380007","issuingCountryCode":"GB","expiresOn":"2030-01-31"}]}],"selectedServices":[{"id":"flight_s8d2k4m6n1p3q5r7t9v0w2x4y6","quantity":1}],"maxPrice":{"amount":1250,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FlightOrderRequest"}],"description":"The body B2B flight quote and order both take."},"examples":{"twoPassengersWithSeatAndBag":{"summary":"Two passengers, one with a seat and a checked bag, and a price guard.","value":{"currency":"USD","referenceId":"partner-trip-7","items":[{"publicId":"flight_k3m9q2x7v4b8n6c1z5r0t2w8y4","quantity":1,"inputs":{"passengers":[{"passengerIndex":1,"title":"mr","givenName":"Tom","familyName":"Lee","gender":"m","bornOn":"1988-04-02","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380006","issuingCountryCode":"GB","expiresOn":"2031-06-30"}],"selectedSeats":[{"sliceIndex":1,"segmentIndex":1,"seatDesignator":"32A"}]},{"passengerIndex":2,"title":"ms","givenName":"Mia","familyName":"Lee","gender":"f","bornOn":"2019-03-14","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380007","issuingCountryCode":"GB","expiresOn":"2030-01-31"}]}],"selectedServices":[{"id":"flight_s8d2k4m6n1p3q5r7t9v0w2x4y6","quantity":1}],"maxPrice":{"amount":1250,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FlightOrderRequest"}],"description":"The body B2B flight quote and order both take."},"examples":{"twoPassengersWithSeatAndBag":{"summary":"Two passengers, one with a seat and a checked bag, and a price guard.","value":{"currency":"USD","referenceId":"partner-trip-7","items":[{"publicId":"flight_k3m9q2x7v4b8n6c1z5r0t2w8y4","quantity":1,"inputs":{"passengers":[{"passengerIndex":1,"title":"mr","givenName":"Tom","familyName":"Lee","gender":"m","bornOn":"1988-04-02","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380006","issuingCountryCode":"GB","expiresOn":"2031-06-30"}],"selectedSeats":[{"sliceIndex":1,"segmentIndex":1,"seatDesignator":"32A"}]},{"passengerIndex":2,"title":"ms","givenName":"Mia","familyName":"Lee","gender":"f","bornOn":"2019-03-14","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380007","issuingCountryCode":"GB","expiresOn":"2030-01-31"}]}],"selectedServices":[{"id":"flight_s8d2k4m6n1p3q5r7t9v0w2x4y6","quantity":1}],"maxPrice":{"amount":1250,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/FlightQuote"}},"application/json":{"schema":{"$ref":"#/components/schemas/FlightQuote"}},"text/json":{"schema":{"$ref":"#/components/schemas/FlightQuote"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"409":{"description":"Conflict","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Flights"}},"/v1/flights/order":{"post":{"tags":["Flights"],"summary":"Order flights","description":"Places and pays for flight bookings, one fare per item.\n\nTakes the same body as quote, with `inputs` required. Requires an `Idempotency-Key` header (a new UUID\nper purchase) and an API key with order-manage permission. Repeating the same request with the same key returns\nthe original order; while the first request is still running the response is 409 / 12002 with\n`Retry-After`, after which you send the same request again. The order is paid from your\nwallet balance and ticketing completes asynchronously: track it with `GET /orders/{id}` or the\n`order.fulfillment.updated` webhook.\n            \n`publicId` is a fare's `publicId` from search, or one that a quote returned. `inputs.passengers`\nlists every passenger of the fare exactly once, in `passengerIndex` order 1 to N, optionally with seats in\n`selectedSeats`; paid baggage and other services go in `inputs.selectedServices`. Seats and services\nare checked against the airline's current offer and seat map, and their prices are added to the item's price.\n            \nEach item is priced again with the airline before payment, and the price is capped. With the optional\n`inputs.maxPrice`, in the order currency, a higher price for the item (the fare with its paid extras) gives\n409 / 11002 at `items[i].inputs.maxPrice`. Without it, the fare may not cost more than the price returned\nwith the `publicId` (409 / 11002 at `items[i]`), and the order must be in the currency of that price\n(400 / 11005 at `items[i]`).\nA `publicId` keeps that price: after 409 / 11002, quote again and order with the `publicId` the quote\nreturns, or send `inputs.maxPrice`.\n            \nEach item is checked completely before the next one, and the first failure names its item: an invalid input or\nmissing `inputs` gives 400 / 10001 at its path under `items[i]`, for example\n`items[0].inputs.passengers[0].email`; an unknown, expired or another partner's `publicId`\n400 / 11004 at `items[i]`; an offer the airline no longer sells 409 / 11003 at `items[i]`. A wallet\ncharge that fails gives 402 / 16000, with `details[0]` naming `wallet` and\n`INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`; send the same request with the same key after a top-up.\nNothing is created or charged when the order is refused.","operationId":"flightsCreateOrder","parameters":[{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FlightOrderRequest"}],"description":"The body B2B flight quote and order both take."},"examples":{"twoPassengersWithSeatAndBag":{"summary":"The quoted fare ordered with the same passengers, seat and bag, and a price guard.","value":{"currency":"USD","referenceId":"partner-trip-7","items":[{"publicId":"flight_r2dm7x4q9v3b6n8c1z5k0t2w4y","quantity":1,"inputs":{"passengers":[{"passengerIndex":1,"title":"mr","givenName":"Tom","familyName":"Lee","gender":"m","bornOn":"1988-04-02","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380006","issuingCountryCode":"GB","expiresOn":"2031-06-30"}],"selectedSeats":[{"sliceIndex":1,"segmentIndex":1,"seatDesignator":"32A"}]},{"passengerIndex":2,"title":"ms","givenName":"Mia","familyName":"Lee","gender":"f","bornOn":"2019-03-14","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380007","issuingCountryCode":"GB","expiresOn":"2030-01-31"}]}],"selectedServices":[{"id":"flight_s8d2k4m6n1p3q5r7t9v0w2x4y6","quantity":1}],"maxPrice":{"amount":1250,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FlightOrderRequest"}],"description":"The body B2B flight quote and order both take."},"examples":{"twoPassengersWithSeatAndBag":{"summary":"The quoted fare ordered with the same passengers, seat and bag, and a price guard.","value":{"currency":"USD","referenceId":"partner-trip-7","items":[{"publicId":"flight_r2dm7x4q9v3b6n8c1z5k0t2w4y","quantity":1,"inputs":{"passengers":[{"passengerIndex":1,"title":"mr","givenName":"Tom","familyName":"Lee","gender":"m","bornOn":"1988-04-02","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380006","issuingCountryCode":"GB","expiresOn":"2031-06-30"}],"selectedSeats":[{"sliceIndex":1,"segmentIndex":1,"seatDesignator":"32A"}]},{"passengerIndex":2,"title":"ms","givenName":"Mia","familyName":"Lee","gender":"f","bornOn":"2019-03-14","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380007","issuingCountryCode":"GB","expiresOn":"2030-01-31"}]}],"selectedServices":[{"id":"flight_s8d2k4m6n1p3q5r7t9v0w2x4y6","quantity":1}],"maxPrice":{"amount":1250,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FlightOrderRequest"}],"description":"The body B2B flight quote and order both take."},"examples":{"twoPassengersWithSeatAndBag":{"summary":"The quoted fare ordered with the same passengers, seat and bag, and a price guard.","value":{"currency":"USD","referenceId":"partner-trip-7","items":[{"publicId":"flight_r2dm7x4q9v3b6n8c1z5k0t2w4y","quantity":1,"inputs":{"passengers":[{"passengerIndex":1,"title":"mr","givenName":"Tom","familyName":"Lee","gender":"m","bornOn":"1988-04-02","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380006","issuingCountryCode":"GB","expiresOn":"2031-06-30"}],"selectedSeats":[{"sliceIndex":1,"segmentIndex":1,"seatDesignator":"32A"}]},{"passengerIndex":2,"title":"ms","givenName":"Mia","familyName":"Lee","gender":"f","bornOn":"2019-03-14","email":"tom@example.com","phoneNumber":"+447700900123","identityDocuments":[{"type":"passport","uniqueIdentifier":"533380007","issuingCountryCode":"GB","expiresOn":"2030-01-31"}]}],"selectedServices":[{"id":"flight_s8d2k4m6n1p3q5r7t9v0w2x4y6","quantity":1}],"maxPrice":{"amount":1250,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/FlightOrder"}},"application/json":{"schema":{"$ref":"#/components/schemas/FlightOrder"}},"text/json":{"schema":{"$ref":"#/components/schemas/FlightOrder"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"402":{"description":"Payment Required","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}}}},"409":{"description":"The offer changed since it was quoted: its price rose (11002, for products that check the quoted price) or it is no longer available (11003). Or the idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; it was used for a different request (12001); or its history is ambiguous.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Flights"}},"/v1/flights/offers/{publicId}/seat-map":{"get":{"tags":["Flights"],"summary":"Get a flight seat map","description":"Returns the seat map of a flight offer, with the seats each passenger can take and their prices.\n\nThe seat map is read from the airline on each call, so availability can change between calls; prices are in\nthe API key's currency. `isSupported` is false when the airline offers no seat selection for the offer.\nSegments are named by `sliceIndex` and `segmentIndex`, their 1-based position in the offer; a\nsegment without a seat map is left out. A seat can be booked only for the passengers in its\n`availableFor`. Send chosen seats in the order's `inputs.passengers[].selectedSeats`, one per\npassenger per segment. An unknown, expired or another partner's `publicId` returns 400 / 11004.","operationId":"flightsGetSeatMap","parameters":[{"name":"publicId","in":"path","description":"An offer or fare option `publicId` from search or quote.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/SeatMap"}},"application/json":{"schema":{"$ref":"#/components/schemas/SeatMap"}},"text/json":{"schema":{"$ref":"#/components/schemas/SeatMap"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Flights"}},"/v1/giftcards/categories":{"get":{"tags":["GiftCards"],"summary":"List gift card categories","description":"Lists the gift card categories with their display names.\n\nReturns the complete list `{ items: [{ category, name }] }`, without paging. Use a `category` value to\nfilter search and the catalog. The route takes no query parameters.","operationId":"giftCardsGetCategories","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GiftCardCategoryList"}},"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardCategoryList"}},"text/json":{"schema":{"$ref":"#/components/schemas/GiftCardCategoryList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Gift cards"}},"/v1/giftcards/search":{"get":{"tags":["GiftCards"],"summary":"Search gift cards","description":"Searches gift cards and returns them with their offers, one page at a time.\n\nReturns `{ items, pagination }`. `countryCode`, `category`, `q` and\n`isRedeemableGlobally` select cards; `valueType` selects offers within them, and a card left without\nan offer is dropped. Pages count cards. Prices are indicative, in `currency`; a fixed offer is listed only\nwhen it is cheaper than the card's range at the same value. An invalid or unknown parameter gives 400 / 10001;\nan unsupported `currency` gives 400 / 10001 at `currency`.","operationId":"giftCardsSearch","parameters":[{"name":"countryCode","in":"query","description":"Optional ISO 3166-1 alpha-2 issuing country, in either case; every country when omitted. A card without a country is not listed when it is set, and a blank value or `GLOBAL` is rejected.","schema":{"type":"string"},"examples":{"default":{"value":"US"}}},{"name":"category","in":"query","description":"Keep the cards of this category; `categories` lists the values.","schema":{"enum":["shopping","foodAndDining","entertainment","gaming","travel","paymentCards","softwareAndDigital","other"],"type":"string"},"examples":{"default":{"value":"shopping"}}},{"name":"valueType","in":"query","description":"Keep only `fixed` or only `range` offers; a card left without an offer is dropped.","schema":{"enum":["fixed","range"],"type":"string"},"examples":{"default":{"value":"range"}}},{"name":"q","in":"query","description":"Brand name or card ID, case-insensitive; at most 100 characters, without control characters.","schema":{"type":"string"}},{"name":"isRedeemableGlobally","in":"query","description":"`true` keeps only cards that can be redeemed in any country.","schema":{"type":"boolean"},"examples":{"default":{"value":false}}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}},{"name":"page","in":"query","description":"Page number, from 1; default 1.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":1}}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 10.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GiftCardSearchResult"},"examples":{"brandWithFixedAndRangeOffers":{"summary":"One brand with a 50 USD card and a 1-500 USD range card.","value":{"items":[{"id":"card_tzkc6b2xcqznidhkouwh2rz7wi","name":"Amazon","countryCode":"US","category":"shopping","logoUrl":"https://cdn.openroam.test/amazon.png","description":"Redeem at amazon.com","offers":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","name":"Amazon 50 USD","description":null,"value":{"type":"fixed","amount":50,"currency":"USD"},"price":{"amount":48.98,"currency":"USD"},"requiredInputs":[{"name":"recipientEmail","type":"email","required":false,"description":"Sends the card to this email address as a gift."},{"name":"giftMessage","type":"text","required":false,"description":"Message included in the gift email."}]},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","name":"Amazon 1–500 USD","description":null,"value":{"type":"range","min":1,"max":500,"step":0.01,"currency":"USD"},"price":{"min":2.01,"max":506,"currency":"USD"},"requiredInputs":[{"name":"recipientEmail","type":"email","required":false,"description":"Sends the card to this email address as a gift."},{"name":"giftMessage","type":"text","required":false,"description":"Message included in the gift email."}]}],"details":{"isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}}],"pagination":{"currentCount":1,"totalCount":1,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardSearchResult"},"examples":{"brandWithFixedAndRangeOffers":{"summary":"One brand with a 50 USD card and a 1-500 USD range card.","value":{"items":[{"id":"card_tzkc6b2xcqznidhkouwh2rz7wi","name":"Amazon","countryCode":"US","category":"shopping","logoUrl":"https://cdn.openroam.test/amazon.png","description":"Redeem at amazon.com","offers":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","name":"Amazon 50 USD","description":null,"value":{"type":"fixed","amount":50,"currency":"USD"},"price":{"amount":48.98,"currency":"USD"},"requiredInputs":[{"name":"recipientEmail","type":"email","required":false,"description":"Sends the card to this email address as a gift."},{"name":"giftMessage","type":"text","required":false,"description":"Message included in the gift email."}]},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","name":"Amazon 1–500 USD","description":null,"value":{"type":"range","min":1,"max":500,"step":0.01,"currency":"USD"},"price":{"min":2.01,"max":506,"currency":"USD"},"requiredInputs":[{"name":"recipientEmail","type":"email","required":false,"description":"Sends the card to this email address as a gift."},{"name":"giftMessage","type":"text","required":false,"description":"Message included in the gift email."}]}],"details":{"isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}}],"pagination":{"currentCount":1,"totalCount":1,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/GiftCardSearchResult"},"examples":{"brandWithFixedAndRangeOffers":{"summary":"One brand with a 50 USD card and a 1-500 USD range card.","value":{"items":[{"id":"card_tzkc6b2xcqznidhkouwh2rz7wi","name":"Amazon","countryCode":"US","category":"shopping","logoUrl":"https://cdn.openroam.test/amazon.png","description":"Redeem at amazon.com","offers":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","name":"Amazon 50 USD","description":null,"value":{"type":"fixed","amount":50,"currency":"USD"},"price":{"amount":48.98,"currency":"USD"},"requiredInputs":[{"name":"recipientEmail","type":"email","required":false,"description":"Sends the card to this email address as a gift."},{"name":"giftMessage","type":"text","required":false,"description":"Message included in the gift email."}]},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","name":"Amazon 1–500 USD","description":null,"value":{"type":"range","min":1,"max":500,"step":0.01,"currency":"USD"},"price":{"min":2.01,"max":506,"currency":"USD"},"requiredInputs":[{"name":"recipientEmail","type":"email","required":false,"description":"Sends the card to this email address as a gift."},{"name":"giftMessage","type":"text","required":false,"description":"Message included in the gift email."}]}],"details":{"isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}}],"pagination":{"currentCount":1,"totalCount":1,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Gift cards"}},"/v1/giftcards/catalog":{"get":{"tags":["GiftCards"],"summary":"Gift card catalog","description":"Returns every gift card with its offers, page by page, for partner inventory.\n\nReturns `{ items, nextCursor }`, ordered by card ID, with the search filters except `q`. Continue with\n`nextCursor` as `cursor`, the same filters and the same `currency` until it is null; a page can\nhold fewer cards than `limit`, even none, while `nextCursor` is not null. A cursor reused with other\nfilters or another currency gives 400 / 10001. The walk is not a frozen snapshot: a card that appears or\ndisappears during it may be missing. Quote confirms the final price and availability.","operationId":"giftCardsGetCatalog","parameters":[{"name":"countryCode","in":"query","description":"Optional ISO 3166-1 alpha-2 issuing country, in either case; every country when omitted. A card without a country is not listed when it is set, and a blank value or `GLOBAL` is rejected.","schema":{"type":"string"},"examples":{"default":{"value":"US"}}},{"name":"category","in":"query","description":"Keep the cards of this category; `categories` lists the values.","schema":{"enum":["shopping","foodAndDining","entertainment","gaming","travel","paymentCards","softwareAndDigital","other"],"type":"string"},"examples":{"default":{"value":"shopping"}}},{"name":"valueType","in":"query","description":"Keep only `fixed` or only `range` offers; a card left without an offer is dropped.","schema":{"enum":["fixed","range"],"type":"string"},"examples":{"default":{"value":"range"}}},{"name":"isRedeemableGlobally","in":"query","description":"`true` keeps only cards that can be redeemed in any country.","schema":{"type":"boolean"},"examples":{"default":{"value":false}}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}},{"name":"cursor","in":"query","description":"The `nextCursor` of the previous page; omit it for the first page. Reuse it only with the same filters and currency.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 100.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GiftCardCatalogPage"}},"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardCatalogPage"}},"text/json":{"schema":{"$ref":"#/components/schemas/GiftCardCatalogPage"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Gift cards"}},"/v1/giftcards/cards/{id}":{"get":{"tags":["GiftCards"],"summary":"Get a gift card","description":"Returns one gift card with its offers, in the item shape that search returns.\n\nAn unknown or unparseable ID, or a card without an orderable offer, gives 404 / 10004.","operationId":"giftCardsGetCard","parameters":[{"name":"id","in":"path","description":"The card's `id` (`card_…`) from search or the catalog.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"card_tzkc6b2xcqznidhkouwh2rz7wi"}}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GiftCard"}},"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}},"text/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Gift cards"}},"/v1/giftcards/order":{"post":{"tags":["GiftCards"],"summary":"Order gift cards","description":"Places a gift card order and returns the accepted order.\n\nTakes the same body as quote and needs the `manage` order permission (403 / 10003 without it).\nAn `Idempotency-Key` header with a new UUID is required for every purchase: a retry with the same key and body\nreturns the order already accepted, 409 / 12002 with `Retry-After` while it is still being accepted, and a\nchanged body gives 409 / 12001.\nOrder with the `publicId` a quote returned. Every price is recalculated: a current price above\n`inputs.maxPrice` gives 409 / 11002 at `items[i].inputs.maxPrice` before anything is charged. Each card\nof an item's `quantity` becomes its own order item; read the codes from the order routes or the\n`order.fulfillment.updated` webhook. A wallet charge that fails creates no order and gives 402 / 16000,\nwith `details[0]` naming `wallet` and `INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`; send the\nsame request with the same key after a top-up.","operationId":"giftCardsCreateOrder","parameters":[{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GiftCardOrderRequest"}],"description":"The body B2B gift card quote and order both take."},"examples":{"twoGiftCards":{"summary":"A fixed gift card, and a ranged one sent to a recipient with a message.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","quantity":1,"inputs":{"maxPrice":{"amount":50,"currency":"USD"}}},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","quantity":1,"inputs":{"recipientEmail":"friend@example.com","giftMessage":"Happy birthday!","value":{"amount":25,"currency":"USD"},"maxPrice":{"amount":30,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GiftCardOrderRequest"}],"description":"The body B2B gift card quote and order both take."},"examples":{"twoGiftCards":{"summary":"A fixed gift card, and a ranged one sent to a recipient with a message.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","quantity":1,"inputs":{"maxPrice":{"amount":50,"currency":"USD"}}},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","quantity":1,"inputs":{"recipientEmail":"friend@example.com","giftMessage":"Happy birthday!","value":{"amount":25,"currency":"USD"},"maxPrice":{"amount":30,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GiftCardOrderRequest"}],"description":"The body B2B gift card quote and order both take."},"examples":{"twoGiftCards":{"summary":"A fixed gift card, and a ranged one sent to a recipient with a message.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","quantity":1,"inputs":{"maxPrice":{"amount":50,"currency":"USD"}}},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","quantity":1,"inputs":{"recipientEmail":"friend@example.com","giftMessage":"Happy birthday!","value":{"amount":25,"currency":"USD"},"maxPrice":{"amount":30,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GiftCardOrder"},"examples":{"paidOrderWithTwoGiftCards":{"summary":"The order as placed: paid from the wallet and processing, both cards still pending.","value":{"id":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":75.23,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":75.23,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":75.23,"currency":"USD"}},"failure":null},"items":[{"id":"01a1413c-265f-7a02-b7c4-1e3f5a7c9d20","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":48.98,"currency":"USD"},"purchasedProduct":{"name":"Amazon 50 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":50,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":null,"giftMessage":null},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"pending","result":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":48.98,"currency":"USD"}},{"id":"01a1413c-265f-77b1-9041-25aee298d4d0","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":26.25,"currency":"USD"},"purchasedProduct":{"name":"Amazon 25 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":25,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":"f***@example.com","giftMessage":"Happy birthday!"},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"pending","result":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":26.25,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}},"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardOrder"},"examples":{"paidOrderWithTwoGiftCards":{"summary":"The order as placed: paid from the wallet and processing, both cards still pending.","value":{"id":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":75.23,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":75.23,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":75.23,"currency":"USD"}},"failure":null},"items":[{"id":"01a1413c-265f-7a02-b7c4-1e3f5a7c9d20","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":48.98,"currency":"USD"},"purchasedProduct":{"name":"Amazon 50 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":50,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":null,"giftMessage":null},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"pending","result":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":48.98,"currency":"USD"}},{"id":"01a1413c-265f-77b1-9041-25aee298d4d0","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":26.25,"currency":"USD"},"purchasedProduct":{"name":"Amazon 25 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":25,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":"f***@example.com","giftMessage":"Happy birthday!"},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"pending","result":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":26.25,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}},"text/json":{"schema":{"$ref":"#/components/schemas/GiftCardOrder"},"examples":{"paidOrderWithTwoGiftCards":{"summary":"The order as placed: paid from the wallet and processing, both cards still pending.","value":{"id":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":75.23,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":75.23,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":75.23,"currency":"USD"}},"failure":null},"items":[{"id":"01a1413c-265f-7a02-b7c4-1e3f5a7c9d20","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":48.98,"currency":"USD"},"purchasedProduct":{"name":"Amazon 50 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":50,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":null,"giftMessage":null},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"pending","result":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":48.98,"currency":"USD"}},{"id":"01a1413c-265f-77b1-9041-25aee298d4d0","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":26.25,"currency":"USD"},"purchasedProduct":{"name":"Amazon 25 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":25,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":"f***@example.com","giftMessage":"Happy birthday!"},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"pending","result":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":26.25,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"402":{"description":"Payment Required","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}}}},"409":{"description":"The offer changed since it was quoted: its price rose (11002, for products that check the quoted price) or it is no longer available (11003). Or the idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; it was used for a different request (12001); or its history is ambiguous.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Gift cards"}},"/v1/giftcards/quote":{"post":{"tags":["GiftCards"],"summary":"Quote gift cards","description":"Prices the order body with current prices, without placing an order.\n\nTakes the same body as order and checks it the same way: each item completely (its inputs, then its\n`publicId`, then its price) before the next, in request order. The first failure aborts the quote and is\nnamed at `items[i]`, as the order names it, for example 409 / 11002 at `items[i].inputs.maxPrice` when\nthe current price is above it. A range offer may be quoted on an equivalent offer of the same card that\nsells the same value for less: the item then returns that offer's `publicId`, which the order should\nuse.","operationId":"giftCardsQuote","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GiftCardOrderRequest"}],"description":"The body B2B gift card quote and order both take."},"examples":{"twoGiftCards":{"summary":"A fixed gift card, and a ranged one sent to a recipient with a message.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","quantity":1,"inputs":{"maxPrice":{"amount":50,"currency":"USD"}}},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","quantity":1,"inputs":{"recipientEmail":"friend@example.com","giftMessage":"Happy birthday!","value":{"amount":25,"currency":"USD"},"maxPrice":{"amount":30,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GiftCardOrderRequest"}],"description":"The body B2B gift card quote and order both take."},"examples":{"twoGiftCards":{"summary":"A fixed gift card, and a ranged one sent to a recipient with a message.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","quantity":1,"inputs":{"maxPrice":{"amount":50,"currency":"USD"}}},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","quantity":1,"inputs":{"recipientEmail":"friend@example.com","giftMessage":"Happy birthday!","value":{"amount":25,"currency":"USD"},"maxPrice":{"amount":30,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GiftCardOrderRequest"}],"description":"The body B2B gift card quote and order both take."},"examples":{"twoGiftCards":{"summary":"A fixed gift card, and a ranged one sent to a recipient with a message.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","quantity":1,"inputs":{"maxPrice":{"amount":50,"currency":"USD"}}},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","quantity":1,"inputs":{"recipientEmail":"friend@example.com","giftMessage":"Happy birthday!","value":{"amount":25,"currency":"USD"},"maxPrice":{"amount":30,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/GiftCardQuote"},"examples":{"twoGiftCards":{"summary":"The prices of the two gift cards and their total.","value":{"currency":"USD","items":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","quantity":1,"name":"Amazon 50 USD","value":{"amount":50,"currency":"USD"},"price":{"amount":48.98,"currency":"USD"}},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","quantity":1,"name":"Amazon 25 USD","value":{"amount":25,"currency":"USD"},"price":{"amount":26.25,"currency":"USD"}}],"total":{"amount":75.23,"currency":"USD"}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardQuote"},"examples":{"twoGiftCards":{"summary":"The prices of the two gift cards and their total.","value":{"currency":"USD","items":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","quantity":1,"name":"Amazon 50 USD","value":{"amount":50,"currency":"USD"},"price":{"amount":48.98,"currency":"USD"}},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","quantity":1,"name":"Amazon 25 USD","value":{"amount":25,"currency":"USD"},"price":{"amount":26.25,"currency":"USD"}}],"total":{"amount":75.23,"currency":"USD"}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/GiftCardQuote"},"examples":{"twoGiftCards":{"summary":"The prices of the two gift cards and their total.","value":{"currency":"USD","items":[{"publicId":"giftcard_p5udmgvqke2bcrwlk35drsqfqm","quantity":1,"name":"Amazon 50 USD","value":{"amount":50,"currency":"USD"},"price":{"amount":48.98,"currency":"USD"}},{"publicId":"giftcard_tm4m2tnb4u3dlthj3pvo6zqkha","quantity":1,"name":"Amazon 25 USD","value":{"amount":25,"currency":"USD"},"price":{"amount":26.25,"currency":"USD"}}],"total":{"amount":75.23,"currency":"USD"}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"409":{"description":"Conflict","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Gift cards"}},"/v1/order-items/{id}/manual-amendments":{"post":{"tags":["HotelManualAmendments"],"summary":"Request a manual amendment","description":"Requests a manual change to a confirmed hotel booking.\n\nRequires an `Idempotency-Key` header (a UUID) and an API key with order-manage permission. Send the\nrequested change as `attributes`: new `checkInDate` and `checkOutDate`, `holder` or\n`roomGuests` (one entry per booked room, `roomIndex` 1-based); anything omitted keeps its booked\nvalue. Returns `{ amendmentId }`; the request starts as `Pending` and nothing is charged until you\napprove a quote.\n            \nThe order item must be fulfilled, not refunded, use the manual amendment flow and have no open request\n(`Pending`, `InProgress`, `Quoted` or `PartnerApproved`). Errors: 400 / 21100 invalid\nrequest, 21101 booking not amendable, 21102 a request is already open, 21104 manual amendments not available,\n21113 or 21114 invalid or unsupported room and guest changes; 404 / 10004 when the order item is not found.\n            \nThe same key after the request finished gives 409 / 12000: read the request it created with\n`GET /order-items/{id}/amendments`. While it is still running the key gives 409 / 12002 with\n`Retry-After`, and with a different body 409 / 12001.","operationId":"hotelManualAmendmentsCreateManualAmendment","parameters":[{"name":"id","in":"path","description":"The hotel order item's `id`, from `items[].id` of the order.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"description":"The requested change.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ManualAmendmentCreateRequest"}],"description":"A manual amendment request for a hotel booking."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ManualAmendmentCreateRequest"}],"description":"A manual amendment request for a hotel booking."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ManualAmendmentCreateRequest"}],"description":"A manual amendment request for a hotel booking."}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}},"application/json":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"409":{"description":"The idempotency key: it was used by a request that finished (12000), so use a new key for a new request; a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; or it was used for a different request (12001).","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotel amendments"}},"/v1/order-items/{id}/manual-amendments/{amendmentId}/cancel":{"post":{"tags":["HotelManualAmendments"],"summary":"Cancel a manual amendment","description":"Cancels a manual amendment request that has not been worked on yet.\n\nOnly a `Pending` request can be cancelled; once it is `Quoted`, decline it instead. No body. Returns\n`{ amendmentId }` and moves the request to `Cancelled`. Errors: 400 / 21103 in any other status,\n400 / 21104 when the booking does not use manual amendments, 404 / 10004 when not found.","operationId":"hotelManualAmendmentsCancelManualAmendment","parameters":[{"name":"id","in":"path","description":"The hotel order item's `id`, from `items[].id` of the order.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"amendmentId","in":"path","description":"The `amendmentId` returned when the request was created.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}},"application/json":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotel amendments"}},"/v1/order-items/{id}/manual-amendments/{amendmentId}/approve":{"post":{"tags":["HotelManualAmendments"],"summary":"Approve a manual amendment","description":"Approves the quoted price of a manual amendment and settles it from your wallet.\n\nRequires an `Idempotency-Key` header (a UUID). Only a `Quoted` request can be approved: show the\nquoted `amountToPay` or `amountToRefund` first. On approval `amountToPay` is debited and the\nrequest becomes `PartnerApproved`; `amountToRefund` is credited only after the change is confirmed.\nThe body is optional; `walletId` picks the wallet to settle from. Returns `{ amendmentId }`.\n            \nErrors: 400 / 21103 when the request is not `Quoted`; 400 / 21107 when the wallet balance is too low\n(the request stays `Quoted`; top up and approve again); 400 / 21106 when changing the wallet while an\napproval is in progress; 21105 or 21108–21112 for settlement and concurrency failures (reload the request\nand contact support before retrying a 21108).\n            \nThe same key and body after the approval finished returns `{ amendmentId }` again and approves and charges\nnothing again. While it is still running the key gives 409 / 12002 with `Retry-After`, and with a\ndifferent body 409 / 12001.","operationId":"hotelManualAmendmentsApproveManualAmendment","parameters":[{"name":"id","in":"path","description":"The hotel order item's `id`, from `items[].id` of the order.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"amendmentId","in":"path","description":"The `amendmentId` returned when the request was created.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"description":"Optional settlement choice.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ManualAmendmentApproveRequest"}],"description":"Approval of a quoted manual amendment."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ManualAmendmentApproveRequest"}],"description":"Approval of a quoted manual amendment."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ManualAmendmentApproveRequest"}],"description":"Approval of a quoted manual amendment."}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}},"application/json":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"409":{"description":"The idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; or it was used for a different request (12001). A finished request sent again with the same key and body returns 200 with the result of the first call, rebuilt from the record that call created as it reads now: nothing runs again, and a status that has moved on since shows its current value.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotel amendments"}},"/v1/order-items/{id}/manual-amendments/{amendmentId}/decline":{"post":{"tags":["HotelManualAmendments"],"summary":"Decline a manual amendment","description":"Declines the quoted price of a manual amendment.\n\nOnly a `Quoted` request can be declined. No body and no money moves. Returns `{ amendmentId }` and\nmoves the request to `Cancelled`; the booking is unchanged. Errors: 400 / 21103 in any other status,\n404 / 10004 when not found.","operationId":"hotelManualAmendmentsDeclineManualAmendment","parameters":[{"name":"id","in":"path","description":"The hotel order item's `id`, from `items[].id` of the order.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"amendmentId","in":"path","description":"The `amendmentId` returned when the request was created.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}},"application/json":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/ManualAmendmentResult"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotel amendments"}},"/v1/hotels/search":{"post":{"tags":["Hotels"],"summary":"Search hotels","description":"Searches hotels by location or hotel IDs and returns their bookable rates for the stay.\n\nSend `searchCriteria.location` or `searchCriteria.hotelIds`; a non-empty `hotelIds` wins and\n`location` is then ignored. `checkIn`, `checkOut`, `rooms` and `guestNationality`\nare required: rates are priced for the occupancy, child ages and guest market sent here. A stay longer than\n30 nights returns 400 / 10001 with reason `MAX_STAY_EXCEEDED` at `checkOut`. The body rejects an\nunknown member at every level, `filters`, `searchCriteria.location` and `rooms[]` included,\nand the route takes no query parameters: either gives 400 / 10001.\n            \nReturns `{ items, pagination, nextCursor, details }`. Each item is a hotel: `id`, `name`,\n`countryCode`, `category` (always null), `logoUrl` (the main image), `description`, its\n`offers`, and `details` with the star rating, address, coordinates, images, amenity groups and\ncontact. Each offer is one rate: an opaque `publicId`, a `name` such as \"Deluxe King, Breakfast,\nFree cancellation\", a `price` for the whole stay (all rooms and nights), and the rate terms in\n`details`, including `expiresAt`. Pass an offer's\n`publicId` to quote or order before it expires. The hotel's `id` is not an offer; send it in\n`searchCriteria.hotelIds` to search that hotel again. A hotel without an orderable offer is not\nlisted. `details.availableFilters` holds the amenity filter values of a `cityCode` search.\n            \nLocation searches are paged: `limit` is 1–50 (default 20) and the next page is requested by sending\nthe response's `nextCursor` back as `cursor` with the same body; a null `nextCursor` is the\nlast page. A page can hold fewer hotels than `limit`, even none, while `nextCursor` is not null:\nkeep paging until it is null. `pagination` is `{ currentCount, limit, hasMore }`: the walk states\nno page number and no total. To keep pages small, each hotel on a page has one offer, its cheapest rate,\nwith empty `nightlyPrices` and `surcharges`, and no description and one image. A\n`hotelIds` search returns every rate of those hotels with the full detail, as one complete page; an\nempty `items` there means none of those hotels has an orderable offer.\n            \nErrors: an ID that is not a hotel ID returns 400 / 21000; an unknown or expired hotel ID 400 / 11004;\n503 / 21003 when offers are temporarily unavailable (retry the search); 502, 504 or 503 with\n21007–21009 when the hotel system fails, times out or is unavailable.","operationId":"hotelsSearch","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HotelSearchRequest"}],"description":"Hotel search: where to search, the stay, the rooms, the guest market and the price currency."},"examples":{"byLocationWithFilters":{"summary":"A search of a location node for two adults and a child, with filters.","value":{"searchCriteria":{"location":{"geoNodeId":"42ea4cba-6d1b-1c24-9428-b2c2678b1062"}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2,"children":1,"childrenAges":[7]}],"guestNationality":"GB","currency":"USD","filters":{"minStarRating":4,"boardTypes":["breakfast"],"maxPrice":900},"limit":20}},"byCityCode":{"summary":"A search of a city by its code.","value":{"searchCriteria":{"location":{"cityCode":"DXB"}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2}],"guestNationality":"AE"}},"byCoordinates":{"summary":"A search around a point, within a radius.","value":{"searchCriteria":{"location":{"coordinates":{"latitude":25.2048,"longitude":55.2708},"radiusKm":15}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2}],"guestNationality":"AE"}},"nextPage":{"summary":"The next page: the same body with the cursor of the previous response.","value":{"searchCriteria":{"location":{"cityCode":"DXB"}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2}],"guestNationality":"AE","limit":20,"cursor":"bzoyMA=="}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HotelSearchRequest"}],"description":"Hotel search: where to search, the stay, the rooms, the guest market and the price currency."},"examples":{"byLocationWithFilters":{"summary":"A search of a location node for two adults and a child, with filters.","value":{"searchCriteria":{"location":{"geoNodeId":"42ea4cba-6d1b-1c24-9428-b2c2678b1062"}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2,"children":1,"childrenAges":[7]}],"guestNationality":"GB","currency":"USD","filters":{"minStarRating":4,"boardTypes":["breakfast"],"maxPrice":900},"limit":20}},"byCityCode":{"summary":"A search of a city by its code.","value":{"searchCriteria":{"location":{"cityCode":"DXB"}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2}],"guestNationality":"AE"}},"byCoordinates":{"summary":"A search around a point, within a radius.","value":{"searchCriteria":{"location":{"coordinates":{"latitude":25.2048,"longitude":55.2708},"radiusKm":15}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2}],"guestNationality":"AE"}},"nextPage":{"summary":"The next page: the same body with the cursor of the previous response.","value":{"searchCriteria":{"location":{"cityCode":"DXB"}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2}],"guestNationality":"AE","limit":20,"cursor":"bzoyMA=="}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HotelSearchRequest"}],"description":"Hotel search: where to search, the stay, the rooms, the guest market and the price currency."},"examples":{"byLocationWithFilters":{"summary":"A search of a location node for two adults and a child, with filters.","value":{"searchCriteria":{"location":{"geoNodeId":"42ea4cba-6d1b-1c24-9428-b2c2678b1062"}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2,"children":1,"childrenAges":[7]}],"guestNationality":"GB","currency":"USD","filters":{"minStarRating":4,"boardTypes":["breakfast"],"maxPrice":900},"limit":20}},"byCityCode":{"summary":"A search of a city by its code.","value":{"searchCriteria":{"location":{"cityCode":"DXB"}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2}],"guestNationality":"AE"}},"byCoordinates":{"summary":"A search around a point, within a radius.","value":{"searchCriteria":{"location":{"coordinates":{"latitude":25.2048,"longitude":55.2708},"radiusKm":15}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2}],"guestNationality":"AE"}},"nextPage":{"summary":"The next page: the same body with the cursor of the previous response.","value":{"searchCriteria":{"location":{"cityCode":"DXB"}},"checkIn":"2026-12-10","checkOut":"2026-12-13","rooms":[{"adults":2}],"guestNationality":"AE","limit":20,"cursor":"bzoyMA=="}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/HotelSearchResult"},"examples":{"singleHotelAllRates":{"summary":"The rates of one hotel, with its full detail.","value":{"items":[{"id":"hotel_q7m2k4t6v3x5z2b4d6f3h5jn2p","name":"Hotel Arts Barcelona","countryCode":"ES","category":null,"logoUrl":"https://cdn.openroam.test/hotels/hotel_q7m2k4t6v3x5z2b4d6f3h5jn2p/1c3fc0de.jpg","description":"<p>A seafront tower in the Olympic Port.</p>","offers":[{"publicId":"rate_x5z2b4d6f3h5jn2pq7m2k4t6v3","name":"Deluxe King, Breakfast, Free cancellation","description":null,"price":{"amount":642.1,"currency":"USD"},"details":{"expiresAt":"2026-12-01T10:30:00Z","rooms":[{"roomGroupKey":"4c8e3ae1d379f759bc372243","name":"Deluxe King","description":null,"beds":[],"maxOccupancy":3,"sizeSquareMeters":null,"amenities":[],"imageUrls":[],"roomIndex":1,"adultsCount":2,"childrenCount":1,"childrenAges":[7]}],"board":{"code":"BB","name":"Bed and breakfast","boardType":"breakfast"},"terms":{"payment":{"type":"payNow","dueNow":{"amount":642.1,"currency":"USD"},"dueLater":null,"dueLaterAt":null},"cancellation":{"type":"fullyRefundable","freeUntil":"2026-12-08T23:59:00Z","freeUntilLocalTime":"2026-12-09T00:59:00","timezone":"Europe/Madrid","schedule":[{"from":"2026-12-08T23:59:00Z","fromLocalTime":"2026-12-09T00:59:00","refund":{"amount":428.07,"currency":"USD"},"penalty":{"amount":214.03,"currency":"USD"}}],"fee":null},"changes":{"allowed":true,"fee":null}},"taxes":{"included":true,"totalTaxAmount":41.2,"items":[]},"priceIsBinding":true,"nightlyPrices":[{"date":"2026-12-10","amount":214.03,"currency":"USD"},{"date":"2026-12-11","amount":214.03,"currency":"USD"},{"date":"2026-12-12","amount":214.04,"currency":"USD"}],"surcharges":[{"type":"AtProperty","description":"City Tax","price":{"amount":12.45,"currency":"EUR"},"approxPrice":{"amount":13.5,"currency":"USD"},"includedInTotal":false,"payableAt":"property"}],"rateTags":[],"remarks":[],"withTransfers":false,"rateRules":[],"amendabilityStatus":"yes","guestNameRules":{"minLength":1,"maxLength":50,"pattern":"^(?=.*[a-zA-Z])[a-zA-Z\\s\\-'\\.]+$","allowedCharacters":"letters, spaces, hyphens, apostrophes and periods","distinctFullNames":false}}}],"details":{"starRating":5,"address":{"line1":"Carrer de la Marina 19-21","line2":null,"city":"Barcelona","stateProvince":null,"postalCode":"08005","countryCode":"ES","countryName":null},"coordinates":{"latitude":41.386,"longitude":2.196},"imageUrls":["https://cdn.openroam.test/hotels/hotel_q7m2k4t6v3x5z2b4d6f3h5jn2p/7a90c0de.jpg"],"amenityGroups":[{"key":"PropertyAmenities","codes":["FreeWifi","Pool"]}],"contact":null,"displayGroup":null}}],"pagination":{"currentCount":1,"limit":1,"hasMore":false},"nextCursor":null,"details":{"availableFilters":null}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/HotelSearchResult"},"examples":{"singleHotelAllRates":{"summary":"The rates of one hotel, with its full detail.","value":{"items":[{"id":"hotel_q7m2k4t6v3x5z2b4d6f3h5jn2p","name":"Hotel Arts Barcelona","countryCode":"ES","category":null,"logoUrl":"https://cdn.openroam.test/hotels/hotel_q7m2k4t6v3x5z2b4d6f3h5jn2p/1c3fc0de.jpg","description":"<p>A seafront tower in the Olympic Port.</p>","offers":[{"publicId":"rate_x5z2b4d6f3h5jn2pq7m2k4t6v3","name":"Deluxe King, Breakfast, Free cancellation","description":null,"price":{"amount":642.1,"currency":"USD"},"details":{"expiresAt":"2026-12-01T10:30:00Z","rooms":[{"roomGroupKey":"4c8e3ae1d379f759bc372243","name":"Deluxe King","description":null,"beds":[],"maxOccupancy":3,"sizeSquareMeters":null,"amenities":[],"imageUrls":[],"roomIndex":1,"adultsCount":2,"childrenCount":1,"childrenAges":[7]}],"board":{"code":"BB","name":"Bed and breakfast","boardType":"breakfast"},"terms":{"payment":{"type":"payNow","dueNow":{"amount":642.1,"currency":"USD"},"dueLater":null,"dueLaterAt":null},"cancellation":{"type":"fullyRefundable","freeUntil":"2026-12-08T23:59:00Z","freeUntilLocalTime":"2026-12-09T00:59:00","timezone":"Europe/Madrid","schedule":[{"from":"2026-12-08T23:59:00Z","fromLocalTime":"2026-12-09T00:59:00","refund":{"amount":428.07,"currency":"USD"},"penalty":{"amount":214.03,"currency":"USD"}}],"fee":null},"changes":{"allowed":true,"fee":null}},"taxes":{"included":true,"totalTaxAmount":41.2,"items":[]},"priceIsBinding":true,"nightlyPrices":[{"date":"2026-12-10","amount":214.03,"currency":"USD"},{"date":"2026-12-11","amount":214.03,"currency":"USD"},{"date":"2026-12-12","amount":214.04,"currency":"USD"}],"surcharges":[{"type":"AtProperty","description":"City Tax","price":{"amount":12.45,"currency":"EUR"},"approxPrice":{"amount":13.5,"currency":"USD"},"includedInTotal":false,"payableAt":"property"}],"rateTags":[],"remarks":[],"withTransfers":false,"rateRules":[],"amendabilityStatus":"yes","guestNameRules":{"minLength":1,"maxLength":50,"pattern":"^(?=.*[a-zA-Z])[a-zA-Z\\s\\-'\\.]+$","allowedCharacters":"letters, spaces, hyphens, apostrophes and periods","distinctFullNames":false}}}],"details":{"starRating":5,"address":{"line1":"Carrer de la Marina 19-21","line2":null,"city":"Barcelona","stateProvince":null,"postalCode":"08005","countryCode":"ES","countryName":null},"coordinates":{"latitude":41.386,"longitude":2.196},"imageUrls":["https://cdn.openroam.test/hotels/hotel_q7m2k4t6v3x5z2b4d6f3h5jn2p/7a90c0de.jpg"],"amenityGroups":[{"key":"PropertyAmenities","codes":["FreeWifi","Pool"]}],"contact":null,"displayGroup":null}}],"pagination":{"currentCount":1,"limit":1,"hasMore":false},"nextCursor":null,"details":{"availableFilters":null}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/HotelSearchResult"},"examples":{"singleHotelAllRates":{"summary":"The rates of one hotel, with its full detail.","value":{"items":[{"id":"hotel_q7m2k4t6v3x5z2b4d6f3h5jn2p","name":"Hotel Arts Barcelona","countryCode":"ES","category":null,"logoUrl":"https://cdn.openroam.test/hotels/hotel_q7m2k4t6v3x5z2b4d6f3h5jn2p/1c3fc0de.jpg","description":"<p>A seafront tower in the Olympic Port.</p>","offers":[{"publicId":"rate_x5z2b4d6f3h5jn2pq7m2k4t6v3","name":"Deluxe King, Breakfast, Free cancellation","description":null,"price":{"amount":642.1,"currency":"USD"},"details":{"expiresAt":"2026-12-01T10:30:00Z","rooms":[{"roomGroupKey":"4c8e3ae1d379f759bc372243","name":"Deluxe King","description":null,"beds":[],"maxOccupancy":3,"sizeSquareMeters":null,"amenities":[],"imageUrls":[],"roomIndex":1,"adultsCount":2,"childrenCount":1,"childrenAges":[7]}],"board":{"code":"BB","name":"Bed and breakfast","boardType":"breakfast"},"terms":{"payment":{"type":"payNow","dueNow":{"amount":642.1,"currency":"USD"},"dueLater":null,"dueLaterAt":null},"cancellation":{"type":"fullyRefundable","freeUntil":"2026-12-08T23:59:00Z","freeUntilLocalTime":"2026-12-09T00:59:00","timezone":"Europe/Madrid","schedule":[{"from":"2026-12-08T23:59:00Z","fromLocalTime":"2026-12-09T00:59:00","refund":{"amount":428.07,"currency":"USD"},"penalty":{"amount":214.03,"currency":"USD"}}],"fee":null},"changes":{"allowed":true,"fee":null}},"taxes":{"included":true,"totalTaxAmount":41.2,"items":[]},"priceIsBinding":true,"nightlyPrices":[{"date":"2026-12-10","amount":214.03,"currency":"USD"},{"date":"2026-12-11","amount":214.03,"currency":"USD"},{"date":"2026-12-12","amount":214.04,"currency":"USD"}],"surcharges":[{"type":"AtProperty","description":"City Tax","price":{"amount":12.45,"currency":"EUR"},"approxPrice":{"amount":13.5,"currency":"USD"},"includedInTotal":false,"payableAt":"property"}],"rateTags":[],"remarks":[],"withTransfers":false,"rateRules":[],"amendabilityStatus":"yes","guestNameRules":{"minLength":1,"maxLength":50,"pattern":"^(?=.*[a-zA-Z])[a-zA-Z\\s\\-'\\.]+$","allowedCharacters":"letters, spaces, hyphens, apostrophes and periods","distinctFullNames":false}}}],"details":{"starRating":5,"address":{"line1":"Carrer de la Marina 19-21","line2":null,"city":"Barcelona","stateProvince":null,"postalCode":"08005","countryCode":"ES","countryName":null},"coordinates":{"latitude":41.386,"longitude":2.196},"imageUrls":["https://cdn.openroam.test/hotels/hotel_q7m2k4t6v3x5z2b4d6f3h5jn2p/7a90c0de.jpg"],"amenityGroups":[{"key":"PropertyAmenities","codes":["FreeWifi","Pool"]}],"contact":null,"displayGroup":null}}],"pagination":{"currentCount":1,"limit":1,"hasMore":false},"nextCursor":null,"details":{"availableFilters":null}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Service Unavailable","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotels"}},"/v1/hotels/properties/{id}":{"get":{"tags":["Hotels"],"summary":"Get a hotel","description":"Returns one hotel's content: the item that search returns, without `offers`.\n\nUse it to show a hotel's information: name, description, star rating, address, images, amenities and\ncontact. A hotel has no price without a stay, so the response has no `offers` key; send the `id`\nin a search's `searchCriteria.hotelIds` for its rates. The route serves the hotels of the OpenRoam catalog,\nas the catalog files list them. An ID that is unknown, not a hotel ID, or not in the catalog (such as a\ntemporary ID a search gave a hotel outside the catalog) gives 404 / 10004. The route takes no query\nparameters.","operationId":"hotelsGetProperty","parameters":[{"name":"id","in":"path","description":"The hotel's `id` (`hotel_…`) from search or the catalog files.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"hotel_q7m2k4t6v3x5z2b4d6f3h5jn2p"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CatalogHotel"}},"application/json":{"schema":{"$ref":"#/components/schemas/CatalogHotel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CatalogHotel"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotels"}},"/v1/hotels/destinations":{"get":{"tags":["Hotels"],"summary":"Search hotel destinations","description":"Finds the places to search hotels in by name: a country, a region, a city or a district.\n\nReturns `{ items }`: at most `limit` places whose names match `q`, most relevant first, without\npaging. Send a place's `id` as `searchCriteria.location.geoNodeId` in a search; it finds the\nhotels of every place inside it. `name` includes the place's parents, for example \"Downtown Dubai,\nDubai, United Arab Emirates\", and `category` is its level: `country`, `region`, `city`\nor `area`. Only places where OpenRoam has had hotels are listed.\n            \n`q` is required: plain text, at most 100 characters, without control characters. `countryCode`\nkeeps the places of one ISO 3166-1 alpha-2 country; `limit` is 1–100 (default 10). An invalid or blank\nvalue, or any other query parameter, gives 400 / 10001. 503 / 10007 when the destination index is\nunavailable or does not answer within 5 seconds: retry.","operationId":"hotelsGetDestinations","parameters":[{"name":"q","in":"query","description":"Required. Free text over place names, for example `downtown dub`; at most 100 characters, without control characters.","required":true,"schema":{"type":"string"}},{"name":"countryCode","in":"query","description":"Optional ISO 3166-1 alpha-2 country, in either case: only places in that country. A blank value is rejected.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"The most places to return, 1 to 100; default 10.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/HotelDestinationList"}},"application/json":{"schema":{"$ref":"#/components/schemas/HotelDestinationList"}},"text/json":{"schema":{"$ref":"#/components/schemas/HotelDestinationList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Service Unavailable","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotels"}},"/v1/hotels/amenities/catalog":{"get":{"tags":["Hotels"],"summary":"List hotel amenities","description":"Returns the amenity catalog: every amenity code and group with its display label.\n\nUse it to label the `amenityGroups` codes in hotel content and to build an amenity filter; send codes\nback in search `filters.amenityCodes`. `notesLabel` is the heading for a hotel's uncoded\n`amenityNotes`. Labels follow the request language, as `Accept-Language` sets it; the route takes no\nquery parameters.","operationId":"hotelsGetAmenityCatalog","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AmenityCatalog"}},"application/json":{"schema":{"$ref":"#/components/schemas/AmenityCatalog"}},"text/json":{"schema":{"$ref":"#/components/schemas/AmenityCatalog"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotels"}},"/v1/hotels/catalog/files":{"get":{"tags":["Hotels"],"summary":"Get hotel catalog files","description":"Returns download links for the current hotel catalog files.\n\nReturns `{ generatedAt, hotelCount, files: [{ variant, url, sizeBytes }] }`, one zip per variant. Each\nzip holds `hotels.jsonl`: one hotel per line, in the item shape that search and\n`properties/{id}` return, with `offers` empty. `withoutImages` carries each hotel's main\nimage as `logoUrl` and an empty `details.imageUrls`; `withImages` also lists every gallery\nimage there. `generatedAt` is null and `files` empty before the first catalog is built, and after\na release that changes the line format until the first build in the new format: the route never links a\nfile whose lines have another format. The route takes no query parameters.","operationId":"hotelsGetCatalogFiles","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/HotelCatalogExport"}},"application/json":{"schema":{"$ref":"#/components/schemas/HotelCatalogExport"}},"text/json":{"schema":{"$ref":"#/components/schemas/HotelCatalogExport"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotels"}},"/v1/hotels/quote":{"post":{"tags":["Hotels"],"summary":"Quote hotel rates","description":"Prices up to 5 searched or quoted rates again with the hotel system and issues a new offer for each.\n\nTakes the same body as order, `{ currency, referenceId, items }`, and checks it the same way: the whole\nbody first, so a body error gives 400 / 10001 also when it is in a later item, then each item completely\n(its inputs, its `publicId`, then a fresh price from the hotel system) before the next, in request order.\n`inputs` may be left out; when sent, they are checked as the order checks them. The body and every\nobject in it reject an unknown member (400 / 10001). Stay dates and rooms come from the offer and are\nreturned in each item's `details`. Nothing is charged or reserved.\n            \nEach item returns a new `publicId` for its rate at the current `price` (the whole stay, all rooms\nand nights): order with it before `details.expiresAt`, which is at most 30 minutes away and never past\nan expiry the hotel system states. A price that rose since the search is returned with 200; only\n`inputs.maxPrice` stops a quote, with 409 / 11002 at `items[i].inputs.maxPrice`.\n`details.availability` is `onRequest` for a rate that is held only on request, which an\norder refuses with 409 / 11003.\n            \nErrors name the failing item: a rate that is no longer sold is 409 / 11003, and an unknown, expired or\nanother partner's `publicId`, another product's offer, a hotel's own `id` or an expired search\nsession (search again) is 400 / 11004, each at `items[i]`; input errors (400 / 10001) are at\n`items[i].inputs…`. Offer and hotel-system failures return their hotel codes without a path:\n503 / 21003 when offers are temporarily unavailable, 21007–21009, and 400 / 21010 when the hotel's room\nlayout no longer matches the searched occupancy (search again).","operationId":"hotelsQuote","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HotelOrderRequest"}],"description":"The body of a B2B hotel quote and order: the currency, an optional reference and the rates to price or book."},"examples":{"hotelOffer":{"summary":"The offer of the search, priced again.","value":{"currency":"USD","items":[{"publicId":"rate_x5z2b4d6f3h5jn2pq7m2k4t6v3"}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HotelOrderRequest"}],"description":"The body of a B2B hotel quote and order: the currency, an optional reference and the rates to price or book."},"examples":{"hotelOffer":{"summary":"The offer of the search, priced again.","value":{"currency":"USD","items":[{"publicId":"rate_x5z2b4d6f3h5jn2pq7m2k4t6v3"}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HotelOrderRequest"}],"description":"The body of a B2B hotel quote and order: the currency, an optional reference and the rates to price or book."},"examples":{"hotelOffer":{"summary":"The offer of the search, priced again.","value":{"currency":"USD","items":[{"publicId":"rate_x5z2b4d6f3h5jn2pq7m2k4t6v3"}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/HotelQuote"},"examples":{"priceRoseToNewOffer":{"summary":"The price rose from 642.10 to 648.90 USD, so the quote returns a new publicId at that price.","value":{"currency":"USD","items":[{"publicId":"rate_b4d6f3h5jn2pq7m2k4t6v3x5z2","quantity":1,"name":"Hotel Arts Barcelona · Deluxe King, Breakfast, Free cancellation","price":{"amount":648.9,"currency":"USD"},"details":{"expiresAt":"2026-12-01T10:42:00Z","availability":"confirmed","checkInDate":"2026-12-10","checkOutDate":"2026-12-13","requestedRooms":[{"adults":2,"children":1,"childrenAges":[7]}],"terms":{"payment":{"type":"payNow","dueNow":{"amount":648.9,"currency":"USD"},"dueLater":null,"dueLaterAt":null},"cancellation":{"type":"fullyRefundable","freeUntil":"2026-12-08T23:59:00Z","freeUntilLocalTime":"2026-12-09T00:59:00","timezone":"Europe/Madrid","schedule":[{"from":"2026-12-08T23:59:00Z","fromLocalTime":"2026-12-09T00:59:00","refund":{"amount":432.6,"currency":"USD"},"penalty":{"amount":216.3,"currency":"USD"}}],"fee":null},"changes":{"allowed":true,"fee":null}},"rate":{"rooms":[{"roomGroupKey":"4c8e3ae1d379f759bc372243","name":"Deluxe King","description":null,"beds":[],"maxOccupancy":3,"sizeSquareMeters":null,"amenities":[],"imageUrls":[],"roomIndex":1,"adultsCount":2,"childrenCount":1,"childrenAges":[7]}],"board":{"code":"BB","name":"Bed and breakfast","boardType":"breakfast"},"taxes":{"included":true,"totalTaxAmount":41.64,"items":[]},"priceIsBinding":true,"nightlyPrices":[{"date":"2026-12-10","amount":216.3,"currency":"USD"},{"date":"2026-12-11","amount":216.3,"currency":"USD"},{"date":"2026-12-12","amount":216.3,"currency":"USD"}],"rateTags":[],"remarks":[],"rateConditions":[],"withTransfers":false,"rateRules":[],"amendabilityStatus":"yes","surcharges":[{"type":"AtProperty","description":"City Tax","price":{"amount":12.45,"currency":"EUR"},"approxPrice":{"amount":13.5,"currency":"USD"},"includedInTotal":false,"payableAt":"property"}]}}}],"total":{"amount":648.9,"currency":"USD"}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/HotelQuote"},"examples":{"priceRoseToNewOffer":{"summary":"The price rose from 642.10 to 648.90 USD, so the quote returns a new publicId at that price.","value":{"currency":"USD","items":[{"publicId":"rate_b4d6f3h5jn2pq7m2k4t6v3x5z2","quantity":1,"name":"Hotel Arts Barcelona · Deluxe King, Breakfast, Free cancellation","price":{"amount":648.9,"currency":"USD"},"details":{"expiresAt":"2026-12-01T10:42:00Z","availability":"confirmed","checkInDate":"2026-12-10","checkOutDate":"2026-12-13","requestedRooms":[{"adults":2,"children":1,"childrenAges":[7]}],"terms":{"payment":{"type":"payNow","dueNow":{"amount":648.9,"currency":"USD"},"dueLater":null,"dueLaterAt":null},"cancellation":{"type":"fullyRefundable","freeUntil":"2026-12-08T23:59:00Z","freeUntilLocalTime":"2026-12-09T00:59:00","timezone":"Europe/Madrid","schedule":[{"from":"2026-12-08T23:59:00Z","fromLocalTime":"2026-12-09T00:59:00","refund":{"amount":432.6,"currency":"USD"},"penalty":{"amount":216.3,"currency":"USD"}}],"fee":null},"changes":{"allowed":true,"fee":null}},"rate":{"rooms":[{"roomGroupKey":"4c8e3ae1d379f759bc372243","name":"Deluxe King","description":null,"beds":[],"maxOccupancy":3,"sizeSquareMeters":null,"amenities":[],"imageUrls":[],"roomIndex":1,"adultsCount":2,"childrenCount":1,"childrenAges":[7]}],"board":{"code":"BB","name":"Bed and breakfast","boardType":"breakfast"},"taxes":{"included":true,"totalTaxAmount":41.64,"items":[]},"priceIsBinding":true,"nightlyPrices":[{"date":"2026-12-10","amount":216.3,"currency":"USD"},{"date":"2026-12-11","amount":216.3,"currency":"USD"},{"date":"2026-12-12","amount":216.3,"currency":"USD"}],"rateTags":[],"remarks":[],"rateConditions":[],"withTransfers":false,"rateRules":[],"amendabilityStatus":"yes","surcharges":[{"type":"AtProperty","description":"City Tax","price":{"amount":12.45,"currency":"EUR"},"approxPrice":{"amount":13.5,"currency":"USD"},"includedInTotal":false,"payableAt":"property"}]}}}],"total":{"amount":648.9,"currency":"USD"}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/HotelQuote"},"examples":{"priceRoseToNewOffer":{"summary":"The price rose from 642.10 to 648.90 USD, so the quote returns a new publicId at that price.","value":{"currency":"USD","items":[{"publicId":"rate_b4d6f3h5jn2pq7m2k4t6v3x5z2","quantity":1,"name":"Hotel Arts Barcelona · Deluxe King, Breakfast, Free cancellation","price":{"amount":648.9,"currency":"USD"},"details":{"expiresAt":"2026-12-01T10:42:00Z","availability":"confirmed","checkInDate":"2026-12-10","checkOutDate":"2026-12-13","requestedRooms":[{"adults":2,"children":1,"childrenAges":[7]}],"terms":{"payment":{"type":"payNow","dueNow":{"amount":648.9,"currency":"USD"},"dueLater":null,"dueLaterAt":null},"cancellation":{"type":"fullyRefundable","freeUntil":"2026-12-08T23:59:00Z","freeUntilLocalTime":"2026-12-09T00:59:00","timezone":"Europe/Madrid","schedule":[{"from":"2026-12-08T23:59:00Z","fromLocalTime":"2026-12-09T00:59:00","refund":{"amount":432.6,"currency":"USD"},"penalty":{"amount":216.3,"currency":"USD"}}],"fee":null},"changes":{"allowed":true,"fee":null}},"rate":{"rooms":[{"roomGroupKey":"4c8e3ae1d379f759bc372243","name":"Deluxe King","description":null,"beds":[],"maxOccupancy":3,"sizeSquareMeters":null,"amenities":[],"imageUrls":[],"roomIndex":1,"adultsCount":2,"childrenCount":1,"childrenAges":[7]}],"board":{"code":"BB","name":"Bed and breakfast","boardType":"breakfast"},"taxes":{"included":true,"totalTaxAmount":41.64,"items":[]},"priceIsBinding":true,"nightlyPrices":[{"date":"2026-12-10","amount":216.3,"currency":"USD"},{"date":"2026-12-11","amount":216.3,"currency":"USD"},{"date":"2026-12-12","amount":216.3,"currency":"USD"}],"rateTags":[],"remarks":[],"rateConditions":[],"withTransfers":false,"rateRules":[],"amendabilityStatus":"yes","surcharges":[{"type":"AtProperty","description":"City Tax","price":{"amount":12.45,"currency":"EUR"},"approxPrice":{"amount":13.5,"currency":"USD"},"includedInTotal":false,"payableAt":"property"}]}}}],"total":{"amount":648.9,"currency":"USD"}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"409":{"description":"Conflict","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Service Unavailable","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotels"}},"/v1/hotels/order":{"post":{"tags":["Hotels"],"summary":"Book hotels","description":"Places and pays for hotel bookings of up to 5 searched or quoted rates.\n\nRequires an `Idempotency-Key` header (a new UUID per purchase) and an API key with order-manage\npermission. Repeating the same request with the same key returns the original order; while the first\nrequest is still running the response is 409 / 12002 with `Retry-After`, after which you send the\nsame request again. The order is paid from your wallet balance and each booking\ncompletes asynchronously: track it with `GET /orders/{id}` or the `order.fulfillment.updated`\nwebhook.\n            \nThe body is `{ currency, referenceId, items }` with 1 to 5 items, each\n`{ publicId, quantity, inputs }`. `publicId` is an offer's `publicId` from search, or the\nnewer one from quote, and `quantity` must be 1. `inputs` holds the holder and one\n`roomGuests` entry per searched room (`roomIndex` 1 to N), whose guests must match the searched\noccupancy and child ages, the optional `specialRequests`, and the optional price guard\n`maxPrice` in the order currency. Unknown fields are rejected with 400.\n            \nThe whole body is validated first: a body error gives 400 / 10001, also when it is in a later item. Once\nthe body is valid, each item is checked completely before the next, and an error names its item in\n`details[].path`.\nBefore any money moves each rate is priced again in the order currency and capped: at\n`inputs.maxPrice` when sent, else at the price shown with the `publicId`. Above the cap the order\nreturns 409 / 11002 at `items[i].inputs.maxPrice` or `items[i]` (quote again); at or below it\nthe rate is charged as priced, so a `maxPrice` above the shown price accepts a rise up to it. A rate\nthat cannot be booked now returns 409 / 11003, an offer priced in another currency than the order\n400 / 11005, and an unknown, expired or another partner's `publicId` 400 / 11004, each at\n`items[i]`. Offer and hotel-system failures return their hotel codes (21003, 21007–21010) without a\npath. A wallet charge that fails gives 402 / 16000, with `details[0]` naming `wallet` and\n`INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`; send the same request with the same key after a\ntop-up. Nothing is created or charged when the order is refused.","operationId":"hotelsCreateOrder","parameters":[{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HotelOrderRequest"}],"description":"The body of a B2B hotel quote and order: the currency, an optional reference and the rates to price or book."},"examples":{"bookingForAFamily":{"summary":"Two adults and a child aged 7, accepting a rise of the price up to 650 USD.","value":{"currency":"USD","referenceId":"partner-booking-42","items":[{"publicId":"rate_x5z2b4d6f3h5jn2pq7m2k4t6v3","quantity":1,"inputs":{"holder":{"title":"Ms","firstName":"Ana","lastName":"Garcia","email":"ana@example.com","phone":"+34600123456"},"roomGuests":[{"roomIndex":1,"guests":[{"title":"Ms","firstName":"Ana","lastName":"Garcia","age":34},{"title":"Mr","firstName":"Luis","lastName":"Garcia","age":36},{"title":"Miss","firstName":"Sofia","lastName":"Garcia","age":7}]}],"specialRequests":"Late arrival","maxPrice":{"amount":650,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HotelOrderRequest"}],"description":"The body of a B2B hotel quote and order: the currency, an optional reference and the rates to price or book."},"examples":{"bookingForAFamily":{"summary":"Two adults and a child aged 7, accepting a rise of the price up to 650 USD.","value":{"currency":"USD","referenceId":"partner-booking-42","items":[{"publicId":"rate_x5z2b4d6f3h5jn2pq7m2k4t6v3","quantity":1,"inputs":{"holder":{"title":"Ms","firstName":"Ana","lastName":"Garcia","email":"ana@example.com","phone":"+34600123456"},"roomGuests":[{"roomIndex":1,"guests":[{"title":"Ms","firstName":"Ana","lastName":"Garcia","age":34},{"title":"Mr","firstName":"Luis","lastName":"Garcia","age":36},{"title":"Miss","firstName":"Sofia","lastName":"Garcia","age":7}]}],"specialRequests":"Late arrival","maxPrice":{"amount":650,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HotelOrderRequest"}],"description":"The body of a B2B hotel quote and order: the currency, an optional reference and the rates to price or book."},"examples":{"bookingForAFamily":{"summary":"Two adults and a child aged 7, accepting a rise of the price up to 650 USD.","value":{"currency":"USD","referenceId":"partner-booking-42","items":[{"publicId":"rate_x5z2b4d6f3h5jn2pq7m2k4t6v3","quantity":1,"inputs":{"holder":{"title":"Ms","firstName":"Ana","lastName":"Garcia","email":"ana@example.com","phone":"+34600123456"},"roomGuests":[{"roomIndex":1,"guests":[{"title":"Ms","firstName":"Ana","lastName":"Garcia","age":34},{"title":"Mr","firstName":"Luis","lastName":"Garcia","age":36},{"title":"Miss","firstName":"Sofia","lastName":"Garcia","age":7}]}],"specialRequests":"Late arrival","maxPrice":{"amount":650,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/HotelOrder"}},"application/json":{"schema":{"$ref":"#/components/schemas/HotelOrder"}},"text/json":{"schema":{"$ref":"#/components/schemas/HotelOrder"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"402":{"description":"Payment Required","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}}}},"409":{"description":"The offer changed since it was quoted: its price rose (11002, for products that check the quoted price) or it is no longer available (11003). Or the idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; it was used for a different request (12001); or its history is ambiguous.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Hotels"}},"/v1/amendments":{"get":{"tags":["OrderItems"],"summary":"List partner amendments","description":"Lists amendments across the authenticated partner's orders.\n\nRequires the read order permission. Includes manual and automatic amendments in all\n            statuses. Optional repeated statuses, productType, amendmentMode, orderId, orderItemId and inclusive\n            UTC from/to timestamps filter the result. Use flat page (default 1) and limit (default 10,\n            maximum 100) query parameters. Nested paging keys return 400 with code 10001.\n            Amounts retain their original currency; a quote does not imply settlement.\n            Example response:\n            ```{\"items\":[{\"id\":\"b7428a30-f760-46e8-b504-a670bf9bed19\",\"orderId\":\"a46ee792-287e-44ef-a641-48de1a0f72fd\",\"orderItemId\":\"cf4a49ac-b785-43d4-912a-4be3443e48bd\",\"productType\":\"hotel\",\"amendmentMode\":\"manual\",\"status\":\"quoted\",\"createdAt\":\"2026-11-03T09:00:00Z\",\"amountToPay\":{\"amount\":25,\"currency\":\"USD\"},\"amountToRefund\":{\"amount\":0,\"currency\":\"USD\"}}],\"pagination\":{\"currentCount\":1,\"totalCount\":1,\"skip\":0,\"limit\":10,\"hasMore\":false,\"page\":1,\"totalPages\":1}}```","operationId":"orderItemsListPartnerAmendments","parameters":[{"name":"page","in":"query","description":"One-based page number. Default 1.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":1}}},{"name":"limit","in":"query","description":"Page size, 1 to 100. Default 10.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}},{"name":"statuses","in":"query","description":"Repeat to match any of the requested statuses.","schema":{"type":"array","items":{"enum":["pending","completed","cancelled","failed","inProgress","quoted","partnerApproved","approvalInProgress"],"type":"string"}}},{"name":"productType","in":"query","schema":{"enum":["esim","hotel","flight","carRental","train","lounge","ticket","tour","activity","cruise","remittance","vpn","transportation","insurance","billPayment","giftCard","loyaltyProgram","voip","airtime","utility"],"type":"string"}},{"name":"amendmentMode","in":"query","schema":{"enum":["automatic","manual"],"type":"string"}},{"name":"orderId","in":"query","schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"orderItemId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"from","in":"query","description":"Inclusive creation timestamp with UTC offset. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-01T00:00:00Z"}}},{"name":"to","in":"query","description":"Inclusive creation timestamp with UTC offset. Send the end of a UTC day to include that whole day. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-31T23:59:59Z"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AmendmentList"}},"application/json":{"schema":{"$ref":"#/components/schemas/AmendmentList"}},"text/json":{"schema":{"$ref":"#/components/schemas/AmendmentList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Order items"}},"/v1/order-items/{id}":{"get":{"tags":["OrderItems"],"summary":"Get an order item","description":"Gets an order item: what was bought, its delivery, its refund and what you can do next.\n\nRequires the `read` order permission. Returns the item exactly as it appears in `items[]` of the\norder response, including `orderId`, the order it belongs to. `fulfillment.status` and\n`refund.status` give its state; `actions.cancellation` says whether it can be cancelled now,\n`actions.amendment` whether it can be amended and `actions.update` whether it can be updated. An\nitem of another partner, or an unknown id, returns\n`404` with code `10004`; a malformed id or an unknown query parameter returns `400` with code\n`10001`.","operationId":"orderItemsGetById","parameters":[{"name":"id","in":"path","description":"Order item id (`items[].id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/OrderItem"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrderItem"}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderItem"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Order items"}},"/v1/order-items/{id}/cancellation-preview":{"get":{"tags":["OrderItems"],"summary":"Preview an item cancellation","description":"Previews the cancellation penalty and expected refund for an order item.\n\nRequires the `read` order permission. Returns `penaltyAmount`, the `cancellationFee` kept in\naddition to it (`null` when none applies) and the expected `refundAmount`, all in the order\ncurrency, `isRefundable`, the cancellation band in effect, priced at the penalty\n(`appliedPenalties`: at most one `{ from, penaltyAmount }`), `effectiveCancellationDate` and\n`checkInDate`, calculated with the same rules as the partner portal. The fee comes out of what the\npenalty leaves, so the refund is never negative. `isRefundable: false` means the penalty alone keeps\nthe whole price, so the item cannot be cancelled; it is not an error. A fee that takes what the penalty leaves\ndoes not make it false: the item can still be cancelled, with a refund of 0. The preview does\nnot cancel the item or change its state, and it does not lock the penalty: the cancel call recalculates it,\nso a later cancellation band may apply.\n            \nThe preview refuses what the cancel refuses. A delivered item of a kind that cannot take back a delivery\n(airtime, utility, gift cards, eSIMs) can never be cancelled and returns `422` with code `18000`\n(`CANCELLATION_NOT_SUPPORTED`). Otherwise, when the item's `actions.cancellation` is not\n`available`, it returns `409` with code `18001` (`CANCELLATION_NOT_AVAILABLE`), and\n`details[0].reason` repeats `actions.cancellation.availability`. A refund started by OpenRoam\nsupport returns the same `409` with `MANUAL_REVIEW`. A delivered item is priced with its product's\ncancellation rules. An item that\nwas not delivered has no cancellation to price: a rejected item whose automatic refund has not started\npreviews a full refund of what was paid (after a failed refund, the amounts that refund is retried with), with a `penaltyAmount`\nof 0 and no `cancellationFee` or `appliedPenalties`. A cancellation the product refuses, for\nexample after check-out, returns `400` with code `10001`. An item of another partner, or an unknown\nid, returns `404` with code `10004`.","operationId":"orderItemsGetCancellationPreview","parameters":[{"name":"id","in":"path","description":"Order item id (`items[].id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/OrderItemCancellationPreview"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrderItemCancellationPreview"}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderItemCancellationPreview"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"Conflict","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"cancellationNotAvailable":{"summary":"It can be cancelled, but not now.","value":{"code":18001,"name":"CANCELLATION_NOT_AVAILABLE","message":"This item cannot be cancelled right now.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"IN_PROGRESS"}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"cancellationNotAvailable":{"summary":"It can be cancelled, but not now.","value":{"code":18001,"name":"CANCELLATION_NOT_AVAILABLE","message":"This item cannot be cancelled right now.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"IN_PROGRESS"}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"cancellationNotAvailable":{"summary":"It can be cancelled, but not now.","value":{"code":18001,"name":"CANCELLATION_NOT_AVAILABLE","message":"This item cannot be cancelled right now.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"IN_PROGRESS"}]}}}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"cancellationNotSupported":{"summary":"Delivered, and its kind cannot take back a delivery.","value":{"code":18000,"name":"CANCELLATION_NOT_SUPPORTED","message":"This kind of item cannot be cancelled.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"cancellationNotSupported":{"summary":"Delivered, and its kind cannot take back a delivery.","value":{"code":18000,"name":"CANCELLATION_NOT_SUPPORTED","message":"This kind of item cannot be cancelled.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"cancellationNotSupported":{"summary":"Delivered, and its kind cannot take back a delivery.","value":{"code":18000,"name":"CANCELLATION_NOT_SUPPORTED","message":"This kind of item cannot be cancelled.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Order items"}},"/v1/order-items/{id}/amendments/quote":{"post":{"tags":["OrderItems"],"summary":"Quote an amendment","description":"Quotes a change to a delivered order item.\n\nAvailable only when the item's `actions.amendment` is `available`: the item must be fulfilled,\nnot refunded, and its product must support automatic changes. Items whose changes need manual review show\n`manualReview` and use the manual amendment routes instead. A kind of item that can never be amended\nreturns `422` with code `18002` (`AMENDMENT_NOT_SUPPORTED`); otherwise an amendment that is\nnot allowed now returns `409` with code `18003` (`AMENDMENT_NOT_AVAILABLE`), and\n`details[0].reason` repeats `actions.amendment.availability` (`MANUAL_REVIEW` or\n`NOT_AVAILABLE`). An item of another partner, or an unknown id, returns `404` with code\n`10004`.\n            \nSend the requested change in `attributes`, in the shape the item's product defines; top-level names that\nstart with `_` are reserved for OpenRoam and ignored. The response\nhas an `amendmentRequestId`, the time the quote was made (`processedAt`), the time it expires\n(`expiresAt`) and one or more `options`, each with an `id`, an `amountToPay` and an\n`amountToRefund` in the API key's currency, and an `amendmentFee`: a fee for the change, already\nincluded in those amounts, or `null` when none applies. Nothing changes and nothing is charged until\nyou confirm the quote with `POST /order-items/{id}/amendments/confirm`, before `expiresAt`.\n            \nRequires an `Idempotency-Key` header (a UUID). Repeating a completed request with the same key\nreturns `409` with code `12000` (`IDEMPOTENCY_KEY_ALREADY_USED`): a quote is not kept, so\nrequest a new one with a new key. One still running returns `409` with code `12002`\n(`IDEMPOTENCY_KEY_IN_PROGRESS`) and a `Retry-After` header, and a different body with the same\nkey `409` with code `12001`. A request that ended in an error can be sent again with the same key\nand body.","operationId":"orderItemsQuoteAmendment","parameters":[{"name":"id","in":"path","description":"Order item id (`items[].id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"description":"The requested change.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AmendmentQuoteRequest"}],"description":"The change requested for a delivered order item."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AmendmentQuoteRequest"}],"description":"The change requested for a delivered order item."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AmendmentQuoteRequest"}],"description":"The change requested for a delivered order item."}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AmendmentQuote"}},"application/json":{"schema":{"$ref":"#/components/schemas/AmendmentQuote"}},"text/json":{"schema":{"$ref":"#/components/schemas/AmendmentQuote"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"The idempotency key: it was used by a request that finished (12000), so use a new key for a new request; a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; or it was used for a different request (12001).","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"amendmentNotAvailable":{"summary":"It can be amended, but not now or not through the API.","value":{"code":18003,"name":"AMENDMENT_NOT_AVAILABLE","message":"This item cannot be amended right now.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"MANUAL_REVIEW"}]}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"amendmentNotSupported":{"summary":"This kind of item cannot be amended.","value":{"code":18002,"name":"AMENDMENT_NOT_SUPPORTED","message":"This kind of item cannot be amended.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"amendmentNotSupported":{"summary":"This kind of item cannot be amended.","value":{"code":18002,"name":"AMENDMENT_NOT_SUPPORTED","message":"This kind of item cannot be amended.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"amendmentNotSupported":{"summary":"This kind of item cannot be amended.","value":{"code":18002,"name":"AMENDMENT_NOT_SUPPORTED","message":"This kind of item cannot be amended.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Order items"}},"/v1/order-items/{id}/amendments":{"get":{"tags":["OrderItems"],"summary":"List item amendments","description":"Lists every amendment of an order item.\n\nReturns the whole list as an array, without paging. Each amendment has `id`, `orderItemId`,\n`status`, `productType`, `createdAt`, `amountToPay` and `amountToRefund`. An item\nof another partner, or an unknown id, returns `404` with code `10004`.","operationId":"orderItemsGetAmendments","parameters":[{"name":"id","in":"path","description":"Order item id (`items[].id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemAmendment"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemAmendment"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemAmendment"}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Order items"}},"/v1/order-items/{id}/amendments/{amendmentId}":{"get":{"tags":["OrderItems"],"summary":"Get an amendment","description":"Gets one amendment of an order item.\n\nReturns the same fields as the amendment list. An unknown amendment, or one that belongs to another item\nor partner, returns `404` with code `10004`.","operationId":"orderItemsGetAmendmentById","parameters":[{"name":"id","in":"path","description":"Order item id (`items[].id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"amendmentId","in":"path","description":"Amendment id (`amendmentId` from the confirm response, or `id` from the\n            amendment list).","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/OrderItemAmendment"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrderItemAmendment"}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderItemAmendment"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Order items"}},"/v1/order-items/{id}/cancel":{"post":{"tags":["OrderItems"],"summary":"Cancel an item","description":"Cancels an order item and refunds what was paid for it, less any cancellation penalty.\n\nAvailable when the item's `actions.cancellation` is `available`; while a refund is running it shows\n`inProgress`, and `manualReview` means support must handle it. A rejected item is refunded in full\nautomatically and reported by `order-item.refunded`; the `fulfillmentFailed` reason then returns\nthat refund. The `fulfillmentFailed` reason is accepted only for a rejected item; a\ncancellation that is not valid for the item returns `400` with code `10001`. A delivered item of a\nkind that cannot take back a delivery (airtime, utility, gift cards, eSIMs) can never be cancelled and\nreturns `422` with code `18000` (`CANCELLATION_NOT_SUPPORTED`). Otherwise a cancellation that\nis not allowed now, for example while the item is still being delivered, returns `409` with code\n`18001` (`CANCELLATION_NOT_AVAILABLE`), and `details[0].reason` repeats\n`actions.cancellation.availability` (`IN_PROGRESS`, `MANUAL_REVIEW` or `NOT_AVAILABLE`).\nThe same `409` with `IN_PROGRESS` answers a cancel that meets a refund, a delivery or a change of\nthe same order still running; send it again shortly. The amount is recalculated at this point, so it can\ndiffer from an earlier cancellation preview. A refund started by OpenRoam support returns the same\n`409` with `MANUAL_REVIEW`. An item of another partner, or an unknown id, returns `404` with\ncode `10004`.\n            \nReturns the `orderItemId`, the refund `amount`, the `method` it is returned to and its\n`status`. A balance payment is refunded to the wallet that paid it. Refund progress is also reported\nby the `order-item.refunded` webhook.\n            \nRequires an `Idempotency-Key` header (a UUID). Repeating a completed request with the same key and body\nreturns `200` with the refund that request started, as it reads now, and refunds nothing again. One\nstill running returns `409` with code `12002` (`IDEMPOTENCY_KEY_IN_PROGRESS`) and a\n`Retry-After` header, and a different body with the same key `409` with code `12001`. A\nrequest that ended in an error can be sent again with the same key and body.","operationId":"orderItemsCancel","parameters":[{"name":"id","in":"path","description":"Order item id (`items[].id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"description":"The cancellation reason.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderItemCancelRequest"}],"description":"The reason for refunding an order item."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderItemCancelRequest"}],"description":"The reason for refunding an order item."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderItemCancelRequest"}],"description":"The reason for refunding an order item."}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/OrderItemCancelResult"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrderItemCancelResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderItemCancelResult"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"The idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; or it was used for a different request (12001). A finished request sent again with the same key and body returns 200 with the result of the first call, rebuilt from the record that call created as it reads now: nothing runs again, and a status that has moved on since shows its current value.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"cancellationNotAvailable":{"summary":"It can be cancelled, but not now.","value":{"code":18001,"name":"CANCELLATION_NOT_AVAILABLE","message":"This item cannot be cancelled right now.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"IN_PROGRESS"}]}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"cancellationNotSupported":{"summary":"Delivered, and its kind cannot take back a delivery.","value":{"code":18000,"name":"CANCELLATION_NOT_SUPPORTED","message":"This kind of item cannot be cancelled.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"cancellationNotSupported":{"summary":"Delivered, and its kind cannot take back a delivery.","value":{"code":18000,"name":"CANCELLATION_NOT_SUPPORTED","message":"This kind of item cannot be cancelled.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"cancellationNotSupported":{"summary":"Delivered, and its kind cannot take back a delivery.","value":{"code":18000,"name":"CANCELLATION_NOT_SUPPORTED","message":"This kind of item cannot be cancelled.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Order items"}},"/v1/order-items/{id}/update":{"post":{"tags":["OrderItems"],"summary":"Update an item","description":"Updates a delivered order item, without a charge.\n\nChanges what the item's kind lets a partner change after the purchase, in one call. An update never charges\nor refunds anything: a change with a price, such as a hotel or flight change, is an amendment\n(`POST /order-items/{id}/amendments/quote`). At launch only gift cards can be updated: `inputs`\ntakes a new `recipientEmail` and `giftMessage`, and the gift email is sent again, to the new address\nwith the new message. A card bought without a recipient needs `recipientEmail`. Every other kind of item\nreturns `422` with code `18004` (`UPDATE_NOT_SUPPORTED`).\n            \nAvailable when the item's `actions.update` is `available`; otherwise the update returns `409`\nwith code `18005` (`UPDATE_NOT_AVAILABLE`), and `details[0].reason` repeats\n`actions.update.availability` (`IN_PROGRESS` or `NOT_AVAILABLE`). The same `409` is\nreturned when the item stops being available during the call, for example after a cancel.\n            \nA member of `inputs` left out or sent as `null` keeps its current value, and at least one member\nmust be present. An invalid member returns `400` with code `10001` at `inputs.<member>`,\nwith the same reasons as the order's `inputs`, and a member the item's kind does not define returns\n`400` with code `10001` and reason `UNSUPPORTED_FIELD`. An item of another partner, or an\nunknown id, returns `404` with code `10004`. A malformed body (not valid JSON, `inputs`\nmissing, `null` or not an object, or a top-level member other than `inputs`) returns `400`\nwith code `10001` before the item is read. The checks on the item then run in this order: `404`,\n`422`, `409`, then `400` for the members of `inputs`.\n            \nReturns the item exactly as `GET /order-items/{id}` returns it. No webhook is sent for an update.\n            \nRequires an `Idempotency-Key` header (a UUID). Repeating a completed request with the same key and body\nreturns `200` with the item as `GET /order-items/{id}` returns it now, and changes nothing again\n(no gift email is sent again). One still running returns `409` with code `12002`\n(`IDEMPOTENCY_KEY_IN_PROGRESS`) and a `Retry-After` header, and a different body with the same\nkey `409` with code `12001`. A request that ended in an error can be sent again with the same key\nand body. Updating the same item again needs a new key.","operationId":"orderItemsUpdate","parameters":[{"name":"id","in":"path","description":"Order item id (`items[].id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"description":"The members to change.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderItemUpdateRequest"}],"description":"The change to make to a purchased item. An update never charges or refunds anything."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderItemUpdateRequest"}],"description":"The change to make to a purchased item. An update never charges or refunds anything."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderItemUpdateRequest"}],"description":"The change to make to a purchased item. An update never charges or refunds anything."}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/OrderItem"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrderItem"}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderItem"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"The idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; or it was used for a different request (12001). A finished request sent again with the same key and body returns 200 with the result of the first call, rebuilt from the record that call created as it reads now: nothing runs again, and a status that has moved on since shows its current value.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"updateNotAvailable":{"summary":"It can be updated, but not now.","value":{"code":18005,"name":"UPDATE_NOT_AVAILABLE","message":"This item cannot be updated right now.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"NOT_AVAILABLE"}]}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"updateNotSupported":{"summary":"This kind of item cannot be updated.","value":{"code":18004,"name":"UPDATE_NOT_SUPPORTED","message":"This kind of item cannot be updated.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"updateNotSupported":{"summary":"This kind of item cannot be updated.","value":{"code":18004,"name":"UPDATE_NOT_SUPPORTED","message":"This kind of item cannot be updated.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"updateNotSupported":{"summary":"This kind of item cannot be updated.","value":{"code":18004,"name":"UPDATE_NOT_SUPPORTED","message":"This kind of item cannot be updated.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Order items"}},"/v1/order-items/{id}/amendments/confirm":{"post":{"tags":["OrderItems"],"summary":"Confirm an amendment","description":"Confirms a quoted amendment, paying any surcharge or receiving any refund.\n\nSend the `amendmentRequestId` from the quote and, optionally, the `selectedOptionId` of one of\nits options (the first option is used when it is omitted). The quote is checked again before anything is\ncharged: an expired or unknown quote, or one made before another amendment changed the item, returns\n`400` with code `11004` (`OFFER_EXPIRED_OR_INVALID`) at `amendmentRequestId`, and an\noption that is no longer offered returns `400` with code `10001`; request a new quote then. Where\nthe change is priced again before the charge (hotels), a price that changed since the quote returns\n`409` with code `11002` (`OFFER_PRICE_CHANGED`) at `amendmentRequestId` without\n`maxPrice`, and is charged when it is within `maxPrice`. A price above `maxPrice` returns\n`409` with code `11002` at\n`maxPrice`, with nothing charged; a `maxPrice` in another currency than the quoted amounts returns\n`400` with code `10001` at `maxPrice.currency`. A change refused when it is sent (for example,\na flight whose price changed since the quote) gets its surcharge back and returns `400` with code\n`10001`.\n            \nConfirming the same quote again with a new `Idempotency-Key` returns `200` with the amendment that\nquote created, and nothing is charged twice. A confirm that was interrupted after its payment is finished\nfirst: its change is sent, or its surcharge is returned. Two confirms of one quote sent at the same time make\none amendment: the other returns `200` with it, or `409` with code `18003` and\n`IN_PROGRESS` while the first is still running; send it again shortly. A kind of item that can never be\namended returns `422` with code `18002` (`AMENDMENT_NOT_SUPPORTED`), and an amendment that is\nnot allowed now returns `409` with code `18003` (`AMENDMENT_NOT_AVAILABLE`), with\n`details[0].reason` `IN_PROGRESS` while another amendment or a change to the order is running,\notherwise `MANUAL_REVIEW` or `NOT_AVAILABLE`. An item of another partner, or an unknown id,\nreturns `404` with code `10004`.\n            \nA surcharge is charged with `paymentMethod` `balance`, its only value: the wallet linked to the API\nkey. Any other value returns `400` with code `10001` at `paymentMethod`. A refund goes to that\nwallet. Returns the\n`amendmentRequestId`, the new `amendmentId`, its `status`, and the `payment` or\n`refund` that was made (`null` when none). A wallet charge that fails returns `402` with code\n`16000` (`PAYMENT_FAILED`) and, when the reason is known, `details[0]` naming `wallet`\nwith `INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`; no amendment is kept, so the same quote can be\nconfirmed again after a top-up. Amendments do not change\n`fulfillmentVersion`; read the order again for the changed item.\n            \nRequires an `Idempotency-Key` header (a UUID). Repeating a completed request with the same key and body\nreturns `200` with the amendment that request created, as it reads now, and charges nothing again. One\nstill running returns `409` with code `12002` (`IDEMPOTENCY_KEY_IN_PROGRESS`) and a\n`Retry-After` header, and a different body with the same key `409` with code `12001`. A\nrequest that ended in an error can be sent again with the same key and body.","operationId":"orderItemsConfirmAmendment","parameters":[{"name":"id","in":"path","description":"Order item id (`items[].id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"description":"The quote and option to confirm, and an optional price limit.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AmendmentConfirmRequest"}],"description":"The quote and option to confirm."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AmendmentConfirmRequest"}],"description":"The quote and option to confirm."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AmendmentConfirmRequest"}],"description":"The quote and option to confirm."}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AmendmentConfirmResult"}},"application/json":{"schema":{"$ref":"#/components/schemas/AmendmentConfirmResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/AmendmentConfirmResult"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"402":{"description":"Payment Required","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"The idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; or it was used for a different request (12001). A finished request sent again with the same key and body returns 200 with the result of the first call, rebuilt from the record that call created as it reads now: nothing runs again, and a status that has moved on since shows its current value.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"amendmentNotAvailable":{"summary":"It can be amended, but not now or not through the API.","value":{"code":18003,"name":"AMENDMENT_NOT_AVAILABLE","message":"This item cannot be amended right now.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"MANUAL_REVIEW"}]}},"priceAboveLimit":{"summary":"The amendment costs more than maxPrice.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"maxPrice","reason":"PRICE_CHANGED"}]}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"amendmentNotSupported":{"summary":"This kind of item cannot be amended.","value":{"code":18002,"name":"AMENDMENT_NOT_SUPPORTED","message":"This kind of item cannot be amended.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"amendmentNotSupported":{"summary":"This kind of item cannot be amended.","value":{"code":18002,"name":"AMENDMENT_NOT_SUPPORTED","message":"This kind of item cannot be amended.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"amendmentNotSupported":{"summary":"This kind of item cannot be amended.","value":{"code":18002,"name":"AMENDMENT_NOT_SUPPORTED","message":"This kind of item cannot be amended.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Order items"}},"/v1/orders":{"get":{"tags":["Orders"],"summary":"List orders","description":"Lists the partner's orders, newest first, with optional filters.\n\nReturns `{ orders, pagination }`. Each summary has `id`, `referenceId`, `origin`,\n`status`, `total`, the latest `payment` and `itemCount`; read one order for its items\nand timeline.\n            \nOrders created through the API, the dashboard and the partner's sites are all listed; `channel`\n(`api`, `dashboard` or `site`, the values of `origin.channel`) keeps one of them. With a\nsite credential, only the orders of that site are listed. `orderStatuses` takes the\nvalues of `status` and matches the status the order reads now. Filters combine with AND;\nrepeated `productTypes` or `orderStatuses` values combine with OR. A `productTypes` filter\nselects orders containing at least one item of that type and still returns the whole order. Filters apply\nbefore counting and paging, so send the same filters on every page.\n            \nUse flat `page` (default 1) and `limit` (default 10, 1 to 100) query parameters.\n`cursor`, `skip`, `offset`, nested paging keys and repeated paging parameters return\n`400` with code `10001` (`INVALID_REQUEST`).","operationId":"ordersGetAll","parameters":[{"name":"page","in":"query","description":"One-based page number. Default 1.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":1}}},{"name":"limit","in":"query","description":"Page size, 1 to 100. Default 10.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}},{"name":"startDate","in":"query","description":"Only orders created at or after this time (UTC). ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-01T00:00:00Z"}}},{"name":"endDate","in":"query","description":"Only orders created at or before this time (UTC). ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-31T23:59:59Z"}}},{"name":"minAmount","in":"query","description":"Only orders whose `total.amount`, in the order's currency, is at least this value.","schema":{"type":"number","format":"decimal"}},{"name":"maxAmount","in":"query","description":"Only orders whose `total.amount`, in the order's currency, is at most this value.","schema":{"type":"number","format":"decimal"}},{"name":"search","in":"query","description":"An order id returns that order only; any other text matches part of the email or full name of the user who\nplaced the order.","schema":{"type":"string"}},{"name":"referenceId","in":"query","description":"Only the order with exactly this `referenceId`.","schema":{"type":"string"},"examples":{"default":{"value":"partner-order-42"}}},{"name":"channel","in":"query","description":"Only orders created through this channel, the same values as `origin.channel`: `api`,\n            `dashboard` or `site`.","schema":{"enum":["api","dashboard","site"],"type":"string"}},{"name":"productTypes","in":"query","description":"Only orders containing at least one item of one of these product types. Repeat the parameter for several\ntypes, for example `productTypes=esim&productTypes=giftCard`.","schema":{"type":"array","items":{"enum":["esim","hotel","flight","carRental","train","lounge","ticket","tour","activity","cruise","remittance","vpn","transportation","insurance","billPayment","giftCard","loyaltyProgram","voip","airtime","utility"],"type":"string"}}},{"name":"orderStatuses","in":"query","description":"Only orders currently in one of these statuses, the same values as `status`. Repeat the parameter for\nseveral statuses.","schema":{"type":"array","items":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"The order's status, including the refunds of its delivered items."}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/OrderList"},"examples":{"recentOrders":{"summary":"The newest orders first, one summary per order.","value":{"orders":[{"id":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","referenceId":"trip-42","origin":{"channel":"api"},"status":"processing","total":{"amount":50,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":50,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":50,"currency":"USD"}},"failure":null},"itemCount":2,"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z"},{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"itemCount":2,"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z"}],"pagination":{"currentCount":2,"totalCount":2,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/OrderList"},"examples":{"recentOrders":{"summary":"The newest orders first, one summary per order.","value":{"orders":[{"id":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","referenceId":"trip-42","origin":{"channel":"api"},"status":"processing","total":{"amount":50,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":50,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":50,"currency":"USD"}},"failure":null},"itemCount":2,"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z"},{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"itemCount":2,"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z"}],"pagination":{"currentCount":2,"totalCount":2,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderList"},"examples":{"recentOrders":{"summary":"The newest orders first, one summary per order.","value":{"orders":[{"id":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","referenceId":"trip-42","origin":{"channel":"api"},"status":"processing","total":{"amount":50,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":50,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":50,"currency":"USD"}},"failure":null},"itemCount":2,"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z"},{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"itemCount":2,"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z"}],"pagination":{"currentCount":2,"totalCount":2,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Orders"},"post":{"tags":["Orders"],"summary":"Create an order","description":"Places one order of one to five items, of one or several product types, and pays it from the wallet.\n\nEach item names its `productType`, the `publicId` of the offer from search or quote, a\n`quantity` and, where the product needs them, product-specific `inputs` (required for hotels and\nflights). An order has at most five items and a total quantity of at most five; an item with quantity\n`n` becomes `n` separate order items, each with its own `items[].id`. Every item is\nvalidated before anything is charged; a rejected item is reported at `items[i]` in\n`details`, for example `11004` (`OFFER_EXPIRED_OR_INVALID`) for an unknown, expired or\nother-product `publicId`, `11003` (`OFFER_UNAVAILABLE`) or `11002`\n(`OFFER_PRICE_CHANGED`).\n            \nThe optional `maxTotal` `{ amount, currency }` caps the whole order: the sum of every item's\nprice times its quantity, in the order currency. Its currency must be the order currency (otherwise\n`400`, `10001`, `CURRENCY_MISMATCH` at `maxTotal.currency`). A higher total returns\n`409` with code `11002` (`OFFER_PRICE_CHANGED`) at `maxTotal`, after every item is\npriced and before anything is charged; a total equal to it is accepted.\n            \nThe order total is charged to the partner's selected wallet. On success the order is\n`processing` and its items start as `pending`; delivery continues after the response, so follow\nit with `GET orders/{id}`, `GET orders/{orderId}/fulfillment/status` or the\n`order.fulfillment.updated` webhook. If the charge fails, no order is created and the call returns\n`402` with code `16000` (`PAYMENT_FAILED`); when the reason is known,\n`details[0]` names `wallet` with reason `INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`.\nTop up or unblock the wallet and send the same request again with the same `Idempotency-Key`.\n            \nRequires an `Idempotency-Key` header (a UUID) per purchase. Repeating the same request with the\nsame key never charges twice: once the order is accepted it returns `200` with that order's current\nstate; while the first request is still running it returns `409` with code `12002`\n(`IDEMPOTENCY_KEY_IN_PROGRESS`) and a `Retry-After` header, after which you send the same\nrequest again; a different body with the same key returns `409` with code `12001`\n(`IDEMPOTENCY_KEY_REQUEST_MISMATCH`). After a timeout or `5xx`, retry with the same key and\nbody rather than a new key. A `referenceId` already used by another order of the partner returns\n`409` with code `10005` (`CONFLICT`). An eSIM top-up whose `inputs.iccid` is not one\nof your eSIMs returns `404` with code `10004` (`NOT_FOUND`) and charges nothing.","operationId":"ordersCreateOrder","parameters":[{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"description":"The order to place.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MixedOrderRequest"}],"description":"An order of one to five items, of one or several product types, paid from the wallet."},"examples":{"airtimeAndEsim":{"summary":"An airtime top-up and an eSIM bought together, with a ceiling on the total.","value":{"currency":"USD","referenceId":"trip-42","maxTotal":{"amount":50,"currency":"USD"},"items":[{"productType":"airtime","publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567"}},{"productType":"esim","publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MixedOrderRequest"}],"description":"An order of one to five items, of one or several product types, paid from the wallet."},"examples":{"airtimeAndEsim":{"summary":"An airtime top-up and an eSIM bought together, with a ceiling on the total.","value":{"currency":"USD","referenceId":"trip-42","maxTotal":{"amount":50,"currency":"USD"},"items":[{"productType":"airtime","publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567"}},{"productType":"esim","publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MixedOrderRequest"}],"description":"An order of one to five items, of one or several product types, paid from the wallet."},"examples":{"airtimeAndEsim":{"summary":"An airtime top-up and an eSIM bought together, with a ceiling on the total.","value":{"currency":"USD","referenceId":"trip-42","maxTotal":{"amount":50,"currency":"USD"},"items":[{"productType":"airtime","publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567"}},{"productType":"esim","publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Order"},"examples":{"paidOrderWithAirtimeAndEsim":{"summary":"The order as placed: paid from the wallet and processing, both items still pending.","value":{"id":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","referenceId":"trip-42","origin":{"channel":"api"},"status":"processing","total":{"amount":50,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":50,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":50,"currency":"USD"}},"failure":null},"items":[{"id":"01a14340-7a2b-7d10-8e4c-2b6f9a1c3d50","orderId":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","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":"pending","result":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":"01a14340-7a2b-7e21-9f5d-3c7a0b2d4e61","orderId":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","productType":"esim","price":{"amount":25,"currency":"USD"},"purchasedProduct":{"name":"Europe 3 GB 7 days","countryCode":null,"logoUrl":"https://cdn.openroam.test/esims/europe.png","inputs":{"eid":null,"imei2":null,"iccid":null,"travelStartDate":null,"isInstant":true},"details":{"orderType":"esim","isInstant":true,"destination":{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","code":"EU"}}},"fulfillment":{"status":"pending","result":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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Order"},"examples":{"paidOrderWithAirtimeAndEsim":{"summary":"The order as placed: paid from the wallet and processing, both items still pending.","value":{"id":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","referenceId":"trip-42","origin":{"channel":"api"},"status":"processing","total":{"amount":50,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":50,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":50,"currency":"USD"}},"failure":null},"items":[{"id":"01a14340-7a2b-7d10-8e4c-2b6f9a1c3d50","orderId":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","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":"pending","result":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":"01a14340-7a2b-7e21-9f5d-3c7a0b2d4e61","orderId":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","productType":"esim","price":{"amount":25,"currency":"USD"},"purchasedProduct":{"name":"Europe 3 GB 7 days","countryCode":null,"logoUrl":"https://cdn.openroam.test/esims/europe.png","inputs":{"eid":null,"imei2":null,"iccid":null,"travelStartDate":null,"isInstant":true},"details":{"orderType":"esim","isInstant":true,"destination":{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","code":"EU"}}},"fulfillment":{"status":"pending","result":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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Order"},"examples":{"paidOrderWithAirtimeAndEsim":{"summary":"The order as placed: paid from the wallet and processing, both items still pending.","value":{"id":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","referenceId":"trip-42","origin":{"channel":"api"},"status":"processing","total":{"amount":50,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":50,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":50,"currency":"USD"}},"failure":null},"items":[{"id":"01a14340-7a2b-7d10-8e4c-2b6f9a1c3d50","orderId":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","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":"pending","result":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":"01a14340-7a2b-7e21-9f5d-3c7a0b2d4e61","orderId":"01a14340-7a10-7c55-a1f2-9b3d5e7f0a11","productType":"esim","price":{"amount":25,"currency":"USD"},"purchasedProduct":{"name":"Europe 3 GB 7 days","countryCode":null,"logoUrl":"https://cdn.openroam.test/esims/europe.png","inputs":{"eid":null,"imei2":null,"iccid":null,"travelStartDate":null,"isInstant":true},"details":{"orderType":"esim","isInstant":true,"destination":{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","code":"EU"}}},"fulfillment":{"status":"pending","result":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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"402":{"description":"Payment Required","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"The offer changed since it was quoted: its price rose (11002, for products that check the quoted price) or it is no longer available (11003). Or the idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; it was used for a different request (12001); or its history is ambiguous.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Orders"}},"/v1/orders/{id}":{"get":{"tags":["Orders"],"summary":"Get an order","description":"Gets the current state of one order.\n\nReturns the same shape as order creation: `id`, `referenceId`, `origin`, `status`,\n`total`, `payment`, `items`, `timeline`, `createdAt`, `updatedAt` and\n`fulfillmentVersion`. This is the source of truth for the order: webhooks are snapshots of an event, so\nread the order again after a missed or out-of-order delivery. `updatedAt` moves whenever anything in\nthe order changes: its status, an item's fulfillment, a refund or an amendment.\n            \nOrder `status` is `processing` from the moment the wallet is charged until every item has an\noutcome, then `completed` (every item fulfilled), `partiallyFulfilled` (some items fulfilled,\nthe rest rejected) or `fulfillmentFailed` (no item fulfilled). Cancelling delivered items makes it\n`partiallyRefunded` (some delivered items cancelled and refunded) or `refunded` (every delivered\nitem cancelled and refunded). Every order's `timeline` starts with `paymentPending`. An order\nreads `paymentPending` as its status while a dashboard order awaits its payment, and, rarely, when a\nwallet charge was taken but could not be confirmed. Sending the order request again with the same\n`Idempotency-Key` and body completes such an order from that charge, and OpenRoam also completes it\nautomatically, usually within two hours; the wallet is never charged twice. `cancelled` is\nan unpaid order that expired. A rejected item is refunded automatically when\nnothing is held for it; its `refund` shows the release. Each item reports its own\n`fulfillment.status`: `pending`, `fulfilled` with a typed `result`, or\n`rejected` with a safe `failure` (`11001`, `FULFILLMENT_REJECTED`).\n`items[].actions` say whether amendment, cancellation and update are available now.\n            \nAn order of another partner, or an unknown id, returns `404` with code `10004`.","operationId":"ordersGetById","parameters":[{"name":"id","in":"path","description":"Order id (`id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Order"},"examples":{"airtimeCompleted":{"summary":"Both airtime top-ups delivered: the order is completed.","value":{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"esimCompleted":{"summary":"The eSIM is delivered, with its installation details.","value":{"id":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":25,"currency":"USD"}},"failure":null},"items":[{"id":"01a14329-9cc4-73a3-8ca6-22a3efdde687","orderId":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","productType":"esim","price":{"amount":25,"currency":"USD"},"purchasedProduct":{"name":"Europe 3 GB 7 days","countryCode":null,"logoUrl":"https://cdn.openroam.test/esims/europe.png","inputs":{"eid":null,"imei2":null,"iccid":null,"travelStartDate":null,"isInstant":true},"details":{"orderType":"esim","isInstant":true,"destination":{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","code":"EU"}}},"fulfillment":{"status":"fulfilled","result":{"details":{"iccid":"8944501234567890123","mode":"instant","provisioning":{"status":"ready"},"canProvision":false,"esimStatus":"ready","profileStatus":"new","installation":{"lpaCode":"LPA:1$smdp.example.test$b2b-fixture-activation","smdpAddress":"smdp.example.test","activationCode":"b2b-fixture-activation","qrCodeUrl":null,"iosQuickInstall":"https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.example.test$b2b-fixture-activation","androidQuickInstall":"https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.example.test$b2b-fixture-activation"},"pin":null,"puk":null,"phoneNumber":null,"data":{"amount":3072,"unit":"MB","isUnlimited":false,"label":"3 GB"},"voice":null,"sms":null,"apn":{"apn":"internet","apnUsername":null,"apnPassword":null},"addons":[],"notes":["Data only. Calls and SMS are not included."],"fulfilledAt":"2026-10-16T05:28:03.118204Z"}},"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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"giftCardCompleted":{"summary":"Both gift cards delivered; the gift also reports its email delivery.","value":{"id":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":75.23,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":75.23,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":75.23,"currency":"USD"}},"failure":null},"items":[{"id":"01a1413c-265f-7a02-b7c4-1e3f5a7c9d20","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":48.98,"currency":"USD"},"purchasedProduct":{"name":"Amazon 50 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":50,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":null,"giftMessage":null},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":50,"currency":"USD"},"details":{"codes":[{"cardNumber":"CARD-9001","pinCode":"PIN-9001","instructions":null}],"delivery":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":48.98,"currency":"USD"}},{"id":"01a1413c-265f-77b1-9041-25aee298d4d0","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":26.25,"currency":"USD"},"purchasedProduct":{"name":"Amazon 25 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":25,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":"f***@example.com","giftMessage":"Happy birthday!"},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":25,"currency":"USD"},"details":{"codes":[{"cardNumber":"CARD-9002","pinCode":"PIN-9002","instructions":null}],"delivery":{"status":"pending"}}},"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":26.25,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"utilityCompleted":{"summary":"Both payments delivered; the prepaid one returns the meter token.","value":{"id":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":61.56,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":61.56,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":61.56,"currency":"USD"}},"failure":null},"items":[{"id":"01a14331-d5de-7970-b70e-5734e59e2f7c","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":27.5,"currency":"USD"},"purchasedProduct":{"name":"Fixed postpaid 40 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":40,"currency":"AZN"},"inputs":{"accountNumber":"***4567","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":"***ce-1"},"details":{"serviceType":"postpaid","deliveryType":"directCredit"}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":40,"currency":"AZN"},"details":{"token":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":27.5,"currency":"USD"}},{"id":"01a14331-d5f1-7e18-8963-7fcdc3b15eab","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":34.06,"currency":"USD"},"purchasedProduct":{"name":"Range prepaid 50 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":50,"currency":"AZN"},"inputs":{"accountNumber":"***4321","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":null},"details":{"serviceType":"prepaid","deliveryType":"token"}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":50,"currency":"AZN"},"details":{"token":"test-meter-token"}},"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":34.06,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"partiallyFulfilled":{"summary":"One top-up delivered and one rejected; the rejected one is refunded to the wallet.","value":{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"partiallyFulfilled","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":31.25,"currency":"USD"},"payment":{"status":"partiallyRefunded","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"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":"rejected","result":null,"failure":{"code":11001,"name":"FULFILLMENT_REJECTED","message":"The order item could not be fulfilled."}},"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":0,"currency":"USD"},"refund":{"status":"refunded","amount":{"amount":31.25,"currency":"USD"},"wallet":{"label":"Main wallet","credited":{"amount":31.25,"currency":"USD"}},"updatedAt":"2026-10-16T05:28:03.118204Z"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"partiallyFulfilled","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Order"},"examples":{"airtimeCompleted":{"summary":"Both airtime top-ups delivered: the order is completed.","value":{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"esimCompleted":{"summary":"The eSIM is delivered, with its installation details.","value":{"id":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":25,"currency":"USD"}},"failure":null},"items":[{"id":"01a14329-9cc4-73a3-8ca6-22a3efdde687","orderId":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","productType":"esim","price":{"amount":25,"currency":"USD"},"purchasedProduct":{"name":"Europe 3 GB 7 days","countryCode":null,"logoUrl":"https://cdn.openroam.test/esims/europe.png","inputs":{"eid":null,"imei2":null,"iccid":null,"travelStartDate":null,"isInstant":true},"details":{"orderType":"esim","isInstant":true,"destination":{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","code":"EU"}}},"fulfillment":{"status":"fulfilled","result":{"details":{"iccid":"8944501234567890123","mode":"instant","provisioning":{"status":"ready"},"canProvision":false,"esimStatus":"ready","profileStatus":"new","installation":{"lpaCode":"LPA:1$smdp.example.test$b2b-fixture-activation","smdpAddress":"smdp.example.test","activationCode":"b2b-fixture-activation","qrCodeUrl":null,"iosQuickInstall":"https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.example.test$b2b-fixture-activation","androidQuickInstall":"https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.example.test$b2b-fixture-activation"},"pin":null,"puk":null,"phoneNumber":null,"data":{"amount":3072,"unit":"MB","isUnlimited":false,"label":"3 GB"},"voice":null,"sms":null,"apn":{"apn":"internet","apnUsername":null,"apnPassword":null},"addons":[],"notes":["Data only. Calls and SMS are not included."],"fulfilledAt":"2026-10-16T05:28:03.118204Z"}},"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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"giftCardCompleted":{"summary":"Both gift cards delivered; the gift also reports its email delivery.","value":{"id":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":75.23,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":75.23,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":75.23,"currency":"USD"}},"failure":null},"items":[{"id":"01a1413c-265f-7a02-b7c4-1e3f5a7c9d20","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":48.98,"currency":"USD"},"purchasedProduct":{"name":"Amazon 50 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":50,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":null,"giftMessage":null},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":50,"currency":"USD"},"details":{"codes":[{"cardNumber":"CARD-9001","pinCode":"PIN-9001","instructions":null}],"delivery":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":48.98,"currency":"USD"}},{"id":"01a1413c-265f-77b1-9041-25aee298d4d0","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":26.25,"currency":"USD"},"purchasedProduct":{"name":"Amazon 25 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":25,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":"f***@example.com","giftMessage":"Happy birthday!"},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":25,"currency":"USD"},"details":{"codes":[{"cardNumber":"CARD-9002","pinCode":"PIN-9002","instructions":null}],"delivery":{"status":"pending"}}},"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":26.25,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"utilityCompleted":{"summary":"Both payments delivered; the prepaid one returns the meter token.","value":{"id":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":61.56,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":61.56,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":61.56,"currency":"USD"}},"failure":null},"items":[{"id":"01a14331-d5de-7970-b70e-5734e59e2f7c","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":27.5,"currency":"USD"},"purchasedProduct":{"name":"Fixed postpaid 40 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":40,"currency":"AZN"},"inputs":{"accountNumber":"***4567","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":"***ce-1"},"details":{"serviceType":"postpaid","deliveryType":"directCredit"}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":40,"currency":"AZN"},"details":{"token":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":27.5,"currency":"USD"}},{"id":"01a14331-d5f1-7e18-8963-7fcdc3b15eab","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":34.06,"currency":"USD"},"purchasedProduct":{"name":"Range prepaid 50 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":50,"currency":"AZN"},"inputs":{"accountNumber":"***4321","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":null},"details":{"serviceType":"prepaid","deliveryType":"token"}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":50,"currency":"AZN"},"details":{"token":"test-meter-token"}},"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":34.06,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"partiallyFulfilled":{"summary":"One top-up delivered and one rejected; the rejected one is refunded to the wallet.","value":{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"partiallyFulfilled","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":31.25,"currency":"USD"},"payment":{"status":"partiallyRefunded","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"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":"rejected","result":null,"failure":{"code":11001,"name":"FULFILLMENT_REJECTED","message":"The order item could not be fulfilled."}},"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":0,"currency":"USD"},"refund":{"status":"refunded","amount":{"amount":31.25,"currency":"USD"},"wallet":{"label":"Main wallet","credited":{"amount":31.25,"currency":"USD"}},"updatedAt":"2026-10-16T05:28:03.118204Z"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"partiallyFulfilled","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Order"},"examples":{"airtimeCompleted":{"summary":"Both airtime top-ups delivered: the order is completed.","value":{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"esimCompleted":{"summary":"The eSIM is delivered, with its installation details.","value":{"id":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":25,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":25,"currency":"USD"}},"failure":null},"items":[{"id":"01a14329-9cc4-73a3-8ca6-22a3efdde687","orderId":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","productType":"esim","price":{"amount":25,"currency":"USD"},"purchasedProduct":{"name":"Europe 3 GB 7 days","countryCode":null,"logoUrl":"https://cdn.openroam.test/esims/europe.png","inputs":{"eid":null,"imei2":null,"iccid":null,"travelStartDate":null,"isInstant":true},"details":{"orderType":"esim","isInstant":true,"destination":{"id":"destn_k3m7q2t5w4y6b2d4f6h3j5n7pq","name":"Europe","code":"EU"}}},"fulfillment":{"status":"fulfilled","result":{"details":{"iccid":"8944501234567890123","mode":"instant","provisioning":{"status":"ready"},"canProvision":false,"esimStatus":"ready","profileStatus":"new","installation":{"lpaCode":"LPA:1$smdp.example.test$b2b-fixture-activation","smdpAddress":"smdp.example.test","activationCode":"b2b-fixture-activation","qrCodeUrl":null,"iosQuickInstall":"https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.example.test$b2b-fixture-activation","androidQuickInstall":"https://esimsetup.android.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.example.test$b2b-fixture-activation"},"pin":null,"puk":null,"phoneNumber":null,"data":{"amount":3072,"unit":"MB","isUnlimited":false,"label":"3 GB"},"voice":null,"sms":null,"apn":{"apn":"internet","apnUsername":null,"apnPassword":null},"addons":[],"notes":["Data only. Calls and SMS are not included."],"fulfilledAt":"2026-10-16T05:28:03.118204Z"}},"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"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"giftCardCompleted":{"summary":"Both gift cards delivered; the gift also reports its email delivery.","value":{"id":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":75.23,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":75.23,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":75.23,"currency":"USD"}},"failure":null},"items":[{"id":"01a1413c-265f-7a02-b7c4-1e3f5a7c9d20","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":48.98,"currency":"USD"},"purchasedProduct":{"name":"Amazon 50 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":50,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":null,"giftMessage":null},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":50,"currency":"USD"},"details":{"codes":[{"cardNumber":"CARD-9001","pinCode":"PIN-9001","instructions":null}],"delivery":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":48.98,"currency":"USD"}},{"id":"01a1413c-265f-77b1-9041-25aee298d4d0","orderId":"01a1413c-2641-7c3e-8b5a-6d9f0e1a2b34","productType":"giftCard","price":{"amount":26.25,"currency":"USD"},"purchasedProduct":{"name":"Amazon 25 USD","countryCode":"US","logoUrl":"https://cdn.openroam.test/amazon.png","value":{"amount":25,"currency":"USD"},"inputs":{"recipientIdentifier":null,"recipientEmail":"f***@example.com","giftMessage":"Happy birthday!"},"details":{"brandName":"Amazon","isRedeemableGlobally":false,"redemptionInstructions":"Go to amazon.com/redeem and enter the code."}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":25,"currency":"USD"},"details":{"codes":[{"cardNumber":"CARD-9002","pinCode":"PIN-9002","instructions":null}],"delivery":{"status":"pending"}}},"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":26.25,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"utilityCompleted":{"summary":"Both payments delivered; the prepaid one returns the meter token.","value":{"id":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"completed","total":{"amount":61.56,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":61.56,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":61.56,"currency":"USD"}},"failure":null},"items":[{"id":"01a14331-d5de-7970-b70e-5734e59e2f7c","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":27.5,"currency":"USD"},"purchasedProduct":{"name":"Fixed postpaid 40 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":40,"currency":"AZN"},"inputs":{"accountNumber":"***4567","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":"***ce-1"},"details":{"serviceType":"postpaid","deliveryType":"directCredit"}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":40,"currency":"AZN"},"details":{"token":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":27.5,"currency":"USD"}},{"id":"01a14331-d5f1-7e18-8963-7fcdc3b15eab","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":34.06,"currency":"USD"},"purchasedProduct":{"name":"Range prepaid 50 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":50,"currency":"AZN"},"inputs":{"accountNumber":"***4321","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":null},"details":{"serviceType":"prepaid","deliveryType":"token"}},"fulfillment":{"status":"fulfilled","result":{"deliveredValue":{"amount":50,"currency":"AZN"},"details":{"token":"test-meter-token"}},"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":34.06,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"completed","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}},"partiallyFulfilled":{"summary":"One top-up delivered and one rejected; the rejected one is refunded to the wallet.","value":{"id":"01a1432e-7121-7b0e-a0a0-c35454d3b883","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"partiallyFulfilled","total":{"amount":56.25,"currency":"USD"},"refunded":{"amount":31.25,"currency":"USD"},"payment":{"status":"partiallyRefunded","method":"balance","amount":{"amount":56.25,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":56.25,"currency":"USD"}},"failure":null},"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":"rejected","result":null,"failure":{"code":11001,"name":"FULFILLMENT_REJECTED","message":"The order item could not be fulfilled."}},"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":0,"currency":"USD"},"refund":{"status":"refunded","amount":{"amount":31.25,"currency":"USD"},"wallet":{"label":"Main wallet","credited":{"amount":31.25,"currency":"USD"}},"updatedAt":"2026-10-16T05:28:03.118204Z"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"partiallyFulfilled","occurredAt":"2026-10-16T05:28:03.118204Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:28:03.118204Z","fulfillmentVersion":2}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"500":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"internalError":{"summary":"An unexpected error.","value":{"code":10000,"name":"INTERNAL_ERROR","message":"Unexpected error occurred.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Orders"}},"/v1/orders/quote":{"post":{"tags":["Orders"],"summary":"Quote an order","description":"Prices a mixed order body with current prices, without placing an order.\n\nTakes the same body as order creation (one to five items of one or several product types, a total quantity\nof at most five) and needs no `Idempotency-Key`. Nothing is charged, held or created; `referenceId`\nis checked for its format and not for uniqueness. Returns `currency`, `items`, `total` and\n`expiresAt`. Each item is the quote item that its product's own quote route returns, with\n`productType`; its `publicId` can be a new one (gift cards, hotels and flights issue one), so order\nwith the `publicId` of the quote. `total` is the sum of each item's `price` times its\n`quantity` in the quote currency. `expiresAt` is the earliest `details.expiresAt` of the items\nthat have one, and `null` when none has.\n            \nItems are checked as the order checks them: first the `inputs` of every item, then the offer of every\nitem, then each item is priced in request order. The first failing item ends the quote with the code and\npath of its product's quote route, under `items[i]`, for example `409` / `11002` at\n`items[i].inputs.maxPrice` when the current price is above the guard. An eSIM top-up whose\n`inputs.iccid` is not one of your eSIMs returns `404` with code `10004` (`NOT_FOUND`).\nA quote does not reserve a price: to hold the quoted price, send it as `inputs.maxPrice` in the order.","operationId":"ordersQuoteOrder","requestBody":{"description":"The order to price.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MixedOrderRequest"}],"description":"An order of one to five items, of one or several product types, paid from the wallet."},"examples":{"airtimeAndEsim":{"summary":"An airtime top-up and an eSIM priced together.","value":{"currency":"USD","items":[{"productType":"airtime","publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567"}},{"productType":"esim","publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MixedOrderRequest"}],"description":"An order of one to five items, of one or several product types, paid from the wallet."},"examples":{"airtimeAndEsim":{"summary":"An airtime top-up and an eSIM priced together.","value":{"currency":"USD","items":[{"productType":"airtime","publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567"}},{"productType":"esim","publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MixedOrderRequest"}],"description":"An order of one to five items, of one or several product types, paid from the wallet."},"examples":{"airtimeAndEsim":{"summary":"An airtime top-up and an eSIM priced together.","value":{"currency":"USD","items":[{"productType":"airtime","publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"inputs":{"phoneNumber":"+994501234567"}},{"productType":"esim","publicId":"esim_eu_3gb_7d","quantity":1,"inputs":{"isInstant":true}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/MixedQuote"},"examples":{"airtimeAndEsim":{"summary":"The prices of an airtime top-up and an eSIM, and their total.","value":{"currency":"USD","items":[{"productType":"airtime","publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"name":"Test operator 40 AZN","value":{"amount":40,"currency":"AZN"},"price":{"amount":25,"currency":"USD"},"details":{"estimatedDeliveredValue":{"amount":40,"currency":"AZN"}}},{"productType":"esim","publicId":"esim_eu_3gb_7d","quantity":1,"name":"Europe 3 GB 7 days","price":{"amount":25,"currency":"USD"}}],"total":{"amount":50,"currency":"USD"},"expiresAt":null}}}},"application/json":{"schema":{"$ref":"#/components/schemas/MixedQuote"},"examples":{"airtimeAndEsim":{"summary":"The prices of an airtime top-up and an eSIM, and their total.","value":{"currency":"USD","items":[{"productType":"airtime","publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"name":"Test operator 40 AZN","value":{"amount":40,"currency":"AZN"},"price":{"amount":25,"currency":"USD"},"details":{"estimatedDeliveredValue":{"amount":40,"currency":"AZN"}}},{"productType":"esim","publicId":"esim_eu_3gb_7d","quantity":1,"name":"Europe 3 GB 7 days","price":{"amount":25,"currency":"USD"}}],"total":{"amount":50,"currency":"USD"},"expiresAt":null}}}},"text/json":{"schema":{"$ref":"#/components/schemas/MixedQuote"},"examples":{"airtimeAndEsim":{"summary":"The prices of an airtime top-up and an eSIM, and their total.","value":{"currency":"USD","items":[{"productType":"airtime","publicId":"airtime_raanuxyz6cxzie3w3my6c3r2wm","quantity":1,"name":"Test operator 40 AZN","value":{"amount":40,"currency":"AZN"},"price":{"amount":25,"currency":"USD"},"details":{"estimatedDeliveredValue":{"amount":40,"currency":"AZN"}}},{"productType":"esim","publicId":"esim_eu_3gb_7d","quantity":1,"name":"Europe 3 GB 7 days","price":{"amount":25,"currency":"USD"}}],"total":{"amount":50,"currency":"USD"},"expiresAt":null}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"Conflict","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Service Unavailable","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Orders"}},"/v1/orders/{orderId}/fulfillment/status":{"get":{"tags":["Orders"],"summary":"Get fulfillment status","description":"Gets the current fulfillment state of every item in an order.\n\nReturns the order `id`, its `items` (the same item shape as the order, with each item's\n`fulfillment` status, typed `result` and `failure`) and `fulfillmentVersion`. The\nversion increases with every meaningful fulfillment change, including a later revision of an already\ndelivered result, the cancellation of a delivered item and the completed refund of a delivered item, which\nchanges the order's `status`, and matches `fulfillmentVersion` in the\n`order.fulfillment.updated` webhook: keep the highest version you have seen and use this endpoint to\nrecover after a missed delivery. The refund of an item that was not delivered and an amendment do not\nchange the version; read the order for those. An order of another partner, or an unknown id, returns\n`404` with code `10004`.","operationId":"ordersGetFulfillmentStatus","parameters":[{"name":"orderId","in":"path","description":"Order id.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/OrderFulfillmentStatus"},"examples":{"airtimeDelivered":{"summary":"The delivery state of both top-ups, without the rest of the order.","value":{"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}}}},"application/json":{"schema":{"$ref":"#/components/schemas/OrderFulfillmentStatus"},"examples":{"airtimeDelivered":{"summary":"The delivery state of both top-ups, without the rest of the order.","value":{"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}}}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderFulfillmentStatus"},"examples":{"airtimeDelivered":{"summary":"The delivery state of both top-ups, without the rest of the order.","value":{"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}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Orders"}},"/v1/orders/{id}/cancellation-preview":{"get":{"tags":["Orders"],"summary":"Preview an order cancellation","description":"Previews cancelling every item of an order now, with the totals.\n\nRequires the `read` order permission. Returns `{ orderId, currency, items, totals }`, every amount\nin the order currency. Each item has `orderItemId`, `productType` and `status`.\n`previewable` items carry `preview`, the same payload as\n`GET order-items/{id}/cancellation-preview` (`isRefundable: false` included). An item whose\n`actions.cancellation` is `available` is `previewable`, unless its refund failed; a rejected\none previews a full refund with no penalty. `notCancellable` items carry a `reason`:\n`notFulfilled` (not delivered: unpaid, still being delivered, or rejected while its outcome is\nconfirmed), `refunded`, `refundInProgress` (a refund was started and has not finished, or it failed\nand cancelling the item retries it), `amendmentInProgress`,\n`manualReview` (contact support) or `notAllowed` (the product's rules do not allow cancelling it\nnow). `totals` sums `penaltyAmount`, `cancellationFee` and `refundAmount` over the\n`previewable` items; `totals.isComplete` is `true` only when every item is\n`previewable`.\n            \nThe preview cancels nothing, changes no state and locks no amount: cancelling an item prices its\ncancellation again. Only an item the item preview refuses is `notAllowed`: a booking system that cannot answer\nright now fails this whole call, with `503` when it is unavailable, as it fails the item preview.\nRetry later. An order of another partner, or an unknown id, returns `404` with code `10004`.","operationId":"ordersGetCancellationPreview","parameters":[{"name":"id","in":"path","description":"Order id (`id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/OrderCancellationPreview"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrderCancellationPreview"}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderCancellationPreview"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Service Unavailable","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Orders"}},"/v1/orders/{id}/emails/resend":{"post":{"tags":["Orders"],"summary":"Resend a traveller email","description":"Sends an email of a hosted-site order to its traveller again.\n\nFor a traveller who did not receive an email. The body names the email: `{\"type\":\"receipt\"}`, the receipt\nof what was charged to the traveller's card, or `{\"type\":\"delivery\",\"orderItemId\":\"...\"}`, one item's\ndelivery email (its codes, eSIM installation, top-up or booking confirmation). The email is built as the order\nreads now, in the site's brand and the traveller's language, and goes only to the address the traveller gave\nat checkout; the body takes no address. Requires the `manage` order permission; a site credential can\nsend its own site's emails.\n            \nReturns `{ orderId, type, orderItemId, recipient }`, the address masked, once the email service took the\nemail. An order of another partner, or an item not in the order, is `404` / `10004`. An order with\nno traveller email address (not placed on a hosted site, or the traveller's details were erased) is\n`422` / `18006` (`EMAIL_NOT_SUPPORTED`), reason `NO_TRAVELLER_EMAIL`. An email that cannot\nbe sent now is `409` / `18007` (`EMAIL_NOT_AVAILABLE`) with `details[0].reason`:\n`NOTHING_TO_SEND` (nothing was charged yet, or the item is not delivered yet), `NOT_ELIGIBLE` (the\nitem was rejected or refunded, its codes are withheld, or what it delivered has ended), `IN_PROGRESS` (a\nrefund or another change of the order is running; try again shortly), `EMAILS_OFF`, or\n`UNSUBSCRIBED` (path `id`: the traveller unsubscribed from the site's emails; it stays so until they\nresubscribe). An order's emails\ncan be sent again five times in any hour, across every credential; past that, `429` / `10006`\n(`RATE_LIMITED`), reason `RATE_LIMITED`, with `Retry-After`. A refusal of the email service\nis `503` / `10007` (with `Retry-After` when known) or `502` / `10008`; nothing was\nsent, so send the same request again.\n            \nRequires an `Idempotency-Key` header (a UUID). The same key and body never send twice: a completed request\nanswers as it did, one still running is `409` / `12002`, and a different body `409` /\n`12001`. Sending the email again later needs a new key.","operationId":"ordersResendEmail","parameters":[{"name":"id","in":"path","description":"Order id (`id` from the order response).","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}},{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"description":"The email to send again.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderEmailResendRequest"}],"description":"An email of a hosted-site order to send to its traveller again."},"examples":{"receipt":{"summary":"The receipt of what was charged to the traveller's card.","value":{"type":"receipt"}},"delivery":{"summary":"One item's delivery email: its codes, eSIM installation, top-up or booking confirmation.","value":{"type":"delivery","orderItemId":"01a14329-9cc4-73a3-8ca6-22a3efdde687"}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderEmailResendRequest"}],"description":"An email of a hosted-site order to send to its traveller again."},"examples":{"receipt":{"summary":"The receipt of what was charged to the traveller's card.","value":{"type":"receipt"}},"delivery":{"summary":"One item's delivery email: its codes, eSIM installation, top-up or booking confirmation.","value":{"type":"delivery","orderItemId":"01a14329-9cc4-73a3-8ca6-22a3efdde687"}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderEmailResendRequest"}],"description":"An email of a hosted-site order to send to its traveller again."},"examples":{"receipt":{"summary":"The receipt of what was charged to the traveller's card.","value":{"type":"receipt"}},"delivery":{"summary":"One item's delivery email: its codes, eSIM installation, top-up or booking confirmation.","value":{"type":"delivery","orderItemId":"01a14329-9cc4-73a3-8ca6-22a3efdde687"}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/OrderEmailResendResult"},"examples":{"deliverySent":{"summary":"The delivery email went to the address the traveller gave at checkout.","value":{"orderId":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","type":"delivery","orderItemId":"01a14329-9cc4-73a3-8ca6-22a3efdde687","recipient":"a***@example.com"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/OrderEmailResendResult"},"examples":{"deliverySent":{"summary":"The delivery email went to the address the traveller gave at checkout.","value":{"orderId":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","type":"delivery","orderItemId":"01a14329-9cc4-73a3-8ca6-22a3efdde687","recipient":"a***@example.com"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/OrderEmailResendResult"},"examples":{"deliverySent":{"summary":"The delivery email went to the address the traveller gave at checkout.","value":{"orderId":"01a14329-9cc4-7a1b-9f6e-3c2d1e0b4a58","type":"delivery","orderItemId":"01a14329-9cc4-73a3-8ca6-22a3efdde687","recipient":"a***@example.com"}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"type is missing, or a delivery names no orderItemId.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"type","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"The idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; or it was used for a different request (12001). A finished request sent again with the same key and body returns 200 with the result of the first call, rebuilt from the record that call created as it reads now: nothing runs again, and a status that has moved on since shows its current value.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"emailNotAvailable":{"summary":"The item's codes are withheld, so its email is not sent again.","value":{"code":18007,"name":"EMAIL_NOT_AVAILABLE","message":"This email cannot be sent again right now.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"orderItemId","reason":"NOT_ELIGIBLE"}]}},"emailInProgress":{"summary":"A refund of the item is running; try again shortly.","value":{"code":18007,"name":"EMAIL_NOT_AVAILABLE","message":"This email cannot be sent again right now.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"orderItemId","reason":"IN_PROGRESS"}]}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"422":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"emailNotSupported":{"summary":"The order has no traveller email address; do not retry.","value":{"code":18006,"name":"EMAIL_NOT_SUPPORTED","message":"This order has no traveller email address.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"NO_TRAVELLER_EMAIL"}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"emailNotSupported":{"summary":"The order has no traveller email address; do not retry.","value":{"code":18006,"name":"EMAIL_NOT_SUPPORTED","message":"This order has no traveller email address.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"NO_TRAVELLER_EMAIL"}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"emailNotSupported":{"summary":"The order has no traveller email address; do not retry.","value":{"code":18006,"name":"EMAIL_NOT_SUPPORTED","message":"This order has no traveller email address.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"NO_TRAVELLER_EMAIL"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"resendLimitReached":{"summary":"The order's emails were sent again five times in the last hour.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"id","reason":"RATE_LIMITED"}]}},"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"502":{"description":"Bad Gateway","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"requestNotCompleted":{"summary":"The request could not be completed.","value":{"code":10008,"name":"REQUEST_NOT_COMPLETED","message":"The request could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"requestNotCompleted":{"summary":"The request could not be completed.","value":{"code":10008,"name":"REQUEST_NOT_COMPLETED","message":"The request could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"requestNotCompleted":{"summary":"The request could not be completed.","value":{"code":10008,"name":"REQUEST_NOT_COMPLETED","message":"The request could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"The email was not sent this time; send the same request again.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Orders"}},"/v1/utility/search":{"get":{"tags":["Utility"],"summary":"Search billers","description":"Searches the billers of a country and returns them with their offers, one page at a time.\n\nReturns `{ items, pagination }`. `countryCode` is required; `category`, `serviceType` and\n`q` select billers. Utility has no value or price filter. Pages count billers that still have an offer,\nand prices are indicative, in `currency`. Quote and order take an offer's `publicId`, never the\nbiller's `id`. An invalid or unknown parameter gives 400 / 10001; an unsupported `currency` gives\n404 / 10004.","operationId":"utilitySearch","parameters":[{"name":"countryCode","in":"query","description":"Required ISO 3166-1 alpha-2 country code of the billers, in either case.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"AZ"}}},{"name":"category","in":"query","description":"Keep the billers of this category, for example `electricity`.","schema":{"enum":["other","electricity","water","television","internet","gas","toll","voip","landline"],"type":"string"},"examples":{"default":{"value":"other"}}},{"name":"serviceType","in":"query","description":"Keep `prepaid` or `postpaid` billers.","schema":{"enum":["prepaid","postpaid"],"type":"string"},"examples":{"default":{"value":"prepaid"}}},{"name":"q","in":"query","description":"Text in the biller name, case-insensitive; at most 100 characters, without control characters.","schema":{"type":"string"}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}},{"name":"page","in":"query","description":"Page number, from 1; default 1.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":1}}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 10.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/UtilitySearchResult"},"examples":{"fixedAndRangeBillers":{"summary":"A biller that settles a fixed invoice amount, and one that takes any amount.","value":{"items":[{"id":"biller_3jx464dkw4ekdjgj4qxuib5wki","name":"Fixed postpaid","countryCode":"AZ","category":"other","logoUrl":null,"description":null,"offers":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","name":"Local tier","description":null,"value":{"type":"fixed","amount":40,"currency":"AZN"},"price":{"amount":27.5,"currency":"USD"},"requiredInputs":[{"name":"accountNumber","type":"text","required":true,"description":"The customer's account or meter number with the biller."},{"name":"invoiceId","type":"text","required":true,"description":"The ID of the bill to pay, as the biller issued it."}]}],"details":{"serviceType":"postpaid","deliveryType":"directCredit"}},{"id":"biller_jeicjoplfgowwmc2h7mbwbatqe","name":"Range prepaid","countryCode":"AZ","category":"other","logoUrl":null,"description":null,"offers":[{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","name":"Range prepaid 20–200 AZN","description":null,"value":{"type":"range","min":20,"max":200,"step":0.01,"currency":"AZN"},"price":{"min":14.38,"max":132.5,"currency":"USD"},"requiredInputs":[{"name":"accountNumber","type":"text","required":true,"description":"The customer's account or meter number with the biller."}]}],"details":{"serviceType":"prepaid","deliveryType":"token"}}],"pagination":{"currentCount":2,"totalCount":2,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/UtilitySearchResult"},"examples":{"fixedAndRangeBillers":{"summary":"A biller that settles a fixed invoice amount, and one that takes any amount.","value":{"items":[{"id":"biller_3jx464dkw4ekdjgj4qxuib5wki","name":"Fixed postpaid","countryCode":"AZ","category":"other","logoUrl":null,"description":null,"offers":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","name":"Local tier","description":null,"value":{"type":"fixed","amount":40,"currency":"AZN"},"price":{"amount":27.5,"currency":"USD"},"requiredInputs":[{"name":"accountNumber","type":"text","required":true,"description":"The customer's account or meter number with the biller."},{"name":"invoiceId","type":"text","required":true,"description":"The ID of the bill to pay, as the biller issued it."}]}],"details":{"serviceType":"postpaid","deliveryType":"directCredit"}},{"id":"biller_jeicjoplfgowwmc2h7mbwbatqe","name":"Range prepaid","countryCode":"AZ","category":"other","logoUrl":null,"description":null,"offers":[{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","name":"Range prepaid 20–200 AZN","description":null,"value":{"type":"range","min":20,"max":200,"step":0.01,"currency":"AZN"},"price":{"min":14.38,"max":132.5,"currency":"USD"},"requiredInputs":[{"name":"accountNumber","type":"text","required":true,"description":"The customer's account or meter number with the biller."}]}],"details":{"serviceType":"prepaid","deliveryType":"token"}}],"pagination":{"currentCount":2,"totalCount":2,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/UtilitySearchResult"},"examples":{"fixedAndRangeBillers":{"summary":"A biller that settles a fixed invoice amount, and one that takes any amount.","value":{"items":[{"id":"biller_3jx464dkw4ekdjgj4qxuib5wki","name":"Fixed postpaid","countryCode":"AZ","category":"other","logoUrl":null,"description":null,"offers":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","name":"Local tier","description":null,"value":{"type":"fixed","amount":40,"currency":"AZN"},"price":{"amount":27.5,"currency":"USD"},"requiredInputs":[{"name":"accountNumber","type":"text","required":true,"description":"The customer's account or meter number with the biller."},{"name":"invoiceId","type":"text","required":true,"description":"The ID of the bill to pay, as the biller issued it."}]}],"details":{"serviceType":"postpaid","deliveryType":"directCredit"}},{"id":"biller_jeicjoplfgowwmc2h7mbwbatqe","name":"Range prepaid","countryCode":"AZ","category":"other","logoUrl":null,"description":null,"offers":[{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","name":"Range prepaid 20–200 AZN","description":null,"value":{"type":"range","min":20,"max":200,"step":0.01,"currency":"AZN"},"price":{"min":14.38,"max":132.5,"currency":"USD"},"requiredInputs":[{"name":"accountNumber","type":"text","required":true,"description":"The customer's account or meter number with the biller."}]}],"details":{"serviceType":"prepaid","deliveryType":"token"}}],"pagination":{"currentCount":2,"totalCount":2,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Utility"}},"/v1/utility/billers/{id}":{"get":{"tags":["Utility"],"summary":"Get a biller","description":"Returns one biller with its offers, in the item shape that search returns.\n\nAn unknown ID, an ID that does not start with `biller_` (an offer's `publicId` among them), or a\nbiller without an orderable offer gives 404 / 10004.","operationId":"utilityGetBiller","parameters":[{"name":"id","in":"path","description":"The biller's opaque `id` from search or the catalog, for example `biller_3jx4…`.","required":true,"schema":{"type":"string"},"examples":{"default":{"value":"biller_3jx464dkw4ekdjgj4qxuib5wki"}}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Biller"}},"application/json":{"schema":{"$ref":"#/components/schemas/Biller"}},"text/json":{"schema":{"$ref":"#/components/schemas/Biller"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Utility"}},"/v1/utility/catalog":{"get":{"tags":["Utility"],"summary":"Utility catalog","description":"Returns every biller with its offers, page by page, for partner inventory.\n\nReturns `{ items, nextCursor }`, ordered by biller ID, with the search filters except `q`. Continue\nwith `nextCursor` as `cursor`, the same filters and the same `currency` until it is null; a page\ncan hold fewer billers than `limit`, even none, while `nextCursor` is not null. A cursor reused with\nother filters or another currency gives 400 / 10001. The walk is not a frozen snapshot: update your copy by\nbiller `id`, and remove a biller only when a complete walk did not return it. On 429, wait for\n`Retry-After` and request the same page again.","operationId":"utilityGetCatalog","parameters":[{"name":"countryCode","in":"query","description":"Optional ISO 3166-1 alpha-2 country filter, in either case; every country when omitted. A blank value is rejected.","schema":{"type":"string"},"examples":{"default":{"value":"AZ"}}},{"name":"category","in":"query","description":"Keep the billers of this category, for example `electricity`.","schema":{"enum":["other","electricity","water","television","internet","gas","toll","voip","landline"],"type":"string"},"examples":{"default":{"value":"other"}}},{"name":"serviceType","in":"query","description":"Keep `prepaid` or `postpaid` billers.","schema":{"enum":["prepaid","postpaid"],"type":"string"},"examples":{"default":{"value":"prepaid"}}},{"name":"currency","in":"query","description":"Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`.","schema":{"type":"string"},"examples":{"default":{"value":"USD"}}},{"name":"cursor","in":"query","description":"The `nextCursor` of the previous page; omit it for the first page. Reuse it only with the same filters and currency.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Page size, 1 to 100; default 100.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/UtilityCatalogPage"}},"application/json":{"schema":{"$ref":"#/components/schemas/UtilityCatalogPage"}},"text/json":{"schema":{"$ref":"#/components/schemas/UtilityCatalogPage"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Utility"}},"/v1/utility/order":{"post":{"tags":["Utility"],"summary":"Pay utility bills","description":"Places a utility bill payment order and returns the accepted order.\n\nTakes the same body as quote and needs the `manage` order permission (403 / 10003 without it).\nAn `Idempotency-Key` header with a new UUID is required for every purchase: a retry with the same key and body\nreturns the order already accepted, 409 / 12002 with `Retry-After` while it is still being accepted, and a\nchanged body gives 409 / 12001.\nEvery price is recalculated: a current price above `inputs.maxPrice` gives 409 / 11002 at\n`items[i].inputs.maxPrice` before anything is charged, and without `inputs.maxPrice` the current price\nis charged. The item is fulfilled when the payment is confirmed and, for a `token` biller, the\ntoken is returned; track it with the order routes or the `order.fulfillment.updated` webhook. A wallet\ncharge that fails creates no order and gives 402 / 16000, with `details[0]` naming `wallet` and\n`INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`; send the same request with the same key after a top-up.","operationId":"utilityCreateOrder","parameters":[{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UtilityOrderRequest"}],"description":"The body B2B utility quote and order both take."},"examples":{"fixedAndRangeBill":{"summary":"A fixed bill amount for an invoice, and a range payment by account number.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","quantity":1,"inputs":{"accountNumber":"1234567","invoiceId":"invoice-1","maxPrice":{"amount":30,"currency":"USD"}}},{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","quantity":1,"inputs":{"accountNumber":"7654321","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":35,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UtilityOrderRequest"}],"description":"The body B2B utility quote and order both take."},"examples":{"fixedAndRangeBill":{"summary":"A fixed bill amount for an invoice, and a range payment by account number.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","quantity":1,"inputs":{"accountNumber":"1234567","invoiceId":"invoice-1","maxPrice":{"amount":30,"currency":"USD"}}},{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","quantity":1,"inputs":{"accountNumber":"7654321","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":35,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UtilityOrderRequest"}],"description":"The body B2B utility quote and order both take."},"examples":{"fixedAndRangeBill":{"summary":"A fixed bill amount for an invoice, and a range payment by account number.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","quantity":1,"inputs":{"accountNumber":"1234567","invoiceId":"invoice-1","maxPrice":{"amount":30,"currency":"USD"}}},{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","quantity":1,"inputs":{"accountNumber":"7654321","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":35,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/UtilityOrder"},"examples":{"paidOrderWithTwoPayments":{"summary":"The order as placed: paid from the wallet and processing, both payments still pending.","value":{"id":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":61.56,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":61.56,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":61.56,"currency":"USD"}},"failure":null},"items":[{"id":"01a14331-d5de-7970-b70e-5734e59e2f7c","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":27.5,"currency":"USD"},"purchasedProduct":{"name":"Fixed postpaid 40 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":40,"currency":"AZN"},"inputs":{"accountNumber":"***4567","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":"***ce-1"},"details":{"serviceType":"postpaid","deliveryType":"directCredit"}},"fulfillment":{"status":"pending","result":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":27.5,"currency":"USD"}},{"id":"01a14331-d5f1-7e18-8963-7fcdc3b15eab","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":34.06,"currency":"USD"},"purchasedProduct":{"name":"Range prepaid 50 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":50,"currency":"AZN"},"inputs":{"accountNumber":"***4321","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":null},"details":{"serviceType":"prepaid","deliveryType":"token"}},"fulfillment":{"status":"pending","result":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":34.06,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}},"application/json":{"schema":{"$ref":"#/components/schemas/UtilityOrder"},"examples":{"paidOrderWithTwoPayments":{"summary":"The order as placed: paid from the wallet and processing, both payments still pending.","value":{"id":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":61.56,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":61.56,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":61.56,"currency":"USD"}},"failure":null},"items":[{"id":"01a14331-d5de-7970-b70e-5734e59e2f7c","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":27.5,"currency":"USD"},"purchasedProduct":{"name":"Fixed postpaid 40 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":40,"currency":"AZN"},"inputs":{"accountNumber":"***4567","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":"***ce-1"},"details":{"serviceType":"postpaid","deliveryType":"directCredit"}},"fulfillment":{"status":"pending","result":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":27.5,"currency":"USD"}},{"id":"01a14331-d5f1-7e18-8963-7fcdc3b15eab","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":34.06,"currency":"USD"},"purchasedProduct":{"name":"Range prepaid 50 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":50,"currency":"AZN"},"inputs":{"accountNumber":"***4321","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":null},"details":{"serviceType":"prepaid","deliveryType":"token"}},"fulfillment":{"status":"pending","result":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":34.06,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}},"text/json":{"schema":{"$ref":"#/components/schemas/UtilityOrder"},"examples":{"paidOrderWithTwoPayments":{"summary":"The order as placed: paid from the wallet and processing, both payments still pending.","value":{"id":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","referenceId":"partner-order-42","origin":{"channel":"api"},"status":"processing","total":{"amount":61.56,"currency":"USD"},"refunded":{"amount":0,"currency":"USD"},"payment":{"status":"completed","method":"balance","amount":{"amount":61.56,"currency":"USD"},"wallet":{"label":"Main wallet","debited":{"amount":61.56,"currency":"USD"}},"failure":null},"items":[{"id":"01a14331-d5de-7970-b70e-5734e59e2f7c","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":27.5,"currency":"USD"},"purchasedProduct":{"name":"Fixed postpaid 40 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":40,"currency":"AZN"},"inputs":{"accountNumber":"***4567","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":"***ce-1"},"details":{"serviceType":"postpaid","deliveryType":"directCredit"}},"fulfillment":{"status":"pending","result":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":27.5,"currency":"USD"}},{"id":"01a14331-d5f1-7e18-8963-7fcdc3b15eab","orderId":"01a14331-d5ce-7f2a-9b1c-4e6d8a0c2f13","productType":"utility","price":{"amount":34.06,"currency":"USD"},"purchasedProduct":{"name":"Range prepaid 50 AZN","countryCode":"AZ","logoUrl":null,"value":{"amount":50,"currency":"AZN"},"inputs":{"accountNumber":"***4321","mobileNumber":null,"beneficiaryMobileNumber":null,"invoiceId":null},"details":{"serviceType":"prepaid","deliveryType":"token"}},"fulfillment":{"status":"pending","result":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":34.06,"currency":"USD"}}],"timeline":[{"status":"paymentPending","occurredAt":"2026-10-16T05:27:59.521962Z"},{"status":"processing","occurredAt":"2026-10-16T05:27:59.521962Z"}],"createdAt":"2026-10-16T05:27:59.521962Z","updatedAt":"2026-10-16T05:27:59.521962Z","fulfillmentVersion":1}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"402":{"description":"Payment Required","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"paymentFailed":{"summary":"The wallet charge failed; nothing was charged.","value":{"code":16000,"name":"PAYMENT_FAILED","message":"Payment could not be completed.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"wallet","reason":"INSUFFICIENT_BALANCE"}]}}}}}},"409":{"description":"The offer changed since it was quoted: its price rose (11002, for products that check the quoted price) or it is no longer available (11003). Or the idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; it was used for a different request (12001); or its history is ambiguous.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Utility"}},"/v1/utility/quote":{"post":{"tags":["Utility"],"summary":"Quote utility payments","description":"Prices the order body with current prices, without placing an order.\n\nTakes the same body as order, with offer public IDs; a biller's own ID is not an offer (400 / 11004). Each\nitem is priced on its own, in request order; the first failing item aborts the quote and is named at\n`items[i]`, for example 409 / 11002 at `items[i].inputs.maxPrice` when the current price is above it.\nA quote reserves nothing, does not expire, submits no payment and does not check the customer's account with\nthe biller.","operationId":"utilityQuote","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UtilityOrderRequest"}],"description":"The body B2B utility quote and order both take."},"examples":{"fixedAndRangeBill":{"summary":"A fixed bill amount for an invoice, and a range payment by account number.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","quantity":1,"inputs":{"accountNumber":"1234567","invoiceId":"invoice-1","maxPrice":{"amount":30,"currency":"USD"}}},{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","quantity":1,"inputs":{"accountNumber":"7654321","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":35,"currency":"USD"}}}]}}}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UtilityOrderRequest"}],"description":"The body B2B utility quote and order both take."},"examples":{"fixedAndRangeBill":{"summary":"A fixed bill amount for an invoice, and a range payment by account number.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","quantity":1,"inputs":{"accountNumber":"1234567","invoiceId":"invoice-1","maxPrice":{"amount":30,"currency":"USD"}}},{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","quantity":1,"inputs":{"accountNumber":"7654321","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":35,"currency":"USD"}}}]}}}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UtilityOrderRequest"}],"description":"The body B2B utility quote and order both take."},"examples":{"fixedAndRangeBill":{"summary":"A fixed bill amount for an invoice, and a range payment by account number.","value":{"currency":"USD","referenceId":"partner-order-42","items":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","quantity":1,"inputs":{"accountNumber":"1234567","invoiceId":"invoice-1","maxPrice":{"amount":30,"currency":"USD"}}},{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","quantity":1,"inputs":{"accountNumber":"7654321","value":{"amount":50,"currency":"AZN"},"maxPrice":{"amount":35,"currency":"USD"}}}]}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/UtilityQuote"},"examples":{"twoBills":{"summary":"The prices of the two payments and their total.","value":{"currency":"USD","items":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","quantity":1,"name":"Fixed postpaid 40 AZN","value":{"amount":40,"currency":"AZN"},"price":{"amount":27.5,"currency":"USD"},"details":{"deliveryType":"directCredit"}},{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","quantity":1,"name":"Range prepaid 50 AZN","value":{"amount":50,"currency":"AZN"},"price":{"amount":34.06,"currency":"USD"},"details":{"deliveryType":"token"}}],"total":{"amount":61.56,"currency":"USD"}}}}},"application/json":{"schema":{"$ref":"#/components/schemas/UtilityQuote"},"examples":{"twoBills":{"summary":"The prices of the two payments and their total.","value":{"currency":"USD","items":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","quantity":1,"name":"Fixed postpaid 40 AZN","value":{"amount":40,"currency":"AZN"},"price":{"amount":27.5,"currency":"USD"},"details":{"deliveryType":"directCredit"}},{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","quantity":1,"name":"Range prepaid 50 AZN","value":{"amount":50,"currency":"AZN"},"price":{"amount":34.06,"currency":"USD"},"details":{"deliveryType":"token"}}],"total":{"amount":61.56,"currency":"USD"}}}}},"text/json":{"schema":{"$ref":"#/components/schemas/UtilityQuote"},"examples":{"twoBills":{"summary":"The prices of the two payments and their total.","value":{"currency":"USD","items":[{"publicId":"utility_7tq2mw5kxr3nbv6hzc4dpe2ysa","quantity":1,"name":"Fixed postpaid 40 AZN","value":{"amount":40,"currency":"AZN"},"price":{"amount":27.5,"currency":"USD"},"details":{"deliveryType":"directCredit"}},{"publicId":"utility_k4hv2cq7wnz5jr3xmtb6eyl2pa","quantity":1,"name":"Range prepaid 50 AZN","value":{"amount":50,"currency":"AZN"},"price":{"amount":34.06,"currency":"USD"},"details":{"deliveryType":"token"}}],"total":{"amount":61.56,"currency":"USD"}}}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"409":{"description":"Conflict","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"conflict":{"summary":"The request conflicts with the current state.","value":{"code":10005,"name":"CONFLICT","message":"The request conflicts with the current state.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Utility"}},"/v1/wallets":{"get":{"tags":["Wallets"],"summary":"List wallets","description":"Lists all of the partner's wallets.\n\nReturns the whole list as an array, without paging. Each wallet has its `id`, `label`,\n`balance`, whether it `isSelected` (the wallet that pays for orders) and its `currency`.","operationId":"walletsGetAll","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WalletSummary"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WalletSummary"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WalletSummary"}}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Wallets"},"post":{"tags":["Wallets"],"summary":"Create a wallet","description":"Creates an empty wallet in a currency the partner has no wallet in yet.\n\nTake `currencyId` from `GET currencies`. The new wallet starts with a zero balance. Without a\n`label` it is named after its currency, for example `USD wallet`. The partner's first wallet is\nalways selected; for a later one, `isSelected: true` makes it the selected wallet in place of the\ncurrent one. Returns `201` without a body; list the wallets to read it.\n            \nA second wallet in the same currency returns `400` with code `17000`\n(`WALLET_CURRENCY_ALREADY_EXISTS`); a label already used by another of the partner's wallets,\nignoring case, returns `400` with code `17001` (`WALLET_LABEL_ALREADY_EXISTS`).","operationId":"walletsCreate","requestBody":{"description":"The wallet to create.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WalletCreateRequest"}],"description":"A new wallet in a currency the partner has no wallet in yet."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WalletCreateRequest"}],"description":"A new wallet in a currency the partner has no wallet in yet."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WalletCreateRequest"}],"description":"A new wallet in a currency the partner has no wallet in yet."}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Wallets"}},"/v1/wallets/{id}":{"get":{"tags":["Wallets"],"summary":"Get a wallet","description":"Gets one wallet with its totals.\n\nAdds `lowBalanceThreshold`, `createdAt`, `updatedAt` and totals of completed transactions to\nthe list fields. An unknown wallet, or one of another partner, returns `404` with code `10004`.","operationId":"walletsGetById","parameters":[{"name":"id","in":"path","description":"Wallet id.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Wallet"}},"application/json":{"schema":{"$ref":"#/components/schemas/Wallet"}},"text/json":{"schema":{"$ref":"#/components/schemas/Wallet"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Wallets"},"patch":{"tags":["Wallets"],"summary":"Update a wallet","description":"Renames a wallet or changes its low-balance threshold.\n\nOnly the members in the body change; a member left out keeps its value. Send at least one member: an\nempty body returns `400` with code `10001` and `REQUIRED` at `$`. `label` cannot\nbe `null` or blank (`INVALID_VALUE` at `label`); `lowBalanceThreshold: null` clears\nthe threshold. The wallet id comes from the route only: any other member, such as `walletId`, returns\n`400` with code `10001` at its path. A label already used by another of the partner's wallets,\nignoring case, returns `400` with code `17001` (`WALLET_LABEL_ALREADY_EXISTS`); an unknown\nwallet returns `404` with code `10004`.","operationId":"walletsUpdate","parameters":[{"name":"id","in":"path","description":"Wallet id.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}}],"requestBody":{"description":"The members to change.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WalletUpdateRequest"}],"description":"The changes to a wallet. A member left out keeps its value; send at least one member. The wallet id\n            comes from the route only."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WalletUpdateRequest"}],"description":"The changes to a wallet. A member left out keeps its value; send at least one member. The wallet id\n            comes from the route only."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WalletUpdateRequest"}],"description":"The changes to a wallet. A member left out keeps its value; send at least one member. The wallet id\n            comes from the route only."}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Wallets"}},"/v1/wallets/select/{id}":{"patch":{"tags":["Wallets"],"summary":"Select a wallet","description":"Makes a wallet the partner's selected wallet, which pays for new orders.\n\nExactly one wallet is selected at a time; the previously selected wallet is deselected. An unknown wallet\nreturns `404` with code `10004` and leaves the current selection unchanged.","operationId":"walletsSelect","parameters":[{"name":"id","in":"path","description":"Wallet id to select.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"01a1432e-7121-7b0e-a0a0-c35454d3b883"}}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Wallets"}},"/v1/wallets/transfer":{"post":{"tags":["Wallets"],"summary":"Transfer between wallets","description":"Moves funds from one of the partner's wallets to another, converting between their currencies.\n\n`amount` is in the source wallet's currency and has at most that currency's ISO 4217 decimals (none\nin `KRW` or `JPY`, three in `KWD`, two in most); more decimals return `400` with code\n`10001` and `INVALID_VALUE` at `amount`, whose `message` names the decimals allowed,\nsuch as `An amount in JPY cannot have decimals.` The destination receives the amount converted at\nthe current rate, rounded to its own currency's decimals. Returns the `transferId`, the sent\nand received amounts and currencies, the `conversionRate` and the `transferDate`. Both wallets\nrecord an `exchange` transaction.\n            \nThe two wallets must differ, and the amount must be above zero; otherwise the call returns `400` with\ncode `10001`. An unknown wallet returns `404` with code `10004`. A source wallet that cannot\npay the amount now returns `409` with code `10005` (`CONFLICT`) and\n`details[0] = { path: \"fromWalletId\", reason }`: `INSUFFICIENT_BALANCE` when its balance is too\nlow, `WALLET_BLOCKED` while its spending is blocked. The same request can succeed once that changes.\n            \nRequires an `Idempotency-Key` header (a UUID). Repeating a completed transfer with the same key and body\nreturns `200` with that transfer, the same `transferId` and amounts, and moves no money again. One\nstill running returns `409` with code `12002` (`IDEMPOTENCY_KEY_IN_PROGRESS`) and a\n`Retry-After` header, and a different body with the same key `409` with code `12001`. A\nrequest that ended in an error can be sent again with the same key and body.","operationId":"walletsTransfer","parameters":[{"name":"Idempotency-Key","in":"header","description":"UUID idempotency key for safe retries of this operation.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10"}}}],"requestBody":{"description":"The source wallet, destination wallet and amount.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WalletTransferRequest"}],"description":"A transfer between two of the partner's wallets."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WalletTransferRequest"}],"description":"A transfer between two of the partner's wallets."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WalletTransferRequest"}],"description":"A transfer between two of the partner's wallets."}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/WalletTransfer"}},"application/json":{"schema":{"$ref":"#/components/schemas/WalletTransfer"}},"text/json":{"schema":{"$ref":"#/components/schemas/WalletTransfer"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"The key is not allowed to do this.","value":{"code":10003,"name":"FORBIDDEN","message":"Access is denied.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"409":{"description":"The idempotency key: a request with this key is still running (12002): send the same request, key and body again after Retry-After seconds; or it was used for a different request (12001). A finished request sent again with the same key and body returns 200 with the result of the first call, rebuilt from the record that call created as it reads now: nothing runs again, and a status that has moved on since shows its current value.","headers":{"Retry-After":{"description":"Sent with 12002: seconds to wait before sending the same request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"offerPriceChanged":{"summary":"The price rose since the quote.","value":{"code":11002,"name":"OFFER_PRICE_CHANGED","message":"The offer price has changed. Request a new quote.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"offerUnavailable":{"summary":"The offer can no longer be bought.","value":{"code":11003,"name":"OFFER_UNAVAILABLE","message":"The offer is no longer available.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"idempotencyKeyRequestMismatch":{"summary":"The key was used for a different request.","value":{"code":12001,"name":"IDEMPOTENCY_KEY_REQUEST_MISMATCH","message":"This idempotency key was used for a different request.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"503":{"description":"Idempotency state is temporarily unavailable; retry the same request and key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"temporarilyUnavailable":{"summary":"A service needed for this request did not answer.","value":{"code":10007,"name":"TEMPORARILY_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}},"serviceUnavailable":{"summary":"A part of the service is temporarily unavailable.","value":{"code":10011,"name":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Wallets"}},"/v1/wallets/{walletId}/transactions":{"get":{"tags":["Wallets"],"summary":"List wallet transactions","description":"Lists a wallet's transactions, newest first, with optional filters.\n\nReturns `{ transactions, pagination }`. In a transaction, `type` `debit` takes funds from the\nwallet and `credit` adds funds to it; `source` says why (`topUp`, `payOut`,\n`order`, `exchange` or `reversal`), and `orderId` names the order a payment or refund\nbelongs to. Filters combine with AND and apply before counting and paging.\n            \nUse flat `page` (default 1) and `limit` (default 10, 1 to 100) query parameters.\n`cursor`, `skip`, `offset`, nested paging keys and repeated paging parameters return\n`400` with code `10001` (`INVALID_REQUEST`). An unknown wallet returns `404` with code\n`10004`.","operationId":"walletsGetTransactions","parameters":[{"name":"walletId","in":"path","description":"Wallet id.","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"default":{"value":"7c9e6679-7425-40de-944b-e07fc1f90ae7"}}},{"name":"page","in":"query","description":"One-based page number. Default 1.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":1}}},{"name":"limit","in":"query","description":"Page size, 1 to 100. Default 10.","schema":{"type":"integer","format":"int32"},"examples":{"default":{"value":10}}},{"name":"startDate","in":"query","description":"Only transactions made at or after this time (UTC). ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-01T00:00:00Z"}}},{"name":"endDate","in":"query","description":"Only transactions made at or before this time (UTC). ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.","schema":{"type":"string","format":"date-time"},"examples":{"default":{"value":"2026-10-31T23:59:59Z"}}},{"name":"type","in":"query","description":"Only this direction: `debit` takes funds from the wallet, `credit` adds funds to it.","schema":{"enum":["debit","credit"],"type":"string"},"examples":{"default":{"value":"debit"}}},{"name":"source","in":"query","description":"Only transactions with this cause, such as `order` or `exchange`.","schema":{"enum":["topUp","payOut","order","exchange","reversal"],"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/WalletTransactionList"}},"application/json":{"schema":{"$ref":"#/components/schemas/WalletTransactionList"}},"text/json":{"schema":{"$ref":"#/components/schemas/WalletTransactionList"}}}},"400":{"description":"Invalid partner request or model validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalidRequest":{"summary":"A field is missing or invalid.","value":{"code":10001,"name":"INVALID_REQUEST","message":"The request is invalid.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e","details":[{"path":"items[0].publicId","reason":"REQUIRED"}]}}}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"The request is not authenticated.","value":{"code":10002,"name":"UNAUTHORIZED","message":"Authentication is required.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"notFound":{"summary":"The resource does not exist or is not yours.","value":{"code":10004,"name":"NOT_FOUND","message":"The requested resource was not found.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}},"429":{"description":"Too many requests from this IP address. Wait for Retry-After seconds, then send the same request again; an order keeps its Idempotency-Key and body.","headers":{"Retry-After":{"description":"Seconds to wait before sending the request again.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rateLimited":{"summary":"Too many requests from this IP address.","value":{"code":10006,"name":"RATE_LIMITED","message":"Too many requests. Please retry later.","requestId":"b7d1c3e4-5a6f-4c8b-9d2e-1f0a3b5c7d9e"}}}}}}},"x-apidog-folder":"API reference/Wallets"}}},"components":{"schemas":{"AccountService":{"required":["enabled","productType","requestable"],"type":"object","properties":{"productType":{"enum":["esim","hotel","flight","carRental","train","lounge","ticket","tour","activity","cruise","remittance","vpn","transportation","insurance","billPayment","giftCard","loyaltyProgram","voip","airtime","utility"],"type":"string"},"enabled":{"type":"boolean"},"requestable":{"type":"boolean"}},"additionalProperties":false,"description":"One service OpenRoam sells through the Partner API. `enabled` says whether the account may search, quote\nand order it now. `requestable` says whether the account can ask OpenRoam to enable it; an enabled\nservice is never requestable."},"AccountServiceList":{"required":["services"],"type":"object","properties":{"services":{"type":"array","items":{"$ref":"#/components/schemas/AccountService"}}},"additionalProperties":false,"description":"Every service OpenRoam sells through the Partner API, ordered by product type, with the account's access."},"ActionAvailability":{"required":["availability"],"type":"object","properties":{"availability":{"enum":["available","notAvailable","manualReview","inProgress"],"type":"string","description":"`available`; `notAvailable`; `manualReview` (handled by support or the\n            manual flow); or `inProgress` (already running)."},"reason":{"type":["string","null"],"description":"Why the action is limited, when there is a reason to show."}},"additionalProperties":false,"description":"Whether an action can be taken now."},"Address":{"type":"object","properties":{"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"city":{"type":["string","null"]},"stateProvince":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"countryCode":{"type":["string","null"]},"countryName":{"type":["string","null"]}},"additionalProperties":false},"Aircraft":{"type":"object","properties":{"iataCode":{"type":["string","null"]},"name":{"type":["string","null"]},"imageUrl":{"type":["string","null"]}},"additionalProperties":false},"Airline":{"required":["iataCode"],"type":"object","properties":{"iataCode":{"type":"string"},"name":{"type":["string","null"]},"logoUrl":{"type":["string","null"]}},"additionalProperties":false},"Airport":{"required":["iataCode"],"type":"object","properties":{"iataCode":{"type":"string"},"icaoCode":{"type":["string","null"]},"name":{"type":["string","null"]},"city":{"type":["string","null"]},"cityIataCode":{"type":["string","null"]},"countryCode":{"type":["string","null"]},"terminal":{"type":["string","null"]},"timezone":{"type":["string","null"]}},"additionalProperties":false},"AirtimeCatalogPage":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AirtimeOperatorSummary"}},"nextCursor":{"type":["string","null"]}},"additionalProperties":false,"description":"A page of the operator directory, ordered by operator ID. Continue with `nextCursor` and the same\nfilters until it is null; a page may hold fewer items than the limit."},"AirtimeFulfillment":{"required":["status"],"type":"object","properties":{"status":{"enum":["pending","fulfilled","rejected"],"type":"string","description":"`pending`, `fulfilled` or `rejected`."},"result":{"oneOf":[{"$ref":"#/components/schemas/AirtimeFulfillmentResult"},{"enum":[null],"type":["string","null"]}]},"failure":{"description":"Why delivery was rejected (`11001`, `FULFILLMENT_REJECTED`); set only when\n            `rejected`.","anyOf":[{"$ref":"#/components/schemas/FulfillmentFailure"},{"type":"null"}]},"progress":{"anyOf":[{"$ref":"#/components/schemas/FulfillmentProgress"},{"type":"null"}]}},"additionalProperties":false},"AirtimeFulfillmentDetails":{"type":"object","properties":{"redemption":{"description":"`type` is `directTopUp` (automatic recharge) or `pin` (customer activation). A PIN top-up\ncarries the issued `pin` as a string and the customer `instructions`; either is null when\nit was not received, and both are null for a direct top-up.","anyOf":[{"$ref":"#/components/schemas/AirtimeRedemption"},{"type":"null"}]}},"additionalProperties":false,"description":"How the customer redeems the delivered top-up. `redemption` is null when the route does not declare\nits delivery."},"AirtimeFulfillmentResult":{"required":["details"],"type":"object","properties":{"deliveredValue":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"details":{"allOf":[{"$ref":"#/components/schemas/AirtimeFulfillmentDetails"}],"description":"How the customer redeems the delivered top-up. `redemption` is null when the route does not declare\nits delivery."}},"additionalProperties":false,"description":"What a fulfilled airtime item delivered. `deliveredValue` is the amount the\nrecipient received, null until it is known. Order reads and the `order.fulfillment.updated` webhook carry the\nsame result."},"AirtimeFulfillmentUpdate":{"required":["fulfillment","id","productType"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productType":{"enum":["airtime"],"type":"string"},"fulfillment":{"$ref":"#/components/schemas/AirtimeFulfillment"}},"additionalProperties":false},"AirtimeInputs":{"required":["phoneNumber"],"type":"object","properties":{"phoneNumber":{"type":"string","description":"The recipient's mobile number in international format, starting with + or 00."},"settings":{"type":["object","null"],"additionalProperties":{"type":"string"},"description":"Operator settings, keyed by the names the offer lists as `settings.{name}`."},"minDeliveredValue":{"description":"Optional lowest accepted delivered value, for a range offer only: in the inputs.value currency and at most inputs.value. Without it, the exact value must be delivered.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]},"value":{"description":"Required for a range offer, within its min and max and on its step; optional for a fixed offer, where it must equal the offer's amount; in the offer's value currency.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]},"maxPrice":{"description":"Optional highest accepted unit price, in the order or cart currency; a higher current unit price gives 409 / 11002.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]}},"additionalProperties":false,"description":"An airtime item's `inputs`: the inputs the offer's `requiredInputs` list, the standard purchase fields\n`value` and `maxPrice`, and the airtime `minDeliveredValue`. Checks that need the offer run in the\npurchase resolution."},"AirtimeMixedOrderRequestItem":{"required":["publicId","productType","inputs"],"type":"object","properties":{"publicId":{"type":"string","description":"Required. The offer's `publicId` from the product's search, item or quote response. An unknown,\nexpired or other-product value is rejected with code `11004` at `items[i]`."},"quantity":{"type":"integer","description":"Number of units, at least 1 (default 1). Each unit becomes its own order item; an order has at most five\nunits in total. A product may allow fewer.","format":"int32"},"productType":{"enum":["airtime"],"type":"string"},"inputs":{"$ref":"#/components/schemas/AirtimeInputs"}},"additionalProperties":false},"AirtimeMixedQuoteItem":{"required":["details","name","price","publicId","quantity","value","productType"],"type":"object","properties":{"productType":{"enum":["airtime"],"type":"string"},"publicId":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"name":{"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"details":{"allOf":[{"$ref":"#/components/schemas/AirtimeQuoteItemDetails"}],"description":"Airtime quote facts outside the quote item keys every partner service shares.\n`estimatedDeliveredValue` is what the selected route expects the recipient to receive, which a\nrange item with a `minDeliveredValue` may set below the ordered value."}},"additionalProperties":false},"AirtimeOffer":{"required":["details","name","price","publicId","requiredInputs","value"],"type":"object","properties":{"publicId":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"value":{"$ref":"#/components/schemas/OfferValue"},"price":{"$ref":"#/components/schemas/OfferPrice"},"requiredInputs":{"type":"array","items":{"$ref":"#/components/schemas/InputField"}},"details":{"allOf":[{"$ref":"#/components/schemas/AirtimeOfferDetails"}],"description":"Airtime offer facts outside the offer keys every partner service shares. `redemptionType` is null\nwhen the offer's route does not declare how the top-up is delivered; `readMore` is stored Markdown."}},"additionalProperties":false,"description":"One orderable offer of an operator: a fixed top-up or a range of them. `publicId` is the identifier\nquote and order take. `value` is what the subscriber receives; `price` is indicative and\nin the requested price currency."},"AirtimeOfferDetails":{"type":"object","properties":{"redemptionType":{"enum":["directTopUp","pin"],"type":["string","null"]},"readMore":{"type":["string","null"]}},"additionalProperties":false,"description":"Airtime offer facts outside the offer keys every partner service shares. `redemptionType` is null\nwhen the offer's route does not declare how the top-up is delivered; `readMore` is stored Markdown."},"AirtimeOperator":{"required":["countryCode","id","name","offers"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"countryCode":{"type":"string"},"category":{"type":["string","null"]},"logoUrl":{"type":["string","null"]},"description":{"type":["string","null"]},"offers":{"type":"array","items":{"$ref":"#/components/schemas/AirtimeOffer"}}},"additionalProperties":false,"description":"One operator with its offers, as search and `operators/{id}` return it. `id` is the stable\noperator id `operator_…`, which is never orderable; an order names one of its `offers` by public\nID. Airtime has no categories or operator descriptions, so `category` and `description`\nare always null. Prices are indicative; quote recalculates them."},"AirtimeOperatorList":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AirtimeOperatorSummary"}}},"additionalProperties":false,"description":"The complete operator list of one country for manual selection; it is small, so it is not paged."},"AirtimeOperatorSummary":{"required":["countryCode","id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"countryCode":{"type":"string"},"category":{"type":["string","null"]},"logoUrl":{"type":["string","null"]}},"additionalProperties":false,"description":"One operator as the operator list and the catalog return it, without offers. `id` is the stable\noperator id `operator_…` that `operators/{id}` takes. Airtime has no categories, so\n`category` is always null."},"AirtimeOrder":{"required":["createdAt","fulfillmentVersion","id","items","origin","refunded","status","timeline","total","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Order id.","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderOrigin"}],"description":"Where the order was created."},"status":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"Current order status: `paymentPending`, `processing`, `completed`,\n            `partiallyFulfilled`, `fulfillmentFailed`, `partiallyRefunded`, `refunded` or `cancelled`."},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What was charged for the order, in the order's currency, before refunds: the item prices plus\n            completed amendment charges, less completed amendment credits."},"refunded":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What completed item refunds returned, in the order's currency; zero when nothing was\n            returned. You paid `total` minus `refunded`, the sum of the items' `effectivePaidAmount`."},"payment":{"description":"The latest payment attempt; `null` when none was made.","anyOf":[{"$ref":"#/components/schemas/OrderPayment"},{"type":"null"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/AirtimeOrderItem"},"description":"The order items, one per unit bought."},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/OrderTimelineEntry"},"description":"Every status the order has had, oldest first, each once per stretch."},"createdAt":{"type":"string","description":"When the order was created (UTC).","format":"date-time"},"updatedAt":{"type":"string","description":"When anything in the order last changed (UTC): its status, an item's fulfillment, a refund\n            or an amendment.","format":"date-time"},"fulfillmentVersion":{"type":"integer","description":"Increases with every fulfillment change; matches the\n            `order.fulfillment.updated` webhook.","format":"int64"},"referenceId":{"type":["string","null"],"description":"Your own order reference, when one was sent."},"customer":{"description":"The traveller who paid on your hosted site, masked; `null` unless the origin is `site`, and\n            once the traveller's details are deleted at the end of their retention period.","anyOf":[{"$ref":"#/components/schemas/OrderCustomer"},{"type":"null"}]}},"additionalProperties":false,"description":"The current state of an order."},"AirtimeOrderItem":{"required":["actions","createdAt","effectivePaidAmount","fulfillment","id","orderId","price","productType","purchasedProduct"],"type":"object","properties":{"id":{"type":"string","description":"Order item id, used by the order-item endpoints. It is not the offer's `publicId`.","format":"uuid"},"orderId":{"type":"string","description":"The order the item belongs to.","format":"uuid"},"productType":{"enum":["airtime"],"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The price paid for the item at purchase, in the order's currency."},"purchasedProduct":{"$ref":"#/components/schemas/AirtimePurchasedProduct"},"fulfillment":{"$ref":"#/components/schemas/AirtimeFulfillment"},"actions":{"allOf":[{"$ref":"#/components/schemas/OrderItemActions"}],"description":"Whether the item can be amended or cancelled now."},"createdAt":{"type":"string","description":"When the item was created (UTC).","format":"date-time"},"effectivePaidAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What you have paid for the item, net of every amount returned: `price` plus\n            completed amendment charges, less completed amendment credits and less the completed `refund`."},"refund":{"description":"The recorded refund, or `null` when no refund has been started.","anyOf":[{"$ref":"#/components/schemas/OrderItemRefund"},{"type":"null"}]}},"additionalProperties":false},"AirtimeOrderRequest":{"required":["items"],"type":"object","properties":{"currency":{"type":["string","null"],"description":"Order currency, three letters in either case; the API key's currency when omitted. An unsupported code gives\n400 / 10001 at `currency`, reason `NOT_SUPPORTED`, before any item is checked."},"referenceId":{"type":["string","null"],"description":"Optional partner order reference, unique per partner, at most 128 characters without leading or trailing\nspaces. A quote validates it and ignores it."},"items":{"type":"array","items":{"$ref":"#/components/schemas/AirtimeOrderRequestItem"},"description":"1 to 5 items, each topping up one number once."}},"additionalProperties":false,"description":"The body B2B airtime quote and order both take."},"AirtimeOrderRequestItem":{"required":["inputs","publicId"],"type":"object","properties":{"publicId":{"type":"string","description":"Offer public ID from search or `operators/{id}`."},"quantity":{"type":"integer","description":"Always 1: an airtime item tops up one number once.","format":"int32"},"inputs":{"allOf":[{"$ref":"#/components/schemas/AirtimeInputs"}],"description":"The recipient's number, any operator settings the offer lists, and the purchase fields."}},"additionalProperties":false,"description":"One item of an airtime quote or order request: one top-up of one number. The value and the price guard are\nmembers of `inputs`."},"AirtimePurchasedDetails":{"type":"object","properties":{"redemptionType":{"enum":["directTopUp","pin"],"type":["string","null"]},"estimatedDeliveredValue":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"readMore":{"type":["string","null"]}},"additionalProperties":false,"description":"Airtime facts outside the purchased-product keys every partner service shares, as captured at purchase.\n`redemptionType` is null when the selected route did not declare how the top-up is delivered.\n`estimatedDeliveredValue` is what the selected route expected the recipient to receive, null when it\nwas not known. `readMore` is stored Markdown."},"AirtimePurchasedInputs":{"required":["phoneNumber"],"type":"object","properties":{"phoneNumber":{"type":"string"},"minDeliveredValue":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]}},"additionalProperties":false,"description":"The item's `inputs` under the request's keys. `phoneNumber` is masked; `minDeliveredValue`\nis returned as accepted, in the value's currency, and is null when the item took no minimum. Operator settings are\nnot echoed."},"AirtimePurchasedProduct":{"required":["countryCode","details","inputs","name"],"type":"object","properties":{"name":{"type":"string"},"countryCode":{"type":"string"},"logoUrl":{"type":["string","null"]},"value":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"inputs":{"allOf":[{"$ref":"#/components/schemas/AirtimePurchasedInputs"}],"description":"The item's `inputs` under the request's keys. `phoneNumber` is masked; `minDeliveredValue`\nis returned as accepted, in the value's currency, and is null when the item took no minimum. Operator settings are\nnot echoed."},"details":{"allOf":[{"$ref":"#/components/schemas/AirtimePurchasedDetails"}],"description":"Airtime facts outside the purchased-product keys every partner service shares, as captured at purchase.\n`redemptionType` is null when the selected route did not declare how the top-up is delivered.\n`estimatedDeliveredValue` is what the selected route expected the recipient to receive, null when it\nwas not known. `readMore` is stored Markdown."}},"additionalProperties":false,"description":"The purchased top-up as captured at purchase. `name` keeps the name given at purchase; only\n`logoUrl` comes from the current catalogue. `inputs` masks the phone number.\n`value` is null only for older orders that did not record the ordered top-up apart from the\nrecipient estimate."},"AirtimeQuote":{"required":["currency","items","total"],"type":"object","properties":{"currency":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AirtimeQuoteItem"}},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false,"description":"Current prices for the requested items, in request order. `total` is the sum of each item's unit price\ntimes its quantity. A quote reserves nothing and does not expire."},"AirtimeQuoteItem":{"required":["details","name","price","publicId","quantity","value"],"type":"object","properties":{"publicId":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"name":{"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"details":{"allOf":[{"$ref":"#/components/schemas/AirtimeQuoteItemDetails"}],"description":"Airtime quote facts outside the quote item keys every partner service shares.\n`estimatedDeliveredValue` is what the selected route expects the recipient to receive, which a\nrange item with a `minDeliveredValue` may set below the ordered value."}},"additionalProperties":false,"description":"One quoted top-up. `value` is the top-up value ordered, `price` the current unit price in\nthe quote currency, and `name` the name the order item's `purchasedProduct` gets: a fixed offer\nkeeps its search name, and a range offer is named at the quoted value with the operator's catalogue name, or keeps\nits stored label when the catalogue no longer has the operator."},"AirtimeQuoteItemDetails":{"required":["estimatedDeliveredValue"],"type":"object","properties":{"estimatedDeliveredValue":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false,"description":"Airtime quote facts outside the quote item keys every partner service shares.\n`estimatedDeliveredValue` is what the selected route expects the recipient to receive, which a\nrange item with a `minDeliveredValue` may set below the ordered value."},"AirtimeRedemption":{"required":["type"],"type":"object","properties":{"type":{"enum":["directTopUp","pin"],"type":"string"},"pin":{"type":["string","null"]},"instructions":{"type":["string","null"]}},"additionalProperties":false,"description":"`type` is `directTopUp` (automatic recharge) or `pin` (customer activation). A PIN top-up\ncarries the issued `pin` as a string and the customer `instructions`; either is null when\nit was not received, and both are null for a direct top-up."},"AirtimeSearchDetails":{"required":["phoneLookup"],"type":"object","properties":{"phoneLookup":{"allOf":[{"$ref":"#/components/schemas/CarrierDetection"}],"description":"Outcome of the search's carrier lookup. `carrierName` is the carrier the lookup reported, for\ndisplay only; it is present for any status when the lookup returned one and is never an operator ID.\n`countryCode` is the number's country as ISO 3166-1 alpha-2, derived from the number itself and never\nfrom the lookup; it is present for every status, so a partner can list that country's operators for the manual flow."}},"additionalProperties":false,"description":"Airtime search facts outside the root keys every partner service shares."},"AirtimeSearchResult":{"required":["details","items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AirtimeOperator"}},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of a list response."},"details":{"allOf":[{"$ref":"#/components/schemas/AirtimeSearchDetails"}],"description":"Airtime search facts outside the root keys every partner service shares."}},"additionalProperties":false,"description":"The detected flow: at most one item, the operator the phone lookup detected, with its offers. `items` is\nempty unless `details.phoneLookup.status` is `detected` and an offer is left after filtering; the\npartner then falls back to the operator list."},"Amendment":{"required":["amendmentMode","amountToPay","amountToRefund","createdAt","id","orderId","orderItemId","productType","status"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orderId":{"type":"string","format":"uuid"},"orderItemId":{"type":"string","format":"uuid"},"productType":{"enum":["esim","hotel","flight","carRental","train","lounge","ticket","tour","activity","cruise","remittance","vpn","transportation","insurance","billPayment","giftCard","loyaltyProgram","voip","airtime","utility"],"type":"string"},"amendmentMode":{"enum":["automatic","manual"],"type":"string"},"status":{"enum":["pending","completed","cancelled","failed","inProgress","quoted","partnerApproved","approvalInProgress"],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"amountToPay":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"amountToRefund":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false},"AmendmentConfirmRequest":{"required":["amendmentRequestId","paymentMethod"],"type":"object","properties":{"amendmentRequestId":{"type":"string","description":"Required. The `amendmentRequestId` returned by the amendment quote.","format":"uuid"},"paymentMethod":{"enum":["balance"],"type":"string","description":"How a surcharge is paid. Its only value is `balance`: the wallet linked to the API key.\n            Any other value answers 400 with code 10001 at `paymentMethod`."},"selectedOptionId":{"type":["string","null"],"description":"The `id` of the quote option to confirm. When omitted, the first option is used."},"maxPrice":{"description":"Optional. The most you accept to pay for this amendment, in the currency of the quoted amounts.\n            Above it the confirm answers 409 with code 11002 at `maxPrice` and nothing is charged. Without it the confirm\n            charges exactly the quoted amounts, and a price that changed since the quote needs a new quote.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]}},"additionalProperties":false,"description":"The quote and option to confirm."},"AmendmentConfirmResult":{"required":["amendmentId","amendmentRequestId","status"],"type":"object","properties":{"amendmentRequestId":{"type":"string","description":"The confirmed quote.","format":"uuid"},"amendmentId":{"type":"string","description":"The new amendment's id.","format":"uuid"},"status":{"enum":["pending","completed","cancelled","failed","inProgress","quoted","partnerApproved","approvalInProgress"],"type":"string","description":"Amendment status."},"payment":{"description":"The surcharge payment; `null` when nothing was charged.","anyOf":[{"$ref":"#/components/schemas/AmendmentPayment"},{"type":"null"}]},"refund":{"description":"The credit returned; `null` when nothing was refunded.","anyOf":[{"$ref":"#/components/schemas/AmendmentRefund"},{"type":"null"}]}},"additionalProperties":false,"description":"The confirmed amendment."},"AmendmentList":{"required":["items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Amendment"}},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of a list response."}},"additionalProperties":false},"AmendmentPayment":{"required":["amount","method","status"],"type":"object","properties":{"status":{"enum":["pending","completed","cancelled","failed","compensated","compensationPending","compensationFailed"],"type":"string","description":"Payment status."},"method":{"enum":["balance","card"],"type":"string","description":"How the surcharge was paid."},"amount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The amount charged."},"failure":{"description":"Why the payment failed; `null` unless it failed.","anyOf":[{"$ref":"#/components/schemas/PaymentFailure"},{"type":"null"}]}},"additionalProperties":false,"description":"The payment of an amendment surcharge."},"AmendmentQuote":{"required":["amendmentRequestId","expiresAt","options","processedAt"],"type":"object","properties":{"amendmentRequestId":{"type":"string","description":"The quote id to send when confirming.","format":"uuid"},"processedAt":{"type":"string","description":"When the quote was made (UTC).","format":"date-time"},"expiresAt":{"type":"string","description":"When the quote expires (UTC); confirm it before then.","format":"date-time"},"options":{"type":"array","items":{"$ref":"#/components/schemas/AmendmentQuoteOption"},"description":"The priced options; confirm one by its `id`."}},"additionalProperties":false,"description":"A priced amendment quote. Confirm it before `expiresAt`."},"AmendmentQuoteOption":{"required":["amountToPay","amountToRefund","id"],"type":"object","properties":{"id":{"type":"string","description":"Option id, sent as `selectedOptionId` when confirming."},"amountToPay":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The surcharge charged on confirm, including any amendment fee."},"amountToRefund":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The credit returned on confirm, after any amendment fee."},"amendmentFee":{"description":"A fee for the change, already included in amountToPay or amountToRefund; null when none\n            applies.","anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]}},"additionalProperties":false,"description":"One priced way to make the requested change."},"AmendmentQuoteRequest":{"type":"object","properties":{"attributes":{"description":"Required. A JSON object describing the change, in the shape the item's product defines for amendments."}},"additionalProperties":false,"description":"The change requested for a delivered order item."},"AmendmentRefund":{"required":["amount","method","status"],"type":"object","properties":{"status":{"enum":["pending","refunded","failed"],"type":"string","description":"Refund status: `pending`, `refunded` or `failed`, spelled as an item refund's status."},"method":{"enum":["balance","card"],"type":"string","description":"Where the credit is returned."},"amount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The amount returned."}},"additionalProperties":false,"description":"The credit of an amendment."},"Amenity":{"required":["code","label"],"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"}},"additionalProperties":false,"description":"One amenity available in the static amenity catalog."},"AmenityCatalog":{"required":["amenities","groups","mapVersion","notesLabel"],"type":"object","properties":{"mapVersion":{"type":"integer","description":"Version of the amenity catalog the labels and codes come from.","format":"int32"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/AmenityGroup"},"description":"Every amenity group, labelled, with the codes it holds."},"amenities":{"type":"array","items":{"$ref":"#/components/schemas/Amenity"},"description":"Every amenity code with its label, for rendering a card or a rail."},"notesLabel":{"type":"string","description":"Heading for a card's `amenityNotes`. Those strings are free text with no code, so\nunlike every other label on a card this one cannot be looked up from Amenities."}},"additionalProperties":false},"AmenityFacet":{"required":["code","count","label"],"type":"object","properties":{"code":{"type":"string","description":"The canonical code to send back in `filters.amenityCodes`."},"label":{"type":"string","description":"Display text in the request's language."},"count":{"type":"integer","description":"Candidate hotels carrying this code. Never zero — absent codes are omitted.","format":"int32"}},"additionalProperties":false,"description":"One row of the amenity filter rail."},"AmenityGroup":{"required":["codes","key","label"],"type":"object","properties":{"key":{"type":"string","description":"Stable group key, as listed by `hotels/amenities/catalog`."},"label":{"type":"string","description":"Display text in the request's language."},"codes":{"type":"array","items":{"type":"string"},"description":"Canonical amenity codes in this group that have positive candidate counts."}},"additionalProperties":false,"description":"One grouped section of the amenity filter rail."},"AvailableService":{"required":["id","passengerIndexes","price","segments","type"],"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"passengerIndexes":{"type":"array","items":{"type":"integer","format":"int32"},"description":"1-based positions in the offer's passenger list."},"segments":{"type":"array","items":{"$ref":"#/components/schemas/SegmentPosition"}},"maxQuantity":{"type":["integer","null"],"format":"int32"},"baggage":{"description":"Allowance of a bookable baggage service.","anyOf":[{"$ref":"#/components/schemas/BaggageLimits"},{"type":"null"}]}},"additionalProperties":false},"Baggage":{"required":["quantity","type"],"type":"object","properties":{"type":{"enum":["unknown","carryOn","checked","personalItem"],"type":"string"},"quantity":{"type":"integer","format":"int32"},"weightKg":{"type":["number","null"],"format":"decimal"},"description":{"type":["string","null"]}},"additionalProperties":false},"BaggageLimits":{"type":"object","properties":{"type":{"type":["string","null"]},"maximumWeightKg":{"type":["number","null"],"format":"decimal"},"maximumLengthCm":{"type":["number","null"],"format":"decimal"},"maximumHeightCm":{"type":["number","null"],"format":"decimal"},"maximumDepthCm":{"type":["number","null"],"format":"decimal"}},"additionalProperties":false,"description":"Allowance of a bookable baggage service."},"BalanceLowWebhook":{"required":["data","eventId","eventType","timestamp"],"type":"object","properties":{"eventId":{"type":"string","format":"uuid"},"eventType":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"data":{"allOf":[{"$ref":"#/components/schemas/BalanceLowWebhookData"}]},"isTest":{"type":"boolean","description":"True for a synthetic test delivery. Omitted on live events."}},"additionalProperties":false},"BalanceLowWebhookData":{"required":["balance","currency","lowBalanceThreshold","thresholdPercentage","walletId"],"type":"object","properties":{"walletId":{"type":"string","format":"uuid"},"balance":{"type":"number","format":"decimal"},"lowBalanceThreshold":{"type":"number","format":"decimal"},"thresholdPercentage":{"type":"integer","format":"int32"},"currency":{"type":"string"}},"additionalProperties":false},"Bed":{"required":["count","type"],"type":"object","properties":{"type":{"type":"string"},"count":{"type":"integer","format":"int32"}},"additionalProperties":false},"Biller":{"required":["category","countryCode","details","id","name","offers"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"countryCode":{"type":"string"},"category":{"enum":["other","electricity","water","television","internet","gas","toll","voip","landline"],"type":"string","description":"The kind of bill a biller collects."},"logoUrl":{"type":["string","null"]},"description":{"type":["string","null"]},"offers":{"type":"array","items":{"$ref":"#/components/schemas/UtilityOffer"}},"details":{"allOf":[{"$ref":"#/components/schemas/BillerDetails"}],"description":"Biller facts outside the item keys every partner service shares: `serviceType` is `prepaid` or\n`postpaid`, and `deliveryType` says what a paid bill delivers, a `token` (such as a prepaid\nmeter token or a PIN) or a `directCredit` to the biller."}},"additionalProperties":false,"description":"One biller as search, the one-biller route and the catalog return it. `id` is the biller's opaque\npublic token; an order names one of its `offers` by public ID. Prices are indicative; quote\nrecalculates them."},"BillerDetails":{"required":["deliveryType","serviceType"],"type":"object","properties":{"serviceType":{"enum":["prepaid","postpaid"],"type":"string"},"deliveryType":{"enum":["unknown","token","directCredit"],"type":"string"}},"additionalProperties":false,"description":"Biller facts outside the item keys every partner service shares: `serviceType` is `prepaid` or\n`postpaid`, and `deliveryType` says what a paid bill delivers, a `token` (such as a prepaid\nmeter token or a PIN) or a `directCredit` to the biller."},"BookedAirline":{"required":["iataCode"],"type":"object","properties":{"iataCode":{"type":"string"},"name":{"type":["string","null"]},"logoUrl":{"type":["string","null"]}},"additionalProperties":false},"BookedAirport":{"required":["iataCode"],"type":"object","properties":{"iataCode":{"type":"string","description":"The airport's IATA code, for example `LHR`."},"icaoCode":{"type":["string","null"],"description":"The airport's ICAO code; null when not stated."},"name":{"type":["string","null"],"description":"The airport's name; null when not stated."},"city":{"type":["string","null"],"description":"The city the airport serves; null when not stated."},"cityIataCode":{"type":["string","null"],"description":"The IATA code of that city; null when not stated."},"countryCode":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country of the airport; null when not stated."},"terminal":{"type":["string","null"],"description":"The terminal; null when not stated."},"timezone":{"type":["string","null"],"description":"The airport's IANA time zone, such as `Europe/London`: it turns the UTC times at this\n            airport into the airport's clock."}},"additionalProperties":false,"description":"An airport."},"BookedBaggage":{"required":["quantity","type"],"type":"object","properties":{"type":{"enum":["unknown","carryOn","checked","personalItem"],"type":"string"},"quantity":{"type":"integer","format":"int32"},"weightKg":{"type":["number","null"],"format":"decimal"},"description":{"type":["string","null"]}},"additionalProperties":false},"BookedHotel":{"required":["amenityGroups","imageUrls","name"],"type":"object","properties":{"name":{"type":"string","description":"The hotel's name, the first part of the purchased product's `name`."},"starRating":{"type":["number","null"],"description":"The hotel's star rating; null when unknown.","format":"decimal"},"address":{"description":"The hotel's address; null when unknown.","anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"coordinates":{"description":"The hotel's location; null when unknown.","anyOf":[{"$ref":"#/components/schemas/Coordinates"},{"type":"null"}]},"description":{"type":["string","null"],"description":"The hotel description stored at purchase, in HTML; null when there was none."},"imageUrls":{"type":"array","items":{"type":"string"},"description":"The gallery images stored at purchase."},"amenityGroups":{"type":"array","items":{"$ref":"#/components/schemas/HotelAmenityGroup"},"description":"The amenities stored at purchase, as codes in display groups; label them from `hotels/amenities/catalog`."},"contact":{"description":"The hotel's phone, email and website; null when unknown.","anyOf":[{"$ref":"#/components/schemas/HotelContact"},{"type":"null"}]}},"additionalProperties":false,"description":"The hotel of the stay, as the offer described it."},"BookedSegment":{"required":["arrivalAt","baggage","departureAt","destination","durationMinutes","isCodeshare","marketingCarrier","marketingFlightNumber","origin","stops"],"type":"object","properties":{"origin":{"allOf":[{"$ref":"#/components/schemas/BookedAirport"}],"description":"The airport the flight departs from."},"destination":{"allOf":[{"$ref":"#/components/schemas/BookedAirport"}],"description":"The airport the flight lands at."},"departureAt":{"type":"string","description":"When the flight departs, a UTC instant; `origin.timezone` gives the airport's clock.","format":"date-time"},"departureLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the departure airport (`origin.timezone`) at `departureAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `departureAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"arrivalAt":{"type":"string","description":"When the flight lands, a UTC instant; `destination.timezone` gives the airport's clock.","format":"date-time"},"arrivalLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the arrival airport (`destination.timezone`) at `arrivalAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `arrivalAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"durationMinutes":{"type":"integer","description":"Flying time of the flight.","format":"int32"},"marketingCarrier":{"allOf":[{"$ref":"#/components/schemas/BookedAirline"}],"description":"The airline that sells the flight under its code."},"marketingFlightNumber":{"type":"string","description":"The flight number under the selling airline's code."},"operatingCarrier":{"description":"The airline that flies the aircraft; null when not stated.","anyOf":[{"$ref":"#/components/schemas/BookedAirline"},{"type":"null"}]},"operatingFlightNumber":{"type":["string","null"],"description":"The flight number under the operating airline's code; null when not stated."},"aircraft":{"description":"The aircraft; null when not stated.","anyOf":[{"$ref":"#/components/schemas/Aircraft"},{"type":"null"}]},"cabinClass":{"enum":["economy","premiumEconomy","business","first"],"type":["string","null"],"description":"The cabin booked on the flight; null when not stated."},"stops":{"type":"array","items":{"$ref":"#/components/schemas/BookedStop"},"description":"Stops within the flight, where the aircraft lands and leaves again without a change of flight."},"baggage":{"type":"array","items":{"$ref":"#/components/schemas/BookedBaggage"},"description":"Baggage included on the flight."},"isCodeshare":{"type":"boolean","description":"Whether the selling and the operating airline differ."}},"additionalProperties":false,"description":"One flight of a slice."},"BookedSlice":{"required":["arrivalAt","departureAt","destination","durationMinutes","origin","segments","stops"],"type":"object","properties":{"origin":{"allOf":[{"$ref":"#/components/schemas/BookedAirport"}],"description":"The airport the slice departs from."},"destination":{"allOf":[{"$ref":"#/components/schemas/BookedAirport"}],"description":"The airport the slice lands at."},"departureAt":{"type":"string","description":"When the slice departs, a UTC instant; `origin.timezone` gives the airport's clock.","format":"date-time"},"departureLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the departure airport (`origin.timezone`) at `departureAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `departureAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"arrivalAt":{"type":"string","description":"When the slice lands, a UTC instant; `destination.timezone` gives the airport's clock.","format":"date-time"},"arrivalLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the arrival airport (`destination.timezone`) at `arrivalAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `arrivalAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"durationMinutes":{"type":"integer","description":"Flying and connection time of the slice.","format":"int32"},"stops":{"type":"integer","description":"Connections within the slice.","format":"int32"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/BookedSegment"},"description":"The flights of the slice, in order."}},"additionalProperties":false,"description":"One slice of the trip, such as the outbound or the return."},"BookedStop":{"required":["airport","arrivingAt","departingAt","durationMinutes"],"type":"object","properties":{"airport":{"allOf":[{"$ref":"#/components/schemas/BookedAirport"}],"description":"The airport of the stop."},"arrivingAt":{"type":"string","description":"When the aircraft lands at the stop, a UTC instant; `airport.timezone` gives the airport's clock.","format":"date-time"},"arrivingLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the stop's airport (`airport.timezone`) at `arrivingAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `arrivingAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"departingAt":{"type":"string","description":"When the aircraft leaves the stop, a UTC instant.","format":"date-time"},"departingLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the stop's airport (`airport.timezone`) at `departingAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `departingAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"durationMinutes":{"type":"integer","description":"How long the aircraft stays at the stop.","format":"int32"}},"additionalProperties":false,"description":"A stop within a flight, where the aircraft lands and leaves again."},"BookingTerms":{"required":["cancellation","changes","payment"],"type":"object","properties":{"payment":{"allOf":[{"$ref":"#/components/schemas/PaymentTerms"}],"description":"What the partner's wallet is charged at order, and what the guest pays later."},"cancellation":{"allOf":[{"$ref":"#/components/schemas/CancellationTerms"}],"description":"What cancelling gives back, and from when."},"changes":{"allOf":[{"$ref":"#/components/schemas/ChangeTerms"}],"description":"Whether the booking can be changed, and OpenRoam's fee for a change."}},"additionalProperties":false,"description":"How a booked product is paid, what cancelling it gives back and whether it can be changed, in the same shape on\nthe offer, the quote item and the purchased product, for a hotel stay and a flight alike. Every amount is in the\npartner's currency and in what the partner pays; OpenRoam's own fees are already included. The cancellation states\neach instant on the clock of the place the booking is bound to as well."},"CancellationPenalty":{"required":["from","penaltyAmount"],"type":"object","properties":{"from":{"type":"string","description":"When the band starts applying (UTC).","format":"date-time"},"fromLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the booked place (`timezone`) at `from`; null for a band that applies whatever the date. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `from`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"timezone":{"type":["string","null"],"description":"The IANA time zone of the booked place, such as `Europe/Paris`; null when its location does not tell it."},"penaltyAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What cancelling in this band costs, in the order currency."}},"additionalProperties":false,"description":"The cancellation band in effect: cancelling on or after `from` costs `penaltyAmount`."},"CancellationStep":{"required":["from","penalty","refund"],"type":"object","properties":{"from":{"type":"string","description":"The instant (UTC) the step starts; it runs until the next step's.","format":"date-time"},"fromLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock of the cancellation's `timezone` at `from`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `from`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"refund":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What comes back when cancelling in this step."},"penalty":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What is kept when cancelling in this step; it and the refund add up to the price."}},"additionalProperties":false},"CancellationTerms":{"required":["schedule","type"],"type":"object","properties":{"type":{"enum":["fullyRefundable","partiallyRefundable","nonRefundable"],"type":"string","description":"`fullyRefundable` (a full refund until FreeUntil), `partiallyRefundable` or\n`nonRefundable` (nothing comes back)."},"freeUntil":{"type":["string","null"],"description":"Cancel at or before this instant (UTC) for a full refund; null unless the type is\n            `fullyRefundable`.","format":"date-time"},"freeUntilLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock of `timezone` at `freeUntil`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `freeUntil`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"timezone":{"type":["string","null"],"description":"The IANA time zone of the place the booking is bound to, such as `Europe/Paris`: the hotel's for a stay, the\nfirst departure airport's for a flight. Each `*LocalTime` member is the clock in it. Null when the place does\nnot tell it."},"schedule":{"type":"array","items":{"$ref":"#/components/schemas/CancellationStep"},"description":"Ordered steps: each is what cancelling from its `from` gives back and keeps. Before the first step, cancelling\nkeeps only Fee (nothing when it is null). Empty for a product that is not refundable."},"fee":{"description":"OpenRoam's own cancellation fee, already included in every step; null when there is none.","anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]}},"additionalProperties":false},"CarrierDetection":{"required":["countryCode","status"],"type":"object","properties":{"status":{"enum":["detected","notDetected","conflict","notInCatalog"],"type":"string"},"carrierName":{"type":["string","null"]},"countryCode":{"type":"string"}},"additionalProperties":false,"description":"Outcome of the search's carrier lookup. `carrierName` is the carrier the lookup reported, for\ndisplay only; it is present for any status when the lookup returned one and is never an operator ID.\n`countryCode` is the number's country as ISO 3166-1 alpha-2, derived from the number itself and never\nfrom the lookup; it is present for every status, so a partner can list that country's operators for the manual flow."},"CatalogHotel":{"required":["details","id","name"],"type":"object","properties":{"id":{"type":"string","description":"The hotel's stable catalog ID (`hotel_…`)."},"name":{"type":"string","description":"The hotel's name."},"countryCode":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 code of the hotel's country; null when it is not known."},"category":{"type":["string","null"],"description":"Always null: the property type is not available yet."},"logoUrl":{"type":["string","null"],"description":"The hotel's main image, hosted by OpenRoam; null when there is none."},"description":{"type":["string","null"],"description":"The stored hotel description, in HTML."},"details":{"allOf":[{"$ref":"#/components/schemas/HotelDetails"}],"description":"Hotel facts outside the item keys every partner service shares."}},"additionalProperties":false,"description":"One catalog hotel's content, as `properties/{id}` and the catalog files return it: the search item\n(Hotel) without `offers`, because a hotel has no price without a stay. Search its\n`id` in `searchCriteria.hotelIds` for its rates."},"ChangeFee":{"required":["type"],"type":"object","properties":{"type":{"enum":["fixed","percent"],"type":"string","description":"`fixed` or `percent`."},"amount":{"description":"The fee, for `fixed`; null for `percent`.","anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"percent":{"type":["number","null"],"description":"The percent of what the change costs, for `percent`; null for `fixed`.","format":"decimal"},"min":{"description":"The least a `percent` fee charges; null when unset.","anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"max":{"description":"The most a `percent` fee charges; null when unset.","anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]}},"additionalProperties":false},"ChangeTerms":{"required":["allowed"],"type":"object","properties":{"allowed":{"type":"boolean","description":"Whether the booking can be changed after purchase."},"fee":{"description":"OpenRoam's fee for a change, added to what the change costs; null when there is none.","anyOf":[{"$ref":"#/components/schemas/ChangeFee"},{"type":"null"}]}},"additionalProperties":false},"Coordinates":{"required":["latitude","longitude"],"type":"object","properties":{"latitude":{"type":"number","description":"Latitude, -90 to 90.","format":"double"},"longitude":{"type":"number","description":"Longitude, -180 to 180.","format":"double"}},"additionalProperties":false,"description":"A point on the map in decimal degrees."},"CoordinatesInput":{"required":["latitude","longitude"],"type":"object","properties":{"latitude":{"type":"number","description":"Latitude, -90 to 90.","format":"double"},"longitude":{"type":"number","description":"Longitude, -180 to 180.","format":"double"}},"additionalProperties":false,"description":"A point on the map in decimal degrees."},"Country":{"required":["countryCode","name"],"type":"object","properties":{"countryCode":{"type":"string"},"numericCode":{"type":["string","null"]},"name":{"type":"string"},"dialCode":{"type":["string","null"]},"flagUrl":{"type":["string","null"]}},"additionalProperties":false,"description":"One country or territory. `countryCode` is the ISO 3166-1 alpha-2 code every service filters and\nreports by; the ISO-reserved codes for places (such as AC, IC) and XK for Kosovo have no `numericCode`.\n`dialCode` is the international calling code with its leading plus (for example \"+994\"); it is null\nfor the few territories without one. Parse national input using the country's numbering rules before formatting\nit as E.164, including removal of a national trunk prefix when required. Several countries can share a\ncalling code, such as \"+1\". `flagUrl` is an SVG image, null where no flag is published."},"CountryList":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}},"additionalProperties":false,"description":"The complete country reference list, ordered by country code. The list is small and fixed, so it is not paged."},"Currency":{"required":["code","dailyPercentageDifference","id","rateDate","rateToUsd"],"type":"object","properties":{"id":{"type":"string","description":"Currency id, used as `currencyId` when creating a wallet.","format":"uuid"},"code":{"type":"string","description":"Three-letter currency code, for example `USD`."},"rateToUsd":{"type":"number","description":"The USD value of one unit of the currency.","format":"decimal"},"rateDate":{"type":"string","description":"When the rate was last updated (UTC).","format":"date-time"},"dailyPercentageDifference":{"type":"number","description":"Percentage change of the rate against the previous day.","format":"decimal"}},"additionalProperties":false,"description":"A supported currency with its current rate."},"CurrencyList":{"required":["currencies"],"type":"object","properties":{"currencies":{"type":"array","items":{"$ref":"#/components/schemas/Currency"},"description":"The currencies."}},"additionalProperties":false,"description":"Every supported currency."},"DateAmendmentCapabilities":{"required":["change"],"type":"object","properties":{"change":{"type":"boolean"}},"additionalProperties":false,"description":"Whether the check-in and check-out dates may move."},"ErrorDetail":{"required":["path","reason"],"type":"object","properties":{"path":{"type":"string","description":"Where the error is: the path of a body field, such as items[0].inputs.maxPrice, or the name of a query or route parameter. A JSON body that does not deserialize gives its path rooted at $, such as $.items[0].value. Cart checkout names the failing cart line by its id: items[<cart item id>]. A refused wallet charge (402) names wallet."},"reason":{"type":"string"},"message":{"type":["string","null"]}},"additionalProperties":false,"description":"One problem with a request field: its `path`, a machine `reason` such as `REQUIRED` or\n`INVALID_VALUE`, and, when there is one, a safe human-readable `message`."},"ErrorResponse":{"required":["code","message","name","requestId"],"type":"object","properties":{"code":{"type":"integer","description":"Numeric error code, for example `10001`. It is not the HTTP status.","format":"int32"},"name":{"type":"string","description":"Machine name of the code, for example `INVALID_REQUEST`. Not localized."},"message":{"type":"string","description":"Safe human-readable message. It may be localized."},"requestId":{"type":"string","description":"Identifier of the request, for support. It is not an order id or an idempotency\n            key."},"details":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"Per-field problems, when there are any; omitted otherwise."}},"additionalProperties":false,"description":"The body of every error response. Branch on `code` (or `name`), not on `message`, and keep\n`requestId` for support. An unknown `code` is handled as a general error for its HTTP status."},"EsimAddon":{"required":["packageName"],"type":"object","properties":{"packageName":{"type":"string","description":"Display name of the top-up plan."},"usage":{"description":"The top-up's usage last read, or null.","anyOf":[{"$ref":"#/components/schemas/EsimUsage"},{"type":"null"}]}},"additionalProperties":false,"description":"A top-up applied to the eSIM, with the usage last read for it."},"EsimApn":{"type":"object","properties":{"apn":{"type":["string","null"]},"apnUsername":{"type":["string","null"]},"apnPassword":{"type":["string","null"]}},"additionalProperties":false},"EsimCatalogPage":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EsimDestination"}},"nextCursor":{"type":["string","null"]}},"additionalProperties":false,"description":"A page of the partner catalog walk, in a fixed order. Continue with `nextCursor`, the same filters and\nthe same currency until it is null."},"EsimCompatibleDevice":{"required":["brand","model"],"type":"object","properties":{"brand":{"type":"string"},"model":{"type":"string"},"os":{"type":["string","null"]},"deviceType":{"type":["string","null"]},"name":{"type":["string","null"]},"notes":{"type":["string","null"]}},"additionalProperties":false},"EsimCoverageCountry":{"required":["carriers","countryCode","name","networks"],"type":"object","properties":{"countryCode":{"type":"string"},"name":{"type":"string"},"networks":{"type":"array","items":{"type":"string"}},"carriers":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"description":"A country a destination's plans work in; `countryCode` is what the `countryCode` filter matches."},"EsimCurrentUsage":{"required":["esimStatus","iccid","isDataUnlimited","isSmsUnlimited","isVoiceUnlimited","profileStatus"],"type":"object","properties":{"iccid":{"type":"string","description":"The eSIM's ICCID."},"esimStatus":{"enum":["new","procuring","pending","failed","ready","cancelled","revoked","expired","unknown"],"type":"string","description":"The eSIM's lifecycle status, as the order item's `esimStatus`."},"profileStatus":{"enum":["empty","new","downloaded","installed","activated","inactive","deleted","revoked","expired","unknown"],"type":"string","description":"The installed profile's status, as the order item's `profileStatus`."},"start":{"type":["string","null"],"description":"When the plan started, in UTC; null until it is activated.","format":"date-time"},"end":{"type":["string","null"],"description":"When the plan ends, in UTC, as last reported; null while no end is reported.","format":"date-time"},"allowedData":{"type":["integer","null"],"description":"Total data in MB; null when unlimited or not reported.","format":"int64"},"remainingData":{"type":["integer","null"],"description":"Remaining data in MB; null when unlimited or not reported.","format":"int64"},"isDataUnlimited":{"type":"boolean","description":"Whether the data is unlimited."},"allowedSms":{"type":["integer","null"],"description":"Total SMS, in messages; null when unlimited, not reported or not included.","format":"int64"},"remainingSms":{"type":["integer","null"],"description":"Remaining SMS, in messages; null when unlimited, not reported or not included.","format":"int64"},"isSmsUnlimited":{"type":"boolean","description":"Whether SMS are unlimited."},"allowedVoice":{"type":["integer","null"],"description":"Total voice, in minutes; null when unlimited, not reported or not included.","format":"int64"},"remainingVoice":{"type":["integer","null"],"description":"Remaining voice, in whole minutes; null when unlimited, not reported or not included.","format":"int64"},"isVoiceUnlimited":{"type":"boolean","description":"Whether voice is unlimited."}},"additionalProperties":false,"description":"An eSIM's statuses and its current allowances and remaining amounts, plan and top-ups together: data in MB\n(1 MB = 1024 KB), SMS in messages, voice in minutes. An amount is null when it is unlimited (its\n`is...Unlimited` flag is then true), not reported or not included."},"EsimDailyUsage":{"required":["esimStatus","iccid","isDataUnlimited","isSmsUnlimited","isVoiceUnlimited","profileStatus","usages"],"type":"object","properties":{"iccid":{"type":"string","description":"The eSIM's ICCID."},"esimStatus":{"enum":["new","procuring","pending","failed","ready","cancelled","revoked","expired","unknown"],"type":"string","description":"The eSIM's lifecycle status, as the order item's `esimStatus`."},"profileStatus":{"enum":["empty","new","downloaded","installed","activated","inactive","deleted","revoked","expired","unknown"],"type":"string","description":"The installed profile's status, as the order item's `profileStatus`."},"start":{"type":["string","null"],"description":"When the plan started, in UTC; null until it is activated.","format":"date-time"},"end":{"type":["string","null"],"description":"When the plan ends, in UTC, as last reported; null while no end is reported.","format":"date-time"},"allowedData":{"type":["integer","null"],"description":"Total data in MB; null when unlimited or not reported.","format":"int64"},"remainingData":{"type":["integer","null"],"description":"Remaining data in MB; null when unlimited or not reported.","format":"int64"},"isDataUnlimited":{"type":"boolean","description":"Whether the data is unlimited."},"allowedSms":{"type":["integer","null"],"description":"Total SMS, in messages; null when unlimited, not reported or not included.","format":"int64"},"remainingSms":{"type":["integer","null"],"description":"Remaining SMS, in messages; null when unlimited, not reported or not included.","format":"int64"},"isSmsUnlimited":{"type":"boolean","description":"Whether SMS are unlimited."},"allowedVoice":{"type":["integer","null"],"description":"Total voice, in minutes; null when unlimited, not reported or not included.","format":"int64"},"remainingVoice":{"type":["integer","null"],"description":"Remaining voice, in whole minutes; null when unlimited, not reported or not included.","format":"int64"},"isVoiceUnlimited":{"type":"boolean","description":"Whether voice is unlimited."},"usages":{"type":"array","items":{"$ref":"#/components/schemas/EsimDailyUsageEntry"},"description":"Per-day usage, empty when the plan does not report a per-day breakdown."}},"additionalProperties":false,"description":"An eSIM's current usage, as `usage` returns it, with a per-day breakdown."},"EsimDailyUsageEntry":{"required":["date","end","start","usage"],"type":"object","properties":{"date":{"type":"string","description":"The day the usage was counted for, in `yyyy-MM-dd` format. It is a calendar day in the time\n            zone the usage is counted in, which is not always UTC; `start` and `end` give its exact bounds.","format":"date"},"start":{"type":"string","description":"When the day began, as a UTC instant (inclusive).","format":"date-time"},"end":{"type":"string","description":"When the day ended, as a UTC instant (exclusive).","format":"date-time"},"usage":{"type":"number","description":"The data used that day, in MB.","format":"decimal"},"location":{"type":["string","null"],"description":"The country where the data was used; null when it is not reported."}},"additionalProperties":false,"description":"The data an eSIM used on one day."},"EsimDataAllowance":{"required":["isUnlimited","label","unit"],"type":"object","properties":{"amount":{"type":["integer","null"],"description":"The data in MB; null when the data is unlimited or the plan does not state it.","format":"int64"},"unit":{"type":"string","description":"Always `MB`."},"isUnlimited":{"type":"boolean","description":"Whether the data is unlimited; `amount` is then null."},"label":{"type":"string","description":"The allowance as the plan displays it, for example `3 GB`."}},"additionalProperties":false,"description":"A plan's data allowance. Data is always counted in MB (1 MB = 1024 KB)."},"EsimDestination":{"required":["category","details","id","name","offers"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"countryCode":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 code of a local destination; null for regional and global ones."},"category":{"enum":["local","regional","global"],"type":"string"},"logoUrl":{"type":["string","null"]},"description":{"type":["string","null"]},"offers":{"type":"array","items":{"$ref":"#/components/schemas/EsimOffer"}},"details":{"allOf":[{"$ref":"#/components/schemas/EsimDestinationDetails"}],"description":"Destination facts outside the item keys every partner service shares."}},"additionalProperties":false,"description":"One destination as search, the one-destination route and the catalog return it. `id` is the\ndestination's opaque ID; an order names one of its `offers` by public ID. Prices are indicative;\nquote recalculates them."},"EsimDestinationDetails":{"required":["coverage"],"type":"object","properties":{"destinationCode":{"type":["string","null"],"description":"The destination's stored eSIM code, such as `JP`, `EU`, `NAM` or `GLOBAL`; null when none is\nstored. It names the destination, not a country: the item's `countryCode` is the ISO code of a local\ndestination only. An order item's `purchasedProduct.details.destination.code` carries the same code."},"region":{"type":["string","null"]},"coverage":{"type":"array","items":{"$ref":"#/components/schemas/EsimCoverageCountry"},"description":"The countries the destination's plans work in, with their networks and carriers."}},"additionalProperties":false,"description":"Destination facts outside the item keys every partner service shares."},"EsimDestinationList":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EsimDestinationSummary"}}},"additionalProperties":false,"description":"Every destination with an orderable offer, ordered by name. The list is small, so it is not paged."},"EsimDestinationSummary":{"required":["category","id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"countryCode":{"type":["string","null"]},"category":{"enum":["local","regional","global"],"type":"string"},"logoUrl":{"type":["string","null"]}},"additionalProperties":false,"description":"A destination in the browse list; `destinations/{id}` returns it with its offers."},"EsimFeatures":{"required":["activation","charge","technology","withDataRoaming","withDestinationInstall","withHotspot","withKyc","withSubscription","withTopUp","withUsageCheck"],"type":"object","properties":{"withKyc":{"type":"boolean"},"withTopUp":{"type":"boolean"},"withHotspot":{"type":"boolean"},"withDataRoaming":{"type":"boolean"},"withSubscription":{"type":"boolean"},"withDestinationInstall":{"type":"boolean"},"withUsageCheck":{"type":"boolean"},"technology":{"type":"string"},"activation":{"type":"string"},"charge":{"type":"string"}},"additionalProperties":false},"EsimFulfillment":{"required":["status"],"type":"object","properties":{"status":{"enum":["pending","fulfilled","rejected"],"type":"string","description":"`pending`, `fulfilled` or `rejected`."},"result":{"oneOf":[{"$ref":"#/components/schemas/EsimFulfillmentResult"},{"enum":[null],"type":["string","null"]}]},"failure":{"description":"Why delivery was rejected (`11001`, `FULFILLMENT_REJECTED`); set only when\n            `rejected`.","anyOf":[{"$ref":"#/components/schemas/FulfillmentFailure"},{"type":"null"}]},"progress":{"anyOf":[{"$ref":"#/components/schemas/FulfillmentProgress"},{"type":"null"}]}},"additionalProperties":false},"EsimFulfillmentDetails":{"required":["addons","canProvision","esimStatus","mode","notes","profileStatus","provisioning"],"type":"object","properties":{"iccid":{"type":["string","null"],"description":"The eSIM's ICCID, which the post-purchase routes take; null until the eSIM is provisioned."},"mode":{"enum":["deferred","instant","topUp"],"type":"string","description":"How the item was fulfilled: a new instant or deferred eSIM, or a top-up."},"provisioning":{"allOf":[{"$ref":"#/components/schemas/EsimProvisioning"}],"description":"Progress of provisioning the eSIM."},"canProvision":{"type":"boolean","description":"True while a deferred eSIM waits for `POST /esims/{id}/provisioning`."},"esimStatus":{"enum":["new","procuring","pending","failed","ready","cancelled","revoked","expired","unknown"],"type":"string","description":"The eSIM's lifecycle status. An eSIM under review reads as pending."},"profileStatus":{"enum":["empty","new","downloaded","installed","activated","inactive","deleted","revoked","expired","unknown"],"type":"string","description":"The installed profile's status, as last recorded."},"installation":{"description":"Null until the eSIM is provisioned.","anyOf":[{"$ref":"#/components/schemas/EsimInstallation"},{"type":"null"}]},"pin":{"type":["string","null"]},"puk":{"type":["string","null"]},"phoneNumber":{"type":["string","null"],"description":"The number assigned to the eSIM, when the plan includes one."},"data":{"description":"The plan's data allowance, as the offer shows it.","anyOf":[{"$ref":"#/components/schemas/EsimDataAllowance"},{"type":"null"}]},"voice":{"description":"The plan's calling allowance; null when the plan includes no calls.","anyOf":[{"$ref":"#/components/schemas/EsimVoiceAllowance"},{"type":"null"}]},"sms":{"description":"The plan's SMS allowance; null when the plan includes no SMS.","anyOf":[{"$ref":"#/components/schemas/EsimSmsAllowance"},{"type":"null"}]},"apn":{"anyOf":[{"$ref":"#/components/schemas/EsimApn"},{"type":"null"}]},"addons":{"type":"array","items":{"$ref":"#/components/schemas/EsimAddon"},"description":"The top-ups applied to the eSIM."},"notes":{"type":"array","items":{"type":"string"},"description":"Stored notes about the plan, shown verbatim."},"fulfilledAt":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false,"description":"The eSIM an order item delivered: its ICCID and states, how to install it, and its plan. A top-up item reads the\neSIM it topped up, with `mode` `topUp`."},"EsimFulfillmentResult":{"required":["details"],"type":"object","properties":{"details":{"allOf":[{"$ref":"#/components/schemas/EsimFulfillmentDetails"}],"description":"The eSIM an order item delivered: its ICCID and states, how to install it, and its plan. A top-up item reads the\neSIM it topped up, with `mode` `topUp`."}},"additionalProperties":false,"description":"What a fulfilled eSIM order item delivered. An eSIM has no monetary value, so there is no `deliveredValue`;\neverything sits under `details`. Order reads and the `order.fulfillment.updated` webhook carry\nthe same result."},"EsimFulfillmentUpdate":{"required":["fulfillment","id","productType"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productType":{"enum":["esim"],"type":"string"},"fulfillment":{"$ref":"#/components/schemas/EsimFulfillment"}},"additionalProperties":false},"EsimInputs":{"type":"object","properties":{"isInstant":{"type":["boolean","null"],"description":"True when omitted: the eSIM is created when the order is fulfilled. False delivers an entitlement, and the eSIM\nis created later through provisioning. A top-up is always instant, so false is not allowed with an ICCID."},"eid":{"type":["string","null"],"description":"The EID of the device, when the offer requires it."},"imei2":{"type":["string","null"],"description":"The second IMEI of the device, when the offer requires it."},"travelStartDate":{"type":["string","null"],"description":"The first day of travel, when the offer requires it. A deferred eSIM may send it at provisioning\ninstead.","format":"date"},"iccid":{"type":["string","null"],"description":"The ICCID (18 to 22 digits) of your eSIM that a top-up offer from `search?iccid=` tops up. It alone makes the\nitem a top-up: a top-up offer has the publicId of the plan's purchase offer, so without it the item is a new eSIM."},"maxPrice":{"description":"Optional highest accepted unit price, in the order or cart currency; a higher current unit price gives 409 / 11002.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]}},"additionalProperties":false,"description":"An eSIM item's `inputs`: those the offer's `requiredInputs` list, and the optional `maxPrice` price\nguard. An eSIM has no monetary value, so the inputs have no `value`. A top-up is an offer from\n`search?iccid=` ordered with `iccid`."},"EsimInstallation":{"type":"object","properties":{"lpaCode":{"type":["string","null"]},"smdpAddress":{"type":["string","null"]},"activationCode":{"type":["string","null"]},"qrCodeUrl":{"type":["string","null"]},"iosQuickInstall":{"type":["string","null"]},"androidQuickInstall":{"type":["string","null"]}},"additionalProperties":false,"description":"How to install the eSIM. `lpaCode` is the activation string `LPA:1$smdpAddress$activationCode`,\nand the quick-install links open it on iOS and Android. An eSIM delivered only as a QR code image fills\n`qrCodeUrl` instead."},"EsimLocationEvent":{"required":["iccid","location","mcc","network","occurredAt"],"type":"object","properties":{"iccid":{"type":"string","description":"The eSIM's ICCID."},"mcc":{"type":"integer","description":"Mobile country code of the network.","format":"int32"},"mnc":{"type":["integer","null"],"description":"Mobile network code of the network, or null when not reported.","format":"int32"},"location":{"type":"string","description":"Where the eSIM registered, as reported."},"network":{"type":"string","description":"The network's name, as reported."},"occurredAt":{"type":"string","description":"When the eSIM registered, in UTC.","format":"date-time"}},"additionalProperties":false,"description":"One network registration of an eSIM."},"EsimLocationEventList":{"required":["items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EsimLocationEvent"}},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of a list response."}},"additionalProperties":false,"description":"A page of the networks an eSIM registered on, newest first."},"EsimMixedOrderRequestItem":{"required":["publicId","productType"],"type":"object","properties":{"publicId":{"type":"string","description":"Required. The offer's `publicId` from the product's search, item or quote response. An unknown,\nexpired or other-product value is rejected with code `11004` at `items[i]`."},"quantity":{"type":"integer","description":"Number of units, at least 1 (default 1). Each unit becomes its own order item; an order has at most five\nunits in total. A product may allow fewer.","format":"int32"},"productType":{"enum":["esim"],"type":"string"},"inputs":{"$ref":"#/components/schemas/EsimInputs"}},"additionalProperties":false},"EsimMixedQuoteItem":{"required":["name","price","publicId","quantity","productType"],"type":"object","properties":{"productType":{"enum":["esim"],"type":"string"},"publicId":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"name":{"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false},"EsimOffer":{"required":["details","name","price","publicId","requiredInputs"],"type":"object","properties":{"publicId":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"price":{"$ref":"#/components/schemas/OfferPrice"},"requiredInputs":{"type":"array","items":{"$ref":"#/components/schemas/InputField"}},"details":{"allOf":[{"$ref":"#/components/schemas/EsimOfferDetails"}],"description":"eSIM plan facts outside the offer keys every partner service shares."}},"additionalProperties":false,"description":"One orderable eSIM plan of a destination. `publicId` is the identifier quote and order take. An eSIM\nhas no monetary value, so the offer has no `value`; `price` is one indicative amount in the\nrequested price currency."},"EsimOfferDetails":{"required":["apn","data","notes","properties","restrictions","validityDays"],"type":"object","properties":{"validityDays":{"type":"integer","description":"How many days the plan is valid, counted from activation.","format":"int32"},"data":{"allOf":[{"$ref":"#/components/schemas/EsimDataAllowance"}],"description":"The plan's data allowance; `data.isUnlimited` says whether the data is unlimited."},"voice":{"description":"The plan's calling allowance; null when the plan includes no calls.","anyOf":[{"$ref":"#/components/schemas/EsimVoiceAllowance"},{"type":"null"}]},"sms":{"description":"The plan's SMS allowance; null when the plan includes no SMS.","anyOf":[{"$ref":"#/components/schemas/EsimSmsAllowance"},{"type":"null"}]},"apn":{"allOf":[{"$ref":"#/components/schemas/EsimApn"}]},"properties":{"allOf":[{"$ref":"#/components/schemas/EsimFeatures"}]},"restrictions":{"allOf":[{"$ref":"#/components/schemas/EsimRestrictions"}],"description":"A plan's throttling and expiry. Every throttle field is null when the plan does not throttle."},"notes":{"type":"array","items":{"type":"string"},"description":"Stored notes about the plan, shown verbatim."},"plan":{"type":["string","null"]}},"additionalProperties":false,"description":"eSIM plan facts outside the offer keys every partner service shares."},"EsimOrder":{"required":["createdAt","fulfillmentVersion","id","items","origin","refunded","status","timeline","total","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Order id.","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderOrigin"}],"description":"Where the order was created."},"status":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"Current order status: `paymentPending`, `processing`, `completed`,\n            `partiallyFulfilled`, `fulfillmentFailed`, `partiallyRefunded`, `refunded` or `cancelled`."},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What was charged for the order, in the order's currency, before refunds: the item prices plus\n            completed amendment charges, less completed amendment credits."},"refunded":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What completed item refunds returned, in the order's currency; zero when nothing was\n            returned. You paid `total` minus `refunded`, the sum of the items' `effectivePaidAmount`."},"payment":{"description":"The latest payment attempt; `null` when none was made.","anyOf":[{"$ref":"#/components/schemas/OrderPayment"},{"type":"null"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/EsimOrderItem"},"description":"The order items, one per unit bought."},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/OrderTimelineEntry"},"description":"Every status the order has had, oldest first, each once per stretch."},"createdAt":{"type":"string","description":"When the order was created (UTC).","format":"date-time"},"updatedAt":{"type":"string","description":"When anything in the order last changed (UTC): its status, an item's fulfillment, a refund\n            or an amendment.","format":"date-time"},"fulfillmentVersion":{"type":"integer","description":"Increases with every fulfillment change; matches the\n            `order.fulfillment.updated` webhook.","format":"int64"},"referenceId":{"type":["string","null"],"description":"Your own order reference, when one was sent."},"customer":{"description":"The traveller who paid on your hosted site, masked; `null` unless the origin is `site`, and\n            once the traveller's details are deleted at the end of their retention period.","anyOf":[{"$ref":"#/components/schemas/OrderCustomer"},{"type":"null"}]}},"additionalProperties":false,"description":"The current state of an order."},"EsimOrderItem":{"required":["actions","createdAt","effectivePaidAmount","fulfillment","id","orderId","price","productType","purchasedProduct"],"type":"object","properties":{"id":{"type":"string","description":"Order item id, used by the order-item endpoints. It is not the offer's `publicId`.","format":"uuid"},"orderId":{"type":"string","description":"The order the item belongs to.","format":"uuid"},"productType":{"enum":["esim"],"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The price paid for the item at purchase, in the order's currency."},"purchasedProduct":{"$ref":"#/components/schemas/EsimPurchasedProduct"},"fulfillment":{"$ref":"#/components/schemas/EsimFulfillment"},"actions":{"allOf":[{"$ref":"#/components/schemas/OrderItemActions"}],"description":"Whether the item can be amended or cancelled now."},"createdAt":{"type":"string","description":"When the item was created (UTC).","format":"date-time"},"effectivePaidAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What you have paid for the item, net of every amount returned: `price` plus\n            completed amendment charges, less completed amendment credits and less the completed `refund`."},"refund":{"description":"The recorded refund, or `null` when no refund has been started.","anyOf":[{"$ref":"#/components/schemas/OrderItemRefund"},{"type":"null"}]}},"additionalProperties":false},"EsimOrderRequest":{"required":["items"],"type":"object","properties":{"currency":{"type":["string","null"],"description":"Order currency, three letters in either case; the API key's currency when omitted. An unsupported code gives\n400 / 10001 at `currency`, reason `NOT_SUPPORTED`, before any item is checked."},"referenceId":{"type":["string","null"],"description":"Optional partner order reference, unique per partner, at most 128 characters without leading or trailing\nspaces. A quote validates it and ignores it."},"items":{"type":"array","items":{"$ref":"#/components/schemas/EsimOrderRequestItem"},"description":"1 to 5 items, with at most 5 eSIMs in total."}},"additionalProperties":false,"description":"The body B2B eSIM quote and order both take."},"EsimOrderRequestItem":{"required":["publicId"],"type":"object","properties":{"publicId":{"type":"string","description":"Offer public ID from search, top-up search, a destination or the catalog."},"quantity":{"type":"integer","description":"Number of eSIMs, at least 1; default 1. Each eSIM becomes its own order item. A top-up takes exactly 1.","format":"int32"},"inputs":{"description":"The inputs the offer's `requiredInputs` list, plus the optional `maxPrice`. May be omitted for a new\neSIM whose offer requires none; a top-up needs `iccid`.","anyOf":[{"$ref":"#/components/schemas/EsimInputs"},{"type":"null"}]}},"additionalProperties":false,"description":"One item of an eSIM quote or order request: `{ publicId, quantity, inputs }`. The price guard is\n`inputs.maxPrice`; an eSIM has no monetary value, so there is no `value`. A top-up is an offer from\n`search?iccid=` with `inputs.iccid` and quantity 1."},"EsimProfile":{"required":["addon","day","esimStatus","isApnAutomatic","orderId","orderItemId","packageName","profileStatus","withCall","withSMS"],"type":"object","properties":{"orderId":{"type":"string","description":"The order that bought the eSIM.","format":"uuid"},"orderItemId":{"type":"string","description":"The order item that bought the eSIM, which `POST /esims/{id}/provisioning` takes.","format":"uuid"},"iccid":{"type":["string","null"],"description":"The eSIM's ICCID; null until the eSIM is provisioned."},"packageName":{"type":"string","description":"Display name of the purchased plan."},"countryImage":{"type":["string","null"],"description":"Image URL of the destination, or null."},"esimStatus":{"enum":["new","procuring","pending","failed","ready","cancelled","revoked","expired","unknown"],"type":"string","description":"The eSIM's lifecycle status, as the order item's `esimStatus`. An eSIM under review reads as pending."},"profileStatus":{"enum":["empty","new","downloaded","installed","activated","inactive","deleted","revoked","expired","unknown"],"type":"string","description":"The installed profile's status, as last recorded: the order item's `profileStatus`."},"day":{"type":"integer","description":"How many days the plan is valid, counted from activation.","format":"int32"},"isApnAutomatic":{"type":"boolean","description":"Whether the device sets the APN automatically; otherwise use `apn`."},"withSMS":{"type":"boolean","description":"Whether the plan includes SMS."},"withCall":{"type":"boolean","description":"Whether the plan includes calls."},"properties":{"description":"Plan features, such as hotspot and top-up support.","anyOf":[{"$ref":"#/components/schemas/EsimFeatures"},{"type":"null"}]},"esim":{"description":"SIM details: LPA code, QR code URL, quick-install links and usage; null until the eSIM is provisioned.","anyOf":[{"$ref":"#/components/schemas/SimCard"},{"type":"null"}]},"addon":{"type":"array","items":{"$ref":"#/components/schemas/EsimAddon"},"description":"The top-ups applied to the eSIM."},"data":{"description":"The plan's data allowance, as the offer shows it.","anyOf":[{"$ref":"#/components/schemas/EsimDataAllowance"},{"type":"null"}]},"sms":{"description":"The plan's SMS allowance; null when the plan includes no SMS.","anyOf":[{"$ref":"#/components/schemas/EsimSmsAllowance"},{"type":"null"}]},"voice":{"description":"The plan's calling allowance; null when the plan includes no calls.","anyOf":[{"$ref":"#/components/schemas/EsimVoiceAllowance"},{"type":"null"}]},"apn":{"description":"APN settings for manual device setup.","anyOf":[{"$ref":"#/components/schemas/EsimApn"},{"type":"null"}]},"expiresAt":{"type":["string","null"],"description":"When the plan ends, in UTC, as reported once the plan has started: its activation plus `day`, extended by\ntop-ups. Null until the eSIM is activated.","format":"date-time"}},"additionalProperties":false,"description":"One of your eSIMs: its order, statuses, plan, installation details, allowances and top-ups."},"EsimProfileStatusWebhook":{"required":["data","eventId","eventType","timestamp"],"type":"object","properties":{"eventId":{"type":"string","description":"The event's unique id, the same as the `X-OpenRoam-Event-Id` header. Deduplicate on it.","format":"uuid"},"eventType":{"type":"string","description":"Always `esim.profileStatus.updated`."},"timestamp":{"type":"integer","description":"When the event was created, in Unix seconds (whole seconds since 1970-01-01T00:00:00Z).","format":"int64"},"data":{"allOf":[{"$ref":"#/components/schemas/EsimProfileStatusWebhookData"}],"description":"The eSIM and its new profile status."},"isTest":{"type":"boolean","description":"True for a synthetic test delivery. Omitted on live events."}},"additionalProperties":false,"description":"The `esim.profileStatus.updated` webhook body."},"EsimProfileStatusWebhookData":{"required":["orderId","orderItemId","profileStatus"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"orderItemId":{"type":"string","format":"uuid"},"iccid":{"type":["string","null"],"description":"The eSIM's ICCID; null until the eSIM is provisioned."},"start":{"type":["string","null"],"description":"When the plan started, in UTC (ISO 8601), as `start` on usage reads; null until it is activated.","format":"date-time"},"end":{"type":["string","null"],"description":"When the plan ends, in UTC (ISO 8601), as `end` on usage reads; null while no end is reported.","format":"date-time"},"profileStatus":{"enum":["empty","new","downloaded","installed","activated","inactive","deleted","revoked","expired","unknown"],"type":"string","description":"The installed profile's new status, as `profileStatus` on the order item."}},"additionalProperties":false,"description":"Data of the `esim.profileStatus.updated` webhook. Partners address the eSIM by its order item and ICCID; the\noffer's public id and internal package ids are not part of it."},"EsimProvisioning":{"required":["status"],"type":"object","properties":{"status":{"enum":["notStarted","processing","ready","failed"],"type":"string"}},"additionalProperties":false,"description":"Progress of provisioning the eSIM."},"EsimProvisioningRequest":{"type":"object","properties":{"travelStartDate":{"type":["string","null"],"description":"The first day of travel, for a plan that requires it when the order did not send it. When the order recorded a\ndate, it must be the same date.","format":"date"}},"additionalProperties":false,"description":"The optional body of `POST /esims/{id}/provisioning`."},"EsimPurchasedDestination":{"required":["id"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"],"description":"The destination name, such as `Europe`; null when none is stored."},"code":{"type":["string","null"],"description":"The destination's eSIM code, such as `JP`, `EU` or `GLOBAL`, as browse returns it in\n`details.destinationCode`; null when none is stored."}},"additionalProperties":false,"description":"The destination an eSIM order item was bought for, as stored with the item. `id` is the destination id\nthat browse returns, so `GET /esims/destinations/{id}` gives its coverage."},"EsimPurchasedDetails":{"required":["isInstant","orderType"],"type":"object","properties":{"orderType":{"enum":["esim","topUp"],"type":"string"},"isInstant":{"type":"boolean"},"destination":{"description":"The destination the item was bought for; null for an item stored without one.","anyOf":[{"$ref":"#/components/schemas/EsimPurchasedDestination"},{"type":"null"}]}},"additionalProperties":false,"description":"eSIM facts outside the purchased-product keys every partner service shares. `isInstant` says whether\nthe eSIM is provisioned when the item is fulfilled; a deferred one waits for `POST /esims/{id}/provisioning`.\nA top-up is always instant."},"EsimPurchasedInputs":{"type":"object","properties":{"eid":{"type":["string","null"]},"imei2":{"type":["string","null"]},"iccid":{"type":["string","null"]},"travelStartDate":{"type":["string","null"],"format":"date"},"isInstant":{"type":["boolean","null"]}},"additionalProperties":false,"description":"The item's `inputs` under the request's keys. `eid`, `imei2` and `iccid`\nare masked; `travelStartDate` and `isInstant` are returned as applied, so a new eSIM\nordered without `isInstant` reads `true`. An input the item did not take is null: a new eSIM has no\n`iccid`, and a top-up takes no `isInstant`."},"EsimPurchasedProduct":{"required":["details","inputs","name"],"type":"object","properties":{"name":{"type":"string"},"countryCode":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 code of a local destination; null for regional and global ones."},"logoUrl":{"type":["string","null"]},"inputs":{"allOf":[{"$ref":"#/components/schemas/EsimPurchasedInputs"}],"description":"The item's `inputs` under the request's keys. `eid`, `imei2` and `iccid`\nare masked; `travelStartDate` and `isInstant` are returned as applied, so a new eSIM\nordered without `isInstant` reads `true`. An input the item did not take is null: a new eSIM has no\n`iccid`, and a top-up takes no `isInstant`."},"details":{"allOf":[{"$ref":"#/components/schemas/EsimPurchasedDetails"}],"description":"eSIM facts outside the purchased-product keys every partner service shares. `isInstant` says whether\nthe eSIM is provisioned when the item is fulfilled; a deferred one waits for `POST /esims/{id}/provisioning`.\nA top-up is always instant."}},"additionalProperties":false,"description":"The eSIM plan an order item bought. `name` is the package name, as the offer names it, and\n`logoUrl` is the destination image. An eSIM has no monetary value, so there is no `value`.\n`inputs` echoes the item's inputs with device and eSIM identifiers masked."},"EsimQuote":{"required":["currency","items","total"],"type":"object","properties":{"currency":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EsimQuoteItem"}},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false,"description":"Current prices for the requested items, in request order. `total` is the sum of each item's unit price\ntimes its quantity. A quote reserves nothing and does not expire."},"EsimQuoteItem":{"required":["name","price","publicId","quantity"],"type":"object","properties":{"publicId":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"name":{"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false,"description":"One quoted item: the offer's package name and its current unit price in the quote currency, the price the order\ncharges. An eSIM has no monetary value, so the item has no `value`."},"EsimRestrictions":{"required":["expireInDays","throttle"],"type":"object","properties":{"throttle":{"type":"boolean","description":"Whether the speed drops once some of the data is used."},"throttleSpeed":{"type":["number","null"],"description":"The speed after throttling, in kbps; 0 when the connection stops; null without throttling.","format":"double"},"throttleUnit":{"type":["string","null"],"description":"Always `kbps` when the plan throttles; null without throttling."},"throttleThreshold":{"type":["number","null"],"description":"The data in MB used at full speed before throttling starts; null when throttling starts only once the data\nallowance is used up, and null without throttling.","format":"double"},"throttleThresholdUnit":{"type":["string","null"],"description":"Always `MB` when `throttleThreshold` is set; otherwise null."},"expireInDays":{"type":"integer","description":"How many days the eSIM stays valid after activation.","format":"int32"}},"additionalProperties":false,"description":"A plan's throttling and expiry. Every throttle field is null when the plan does not throttle."},"EsimSearchResult":{"required":["items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EsimDestination"}},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of a list response."}},"additionalProperties":false,"description":"A page of destinations; `pagination.totalCount` counts destinations that have an orderable offer."},"EsimSmsAllowance":{"required":["isUnlimited","unit"],"type":"object","properties":{"amount":{"type":["integer","null"],"description":"The number of messages; null when it is unlimited or the plan does not state it.","format":"int64"},"unit":{"type":"string","description":"Always `messages`."},"isUnlimited":{"type":"boolean","description":"Whether messages are unlimited; `amount` is then null."},"label":{"type":["string","null"],"description":"The allowance as the plan displays it, or null."},"type":{"type":["string","null"],"description":"Which messages the allowance covers, as the plan states it, for example `all`."}},"additionalProperties":false,"description":"A plan's SMS allowance. Text messages are always counted one by one."},"EsimSmsRequest":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"The message text; required and not empty."}},"additionalProperties":false,"description":"A text message to send to an eSIM; the ICCID comes from the route."},"EsimSmsResult":{"required":["iccid"],"type":"object","properties":{"iccid":{"type":"string","description":"The ICCID of the eSIM the message was sent to."}},"additionalProperties":false,"description":"The answer to `POST /esims/{id}/sms`, given only when the message was sent."},"EsimStatusEvent":{"required":["esimStatus","iccid","occurredAt","profileStatus"],"type":"object","properties":{"iccid":{"type":"string","description":"The eSIM's ICCID."},"esimStatus":{"enum":["new","procuring","pending","failed","ready","cancelled","revoked","expired","unknown"],"type":"string","description":"The eSIM's lifecycle status after the change, with the values of `esimStatus`."},"profileStatus":{"enum":["empty","new","downloaded","installed","activated","inactive","deleted","revoked","expired","unknown"],"type":"string","description":"The installed profile's status after the change."},"occurredAt":{"type":"string","description":"When the change happened, in UTC.","format":"date-time"}},"additionalProperties":false,"description":"One status change of an eSIM."},"EsimStatusEventList":{"required":["items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EsimStatusEvent"}},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of a list response."}},"additionalProperties":false,"description":"A page of an eSIM's status changes, newest first."},"EsimUsage":{"required":["isDataUnlimited","isSmsUnlimited","isVoiceUnlimited"],"type":"object","properties":{"start":{"type":["string","null"],"description":"When the plan started, in UTC; null until it is activated.","format":"date-time"},"end":{"type":["string","null"],"description":"When the plan ends, in UTC, as last reported; null while no end is reported.","format":"date-time"},"allowedData":{"type":["integer","null"],"description":"Total data in MB; null when unlimited or not reported.","format":"int64"},"remainingData":{"type":["integer","null"],"description":"Remaining data in MB; null when unlimited or not reported.","format":"int64"},"isDataUnlimited":{"type":"boolean","description":"Whether the data is unlimited."},"allowedSms":{"type":["integer","null"],"description":"Total SMS, in messages; null when unlimited, not reported or not included.","format":"int64"},"remainingSms":{"type":["integer","null"],"description":"Remaining SMS, in messages; null when unlimited, not reported or not included.","format":"int64"},"isSmsUnlimited":{"type":"boolean","description":"Whether SMS are unlimited."},"allowedVoice":{"type":["integer","null"],"description":"Total voice, in minutes; null when unlimited, not reported or not included.","format":"int64"},"remainingVoice":{"type":["integer","null"],"description":"Remaining voice, in whole minutes; null when unlimited, not reported or not included.","format":"int64"},"isVoiceUnlimited":{"type":"boolean","description":"Whether voice is unlimited."}},"additionalProperties":false,"description":"Allowances and remaining amounts as last read: data in MB (1 MB = 1024 KB), SMS in messages, voice in minutes. An\namount is null when it is unlimited (its `is...Unlimited` flag is then true), not reported or not included."},"EsimUsageReading":{"required":["capturedAt","esimStatus","expiryBand","iccid","isDataUnlimited","isSmsUnlimited","isVoiceUnlimited","usageBand"],"type":"object","properties":{"iccid":{"type":"string","description":"The eSIM's ICCID."},"esimStatus":{"enum":["new","procuring","pending","failed","ready","cancelled","revoked","expired","unknown"],"type":"string","description":"The eSIM's lifecycle status at the reading, with the values of `esimStatus`."},"capturedAt":{"type":"string","description":"When the usage was read, in UTC.","format":"date-time"},"start":{"type":["string","null"],"description":"When the plan started, in UTC; null until it is activated.","format":"date-time"},"end":{"type":["string","null"],"description":"When the plan ends, in UTC, as reported at the reading; null while no end was reported.","format":"date-time"},"usageBand":{"enum":["none","used25Percent","used50Percent","used75Percent","used90Percent","depleted"],"type":"string","description":"The share of data used at the reading: none, 25, 50, 75 or 90 percent, or depleted."},"expiryBand":{"enum":["none","within14Days","within7Days","within3Days","within1Day"],"type":"string","description":"How close the plan was to its end at the reading: none, or within 14, 7, 3 or 1 days."},"allowedData":{"type":["integer","null"],"description":"Total data in MB; null when unlimited or not reported.","format":"int64"},"remainingData":{"type":["integer","null"],"description":"Remaining data in MB; null when unlimited or not reported.","format":"int64"},"isDataUnlimited":{"type":"boolean","description":"Whether the data is unlimited."},"allowedSms":{"type":["integer","null"],"description":"Total SMS, in messages; null when unlimited, not reported or not included.","format":"int64"},"remainingSms":{"type":["integer","null"],"description":"Remaining SMS, in messages; null when unlimited, not reported or not included.","format":"int64"},"isSmsUnlimited":{"type":"boolean","description":"Whether SMS are unlimited."},"allowedVoice":{"type":["integer","null"],"description":"Total voice, in minutes; null when unlimited, not reported or not included.","format":"int64"},"remainingVoice":{"type":["integer","null"],"description":"Remaining voice, in whole minutes; null when unlimited, not reported or not included.","format":"int64"},"isVoiceUnlimited":{"type":"boolean","description":"Whether voice is unlimited."}},"additionalProperties":false,"description":"One usage reading of an eSIM, with the names, units and null rules of `usage`."},"EsimUsageReadingList":{"required":["items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EsimUsageReading"}},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of a list response."}},"additionalProperties":false,"description":"A page of an eSIM's usage readings, newest first."},"EsimUsageWebhook":{"required":["data","eventId","eventType","timestamp"],"type":"object","properties":{"eventId":{"type":"string","description":"The event's unique id, the same as the `X-OpenRoam-Event-Id` header. Deduplicate on it.","format":"uuid"},"eventType":{"type":"string","description":"Always `esim.usage.updated`."},"timestamp":{"type":"integer","description":"When the event was created, in Unix seconds (whole seconds since 1970-01-01T00:00:00Z).","format":"int64"},"data":{"allOf":[{"$ref":"#/components/schemas/EsimUsageWebhookData"}],"description":"The eSIM's usage."},"isTest":{"type":"boolean","description":"True for a synthetic test delivery. Omitted on live events."}},"additionalProperties":false,"description":"The `esim.usage.updated` webhook body."},"EsimUsageWebhookData":{"required":["esimStatus","isDataUnlimited","isSmsUnlimited","isVoiceUnlimited","orderId","orderItemId","packageName","profileStatus"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"orderItemId":{"type":"string","format":"uuid"},"iccid":{"type":["string","null"],"description":"The eSIM's ICCID; null until the eSIM is provisioned."},"start":{"type":["string","null"],"description":"When the plan started, in UTC (ISO 8601); null until it is activated.","format":"date-time"},"end":{"type":["string","null"],"description":"When the plan ends, in UTC (ISO 8601), as last reported; null while no end is reported.","format":"date-time"},"esimStatus":{"enum":["new","procuring","pending","failed","ready","cancelled","revoked","expired","unknown"],"type":"string","description":"The eSIM's lifecycle status, as `esimStatus` on the order item and usage reads."},"profileStatus":{"enum":["empty","new","downloaded","installed","activated","inactive","deleted","revoked","expired","unknown"],"type":"string","description":"The installed profile's status, as `profileStatus` on the order item and usage reads."},"packageName":{"type":"string","description":"Display name of the purchased plan."},"allowedData":{"type":["integer","null"],"description":"Total data in MB; null when unlimited or not reported.","format":"int64"},"remainingData":{"type":["integer","null"],"description":"Remaining data in MB; null when unlimited or not reported.","format":"int64"},"isDataUnlimited":{"type":"boolean","description":"Whether the data is unlimited."},"allowedSms":{"type":["integer","null"],"description":"Total SMS, in messages; null when unlimited, not reported or not included.","format":"int64"},"remainingSms":{"type":["integer","null"],"description":"Remaining SMS, in messages; null when unlimited, not reported or not included.","format":"int64"},"isSmsUnlimited":{"type":"boolean","description":"Whether SMS are unlimited."},"allowedVoice":{"type":["integer","null"],"description":"Total voice, in minutes; null when unlimited, not reported or not included.","format":"int64"},"remainingVoice":{"type":["integer","null"],"description":"Remaining voice, in whole minutes; null when unlimited, not reported or not included.","format":"int64"},"isVoiceUnlimited":{"type":"boolean","description":"Whether voice is unlimited."}},"additionalProperties":false,"description":"Data of the `esim.usage.updated` webhook, with the names, meanings, units and formats of\n`GET /esims/{iccid}/usage`: plan and top-ups together, data in MB (1 MB = 1024 KB), SMS in messages, voice in\nminutes, and null for an amount that is unlimited, not reported or not included. Partners address the eSIM by its\norder item and ICCID; the offer's public id and internal package ids are not part of it."},"EsimVoiceAllowance":{"required":["isUnlimited","unit"],"type":"object","properties":{"amount":{"type":["integer","null"],"description":"The calling time in minutes; null when it is unlimited or the plan does not state it.","format":"int64"},"unit":{"type":"string","description":"Always `minutes`."},"isUnlimited":{"type":"boolean","description":"Whether calling is unlimited; `amount` is then null."},"label":{"type":["string","null"],"description":"The allowance as the plan displays it, or null."},"type":{"type":["string","null"],"description":"Which calls the allowance covers, as the plan states it, for example `all`."}},"additionalProperties":false,"description":"A plan's calling allowance. Calls are always counted in minutes."},"Fare":{"type":"object","properties":{"fareBasisCode":{"type":["string","null"]},"brandName":{"type":["string","null"]},"fareFamily":{"type":["string","null"]},"validatingCarrier":{"type":["string","null"]}},"additionalProperties":false},"FareOption":{"required":["details","name","price","publicId"],"type":"object","properties":{"publicId":{"type":"string","description":"The fare's own `publicId`: quote or order it before `details.expiresAt`."},"name":{"type":"string","description":"The fare's brand with its cabin, for example \"Economy Standard\"; the cabin alone without a brand."},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The fare's price for all passengers, in the quote currency, without paid extras."},"details":{"allOf":[{"$ref":"#/components/schemas/FlightOfferDetails"}],"description":"The fare's terms, as an offer's `details` in search."}},"additionalProperties":false,"description":"A fare on the quoted flights, described as search describes an offer."},"FixedPrice":{"required":["amount","currency"],"type":"object","properties":{"amount":{"type":"number","format":"decimal"},"currency":{"type":"string"}},"additionalProperties":false},"FixedValue":{"required":["amount","currency","type"],"type":"object","properties":{"amount":{"type":"number","format":"decimal"},"currency":{"type":"string"},"type":{"enum":["fixed"],"type":"string"}},"additionalProperties":false},"FlightBooking":{"required":["cabinClass","includedBaggage","passengers","selectedServices","slices","terms","totalDurationMinutes","totalStops"],"type":"object","properties":{"slices":{"type":"array","items":{"$ref":"#/components/schemas/BookedSlice"},"description":"The flights booked now, in the shape of `purchasedProduct.details.slices`."},"cabinClass":{"enum":["economy","premiumEconomy","business","first"],"type":"string","description":"The cabin booked now."},"passengers":{"type":"array","items":{"$ref":"#/components/schemas/Passenger"},"description":"The passengers booked now, in `passengerIndex` order, contacts masked."},"terms":{"allOf":[{"$ref":"#/components/schemas/BookingTerms"}],"description":"The terms the item was bought on, as `purchasedProduct.details.terms` states them; they never change after the\npurchase."},"includedBaggage":{"type":"array","items":{"$ref":"#/components/schemas/BookedBaggage"},"description":"Baggage included for every passenger now."},"selectedServices":{"type":"array","items":{"$ref":"#/components/schemas/SelectedService"},"description":"The paid extras booked now; positions refer to `slices`."},"totalDurationMinutes":{"type":"integer","description":"Flying and connection time across all slices booked now.","format":"int32"},"totalStops":{"type":"integer","description":"Connections across all slices booked now.","format":"int32"}},"additionalProperties":false,"description":"What is booked now, from the booking record, always filled. It reads as the purchased product until a committed\namendment changes the booking. The record keeps no identity documents, so each passenger's\n`identityDocuments` is empty; `purchasedProduct.inputs` has the document sent."},"FlightFulfillment":{"required":["status"],"type":"object","properties":{"status":{"enum":["pending","fulfilled","rejected"],"type":"string","description":"`pending`, `fulfilled` or `rejected`."},"result":{"oneOf":[{"$ref":"#/components/schemas/FlightFulfillmentResult"},{"enum":[null],"type":["string","null"]}]},"failure":{"description":"Why delivery was rejected (`11001`, `FULFILLMENT_REJECTED`); set only when\n            `rejected`.","anyOf":[{"$ref":"#/components/schemas/FulfillmentFailure"},{"type":"null"}]},"progress":{"anyOf":[{"$ref":"#/components/schemas/FulfillmentProgress"},{"type":"null"}]}},"additionalProperties":false},"FlightFulfillmentDetails":{"required":["booking","bookingStatus","ticketDocuments"],"type":"object","properties":{"bookingStatus":{"enum":["confirmed","pending","cancelled","failed"],"type":"string","description":"The booking's status: `confirmed`, `pending`, `cancelled` or `failed`."},"ticketDocuments":{"type":"array","items":{"$ref":"#/components/schemas/TicketDocument"},"description":"The documents the airline issued, such as e-tickets."},"booking":{"allOf":[{"$ref":"#/components/schemas/FlightBooking"}],"description":"What is booked now; the purchased product keeps what was bought."}},"additionalProperties":false,"description":"The booking as it stands now."},"FlightFulfillmentResult":{"required":["details"],"type":"object","properties":{"details":{"allOf":[{"$ref":"#/components/schemas/FlightFulfillmentDetails"}],"description":"The booking as it stands now."}},"additionalProperties":false,"description":"What a fulfilled flight order item delivered: booking facts only, under `details`. A flight sells no\nmonetary value, so there is no `deliveredValue`. Order reads, fulfillment status and streams, and the\n`order.fulfillment.updated` webhook carry the same result."},"FlightFulfillmentUpdate":{"required":["fulfillment","id","productType"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productType":{"enum":["flight"],"type":"string"},"fulfillment":{"$ref":"#/components/schemas/FlightFulfillment"}},"additionalProperties":false},"FlightInputs":{"required":["passengers"],"type":"object","properties":{"passengers":{"type":"array","items":{"$ref":"#/components/schemas/PassengerInput"},"description":"Every passenger of the offer exactly once, in `passengerIndex` order 1 to N."},"selectedServices":{"type":"array","items":{"$ref":"#/components/schemas/SelectedServiceInput"},"description":"Paid services such as extra baggage, from the quote item's `details.availableServices`. Seats are chosen in\n`passengers[].selectedSeats`, not here."},"maxPrice":{"description":"Optional highest accepted unit price, in the order or cart currency; a higher current unit price gives 409 / 11002.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]}},"additionalProperties":false},"FlightMixedOrderRequestItem":{"required":["publicId","productType","inputs"],"type":"object","properties":{"publicId":{"type":"string","description":"Required. The offer's `publicId` from the product's search, item or quote response. An unknown,\nexpired or other-product value is rejected with code `11004` at `items[i]`."},"quantity":{"type":"integer","description":"Number of units, at least 1 (default 1). Each unit becomes its own order item; an order has at most five\nunits in total. A product may allow fewer.","format":"int32"},"productType":{"enum":["flight"],"type":"string"},"inputs":{"$ref":"#/components/schemas/FlightInputs"}},"additionalProperties":false},"FlightMixedQuoteItem":{"required":["details","name","price","publicId","quantity","productType"],"type":"object","properties":{"productType":{"enum":["flight"],"type":"string"},"publicId":{"type":"string","description":"The new `publicId` of the fare: it keeps `price`'s fare price, without paid extras, as the cap of an\norder without `inputs.maxPrice`, and expires at `details.expiresAt`."},"quantity":{"type":"integer","description":"Always 1.","format":"int32"},"name":{"type":"string","description":"\"{route} · {dates} · {fare}\", for example \"LHR ⇄ JFK · 12–19 Dec · Economy Basic\"."},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The unit price the order charges now for all passengers: the fare with its taxes, plus the paid extras in the\nitem's `inputs` when they are sent."},"details":{"allOf":[{"$ref":"#/components/schemas/FlightQuoteItemDetails"}],"description":"The fare's terms, its bookable extras and the other fares on the same flights."}},"additionalProperties":false},"FlightOffer":{"required":["details","name","price","publicId"],"type":"object","properties":{"publicId":{"type":"string","description":"The fare's opaque id: quote, order and the seat map take it."},"name":{"type":"string","description":"The fare's brand with its cabin, for example \"Economy Basic\"; the cabin alone when the fare has no brand."},"description":{"type":["string","null"],"description":"Always null."},"price":{"allOf":[{"$ref":"#/components/schemas/OfferPrice"}],"description":"Indicative price for all passengers, in the search currency."},"details":{"allOf":[{"$ref":"#/components/schemas/FlightOfferDetails"}],"description":"The fare's terms."}},"additionalProperties":false,"description":"One fare bookable on the itinerary. `publicId` is what quote, order and the seat map take; it expires at\n`details.expiresAt`. Flights sell no monetary value, so there is no `value`."},"FlightOfferDetails":{"required":["availableServices","cabinClass","expiresAt","identityDocumentsRequired","includedBaggage","offerPassengers","passengerPricing","segments","supportedDocumentTypes","terms"],"type":"object","properties":{"expiresAt":{"type":"string","description":"When the fare's `publicId` expires; quote or order it before then.","format":"date-time"},"cabinClass":{"enum":["economy","premiumEconomy","business","first"],"type":"string","description":"`economy`, `premiumEconomy`, `business` or `first`."},"fare":{"description":"Fare basis, brand, fare family and validating carrier, as far as the airline gives them.","anyOf":[{"$ref":"#/components/schemas/Fare"},{"type":"null"}]},"terms":{"allOf":[{"$ref":"#/components/schemas/BookingTerms"}],"description":"How the fare is paid (always `payNow`), what cancelling it gives back and whether it can be changed, at the fare's\nprice in the search currency, OpenRoam's fees included. Each cancellation instant is also stated on the clock of the\nfirst departure airport."},"includedBaggage":{"type":"array","items":{"$ref":"#/components/schemas/Baggage"},"description":"Baggage included for every passenger."},"priceBreakdown":{"description":"Base fare and taxes of `price`; null when the airline gives no split.","anyOf":[{"$ref":"#/components/schemas/PriceBreakdown"},{"type":"null"}]},"passengerPricing":{"type":"array","items":{"$ref":"#/components/schemas/PassengerPricing"},"description":"Price per passenger type."},"offerPassengers":{"type":"array","items":{"$ref":"#/components/schemas/OfferPassenger"},"description":"The passengers the fare is priced for; `passengerIndex` names them in the order inputs."},"availableServices":{"type":"array","items":{"$ref":"#/components/schemas/AvailableService"},"description":"Paid extras; empty in search. Quote the fare to list them."},"identityDocumentsRequired":{"type":"boolean","description":"Whether every passenger needs an identity document to book."},"supportedDocumentTypes":{"type":"array","items":{"type":"string"},"description":"The document types the airline takes: `passport`, `taxId`, `knownTravelerNumber` or `passengerRedressNumber`."},"segments":{"type":"array","items":{"$ref":"#/components/schemas/SegmentFare"},"description":"Cabin and baggage on each segment of this fare, with 1-based slice and segment positions."}},"additionalProperties":false,"description":"The fare's terms. Positions (`passengerIndex`, `sliceIndex`, `segmentIndex`) are 1-based."},"FlightOrder":{"required":["createdAt","fulfillmentVersion","id","items","origin","refunded","status","timeline","total","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Order id.","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderOrigin"}],"description":"Where the order was created."},"status":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"Current order status: `paymentPending`, `processing`, `completed`,\n            `partiallyFulfilled`, `fulfillmentFailed`, `partiallyRefunded`, `refunded` or `cancelled`."},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What was charged for the order, in the order's currency, before refunds: the item prices plus\n            completed amendment charges, less completed amendment credits."},"refunded":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What completed item refunds returned, in the order's currency; zero when nothing was\n            returned. You paid `total` minus `refunded`, the sum of the items' `effectivePaidAmount`."},"payment":{"description":"The latest payment attempt; `null` when none was made.","anyOf":[{"$ref":"#/components/schemas/OrderPayment"},{"type":"null"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/FlightOrderItem"},"description":"The order items, one per unit bought."},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/OrderTimelineEntry"},"description":"Every status the order has had, oldest first, each once per stretch."},"createdAt":{"type":"string","description":"When the order was created (UTC).","format":"date-time"},"updatedAt":{"type":"string","description":"When anything in the order last changed (UTC): its status, an item's fulfillment, a refund\n            or an amendment.","format":"date-time"},"fulfillmentVersion":{"type":"integer","description":"Increases with every fulfillment change; matches the\n            `order.fulfillment.updated` webhook.","format":"int64"},"referenceId":{"type":["string","null"],"description":"Your own order reference, when one was sent."},"customer":{"description":"The traveller who paid on your hosted site, masked; `null` unless the origin is `site`, and\n            once the traveller's details are deleted at the end of their retention period.","anyOf":[{"$ref":"#/components/schemas/OrderCustomer"},{"type":"null"}]}},"additionalProperties":false,"description":"The current state of an order."},"FlightOrderItem":{"required":["actions","createdAt","effectivePaidAmount","fulfillment","id","orderId","price","productType","purchasedProduct"],"type":"object","properties":{"id":{"type":"string","description":"Order item id, used by the order-item endpoints. It is not the offer's `publicId`.","format":"uuid"},"orderId":{"type":"string","description":"The order the item belongs to.","format":"uuid"},"productType":{"enum":["flight"],"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The price paid for the item at purchase, in the order's currency."},"purchasedProduct":{"$ref":"#/components/schemas/FlightPurchasedProduct"},"fulfillment":{"$ref":"#/components/schemas/FlightFulfillment"},"actions":{"allOf":[{"$ref":"#/components/schemas/OrderItemActions"}],"description":"Whether the item can be amended or cancelled now."},"createdAt":{"type":"string","description":"When the item was created (UTC).","format":"date-time"},"effectivePaidAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What you have paid for the item, net of every amount returned: `price` plus\n            completed amendment charges, less completed amendment credits and less the completed `refund`."},"refund":{"description":"The recorded refund, or `null` when no refund has been started.","anyOf":[{"$ref":"#/components/schemas/OrderItemRefund"},{"type":"null"}]}},"additionalProperties":false},"FlightOrderRequest":{"required":["items"],"type":"object","properties":{"currency":{"type":["string","null"],"description":"Order currency, three letters in either case; the API key's currency when omitted. An unsupported code gives\n400 / 10001 at `currency`, reason `NOT_SUPPORTED`, before any item is checked."},"referenceId":{"type":["string","null"],"description":"Optional partner order reference, unique per partner, at most 128 characters without leading or trailing\nspaces. A quote validates it and ignores it."},"items":{"type":"array","items":{"$ref":"#/components/schemas/FlightOrderRequestItem"},"description":"1 to 5 items, each one fare for its passengers."}},"additionalProperties":false,"description":"The body B2B flight quote and order both take."},"FlightOrderRequestItem":{"required":["publicId"],"type":"object","properties":{"publicId":{"type":"string","description":"A fare's `publicId` from search, or the `publicId` a quote returned for the item or one of its fare\noptions. A search itinerary `id` is not a fare and gives 400 / 11004."},"quantity":{"type":"integer","description":"Always 1: one item books one fare for all its passengers.","format":"int32"},"inputs":{"description":"The passengers, paid extras and optional price guard of the fare. Optional on quote, which then prices the fare\nalone; required on order.","anyOf":[{"$ref":"#/components/schemas/FlightInputs"},{"type":"null"}]}},"additionalProperties":false,"description":"One item of a flight quote or order request: `{ publicId, quantity, inputs }`. The price guard is\n`inputs.maxPrice`; flights sell no monetary value, so there is no `value`."},"FlightPurchasedDetails":{"required":["cabinClass","includedBaggage","owner","priceLines","selectedServices","slices","terms","totalDurationMinutes","totalStops"],"type":"object","properties":{"owner":{"allOf":[{"$ref":"#/components/schemas/BookedAirline"}],"description":"The airline that sold the fare."},"slices":{"type":"array","items":{"$ref":"#/components/schemas/BookedSlice"},"description":"The flights bought, in order. They stay as bought; the result's `booking` has the flights booked now. Empty\nfor an item bought before flight times were UTC at an airport whose time zone is unknown: it has no instant to\nstate."},"cabinClass":{"enum":["economy","premiumEconomy","business","first"],"type":"string","description":"The fare's cabin."},"terms":{"allOf":[{"$ref":"#/components/schemas/BookingTerms"}],"description":"The terms the item was bought on, as quoted: always `payNow`, what cancelling gives back and whether it can be\nchanged, in the order currency, OpenRoam's fees included. Each cancellation instant is also stated on the clock of\nthe first departure airport."},"includedBaggage":{"type":"array","items":{"$ref":"#/components/schemas/BookedBaggage"},"description":"Baggage included for every passenger."},"selectedServices":{"type":"array","items":{"$ref":"#/components/schemas/SelectedService"},"description":"The paid extras bought, in the order of `inputs.selectedServices`, each with a label such as `1 × 23 kg`."},"priceLines":{"type":"array","items":{"$ref":"#/components/schemas/PriceLine"},"description":"What the item cost, line by line, in the order currency; the amounts add up to its price."},"totalDurationMinutes":{"type":"integer","description":"Flying and connection time across all slices.","format":"int32"},"totalStops":{"type":"integer","description":"Connections across all slices.","format":"int32"}},"additionalProperties":false,"description":"Flight facts outside the purchased-product keys every partner service shares, as bought."},"FlightPurchasedInputs":{"required":["passengers","selectedServices"],"type":"object","properties":{"passengers":{"type":"array","items":{"$ref":"#/components/schemas/Passenger"},"description":"Every passenger of the fare, in `passengerIndex` order."},"selectedServices":{"type":"array","items":{"$ref":"#/components/schemas/SelectedServiceInput"},"description":"The paid extras chosen in `selectedServices`; seats are on the passengers."}},"additionalProperties":false,"description":"The item's `inputs` under the request's keys, as applied. The price guard is not echoed."},"FlightPurchasedProduct":{"required":["details","inputs","name"],"type":"object","properties":{"name":{"type":"string","description":"The name the quote gave the fare, `\"{route} · {dates} · {fare}\"`."},"countryCode":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country the trip goes to, as search gives it; null when unknown."},"logoUrl":{"type":["string","null"],"description":"The owning airline's logo, an image OpenRoam hosts, or null."},"inputs":{"allOf":[{"$ref":"#/components/schemas/FlightPurchasedInputs"}],"description":"The item's inputs as applied, with contacts and document numbers masked."},"details":{"allOf":[{"$ref":"#/components/schemas/FlightPurchasedDetails"}],"description":"The flights, the fare's terms, the paid extras and what the item cost."}},"additionalProperties":false,"description":"The flight an order item bought: the itinerary and fare at purchase. A flight sells no monetary value, so there is\nno `value`."},"FlightQuote":{"required":["currency","items","total"],"type":"object","properties":{"currency":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FlightQuoteItem"}},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false,"description":"Current prices for the requested items, in request order, in `currency`. `total` is the\nsum of each item's unit price times its quantity. Each item has a new `publicId` that keeps its fare price:\norder with it before its `details.expiresAt`. Nothing is charged or held."},"FlightQuoteItem":{"required":["details","name","price","publicId","quantity"],"type":"object","properties":{"publicId":{"type":"string","description":"The new `publicId` of the fare: it keeps `price`'s fare price, without paid extras, as the cap of an\norder without `inputs.maxPrice`, and expires at `details.expiresAt`."},"quantity":{"type":"integer","description":"Always 1.","format":"int32"},"name":{"type":"string","description":"\"{route} · {dates} · {fare}\", for example \"LHR ⇄ JFK · 12–19 Dec · Economy Basic\"."},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The unit price the order charges now for all passengers: the fare with its taxes, plus the paid extras in the\nitem's `inputs` when they are sent."},"details":{"allOf":[{"$ref":"#/components/schemas/FlightQuoteItemDetails"}],"description":"The fare's terms, its bookable extras and the other fares on the same flights."}},"additionalProperties":false,"description":"One quoted fare. Flights sell no monetary value, so the item has no `value`."},"FlightQuoteItemDetails":{"required":["availableServices","expiresAt","fareOptions","hasSeatMaps","includedBaggage","quotedAt","terms"],"type":"object","properties":{"expiresAt":{"type":"string","description":"When the item's `publicId` and its services' ids expire; order before then.","format":"date-time"},"quotedAt":{"type":"string","description":"When the airline priced the fare for this quote.","format":"date-time"},"hasSeatMaps":{"type":"boolean","description":"Whether the seat map of the item's `publicId` offers seats to choose."},"terms":{"allOf":[{"$ref":"#/components/schemas/BookingTerms"}],"description":"How the item is paid (always `payNow`), what cancelling it gives back and whether it can be changed, on the item's\nprice (the fare and any paid extras) in the quote currency, OpenRoam's fees included. The order item keeps them. Each\ncancellation instant is also stated on the clock of the first departure airport."},"includedBaggage":{"type":"array","items":{"$ref":"#/components/schemas/Baggage"},"description":"Baggage included for every passenger."},"priceBreakdown":{"description":"Base fare and taxes of the fare, without paid extras; null when the airline gives no split.","anyOf":[{"$ref":"#/components/schemas/PriceBreakdown"},{"type":"null"}]},"availableServices":{"type":"array","items":{"$ref":"#/components/schemas/AvailableService"},"description":"Paid extras such as bags. Send a service's `id` in the order's `inputs.selectedServices`."},"fareOptions":{"type":"array","items":{"$ref":"#/components/schemas/FareOption"},"description":"The fares on the same flights sold by the same airline, cheapest first and including the quoted one, each with its\nown `publicId` to quote or order."}},"additionalProperties":false,"description":"The quoted fare's terms. Positions (`passengerIndexes`, `sliceIndex`, `segmentIndex`) are 1-based, as\nin search."},"FlightSearchFilters":{"type":"object","properties":{"maxStops":{"type":["integer","null"],"description":"Keeps itineraries with at most this many connections in total; 0 for direct flights only.","format":"int32"},"preferredAirlines":{"type":["array","null"],"items":{"type":"string"},"description":"Two-letter IATA airline codes; keeps itineraries sold, marketed or flown by at least one of them."},"excludedAirlines":{"type":["array","null"],"items":{"type":"string"},"description":"Two-letter IATA airline codes; drops itineraries sold, marketed or flown by any of them."},"refundableOnly":{"type":["boolean","null"],"description":"When true, keeps only fares whose `terms.cancellation.type` is not `nonRefundable`."},"maxPrice":{"type":["number","null"],"description":"Keeps fares whose price for all passengers is at most this, in the search currency; greater than 0.","format":"decimal"}},"additionalProperties":false,"description":"Optional search filters; every filter sent must match. Unknown fields are rejected."},"FlightSearchPassenger":{"required":["type"],"type":"object","properties":{"type":{"enum":["adult","child","infantWithSeat","infantWithoutSeat"],"type":"string","description":"`adult`, `child`, `infantWithSeat` or `infantWithoutSeat`."},"age":{"type":["integer","null"],"description":"Age on the travel date, 0–17; required for children and infants.","format":"int32"}},"additionalProperties":false,"description":"One traveller of the search. Unknown fields are rejected."},"FlightSearchRequest":{"required":["passengers","slices"],"type":"object","properties":{"slices":{"type":"array","items":{"$ref":"#/components/schemas/FlightSearchSlice"},"description":"One entry per flight of the trip: one for one-way, two for a return, more for a multi-city trip. At least one."},"passengers":{"type":"array","items":{"$ref":"#/components/schemas/FlightSearchPassenger"},"description":"One entry per traveller; at least one must be an `adult`."},"cabinClass":{"enum":["economy","premiumEconomy","business","first"],"type":["string","null"],"description":"Cabin to search: `economy`, `premiumEconomy`, `business` or `first`. Optional."},"filters":{"description":"Optional filters. `maxStops`, `preferredAirlines` and `excludedAirlines` select itineraries;\n`refundableOnly` and `maxPrice` select fares, and an itinerary left without a fare is not returned.","anyOf":[{"$ref":"#/components/schemas/FlightSearchFilters"},{"type":"null"}]},"page":{"type":"integer","description":"Page of itineraries, from 1; default 1.","format":"int32"},"limit":{"type":"integer","description":"Itineraries per page, 1 to 100; default 10.","format":"int32"},"currency":{"type":["string","null"],"description":"Three-letter ISO 4217 price currency, in either case; the API key's currency when omitted or blank. An\nunsupported code gives 404 / 10004."}},"additionalProperties":false,"description":"Flight search body: the trip, the passengers, optional filters, the page of itineraries and an optional price\ncurrency. Unknown fields are rejected at every level."},"FlightSearchResult":{"required":["items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of a list response."}},"additionalProperties":false,"description":"A page of itineraries. `pagination.totalCount` counts the itineraries with at least one fare after the filters.\nEach page runs a new airline search, so offers can change between pages."},"FlightSearchSlice":{"required":["departureDate","destination","origin"],"type":"object","properties":{"origin":{"type":"string","description":"Three-letter IATA airport or city code to depart from."},"destination":{"type":"string","description":"Three-letter IATA airport or city code to arrive at."},"departureDate":{"type":"string","description":"Local departure date (`yyyy-MM-dd`): today or later at the departure airport. Only a date that\n            has ended everywhere is refused; availability decides the rest.","format":"date"}},"additionalProperties":false,"description":"One flight of the trip to search. Unknown fields are rejected."},"FulfillmentFailure":{"required":["code","message","name"],"type":"object","properties":{"code":{"type":"integer","format":"int32"},"name":{"type":"string"},"message":{"type":"string"}},"additionalProperties":false},"FulfillmentProgress":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":false},"FulfillmentUpdate":{"type":"object","oneOf":[{"$ref":"#/components/schemas/EsimFulfillmentUpdate"},{"$ref":"#/components/schemas/HotelFulfillmentUpdate"},{"$ref":"#/components/schemas/FlightFulfillmentUpdate"},{"$ref":"#/components/schemas/GiftCardFulfillmentUpdate"},{"$ref":"#/components/schemas/AirtimeFulfillmentUpdate"},{"$ref":"#/components/schemas/UtilityFulfillmentUpdate"}],"discriminator":{"propertyName":"productType","mapping":{"esim":"#/components/schemas/EsimFulfillmentUpdate","hotel":"#/components/schemas/HotelFulfillmentUpdate","flight":"#/components/schemas/FlightFulfillmentUpdate","giftCard":"#/components/schemas/GiftCardFulfillmentUpdate","airtime":"#/components/schemas/AirtimeFulfillmentUpdate","utility":"#/components/schemas/UtilityFulfillmentUpdate"}}},"GiftCard":{"required":["category","details","id","name","offers"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"countryCode":{"type":["string","null"]},"category":{"enum":["shopping","foodAndDining","entertainment","gaming","travel","paymentCards","softwareAndDigital","other"],"type":"string"},"logoUrl":{"type":["string","null"]},"description":{"type":["string","null"]},"offers":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardOffer"}},"details":{"allOf":[{"$ref":"#/components/schemas/GiftCardDetails"}],"description":"Gift card facts outside the item keys every partner service shares. `isRedeemableGlobally` is true when\nthe card can be redeemed outside its issuing country; `redemptionInstructions` is the detailed\nredemption text, or null."}},"additionalProperties":false,"description":"One card (brand and issuing country, plus the face currency when a brand sells several) as search, the\none-card route and the catalog return it. `id` is the card ID `card_…`, an opaque ID that is never\norderable; an order names one of its `offers` by public ID. `countryCode` is the issuing\ncountry's ISO 3166-1 alpha-2 code, or null for a card without a country, such as a global card. Prices are\nindicative; quote recalculates them."},"GiftCardCatalogPage":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GiftCard"}},"nextCursor":{"type":["string","null"]}},"additionalProperties":false,"description":"A page of the partner catalog walk, ordered by card ID. Continue with `nextCursor`, the same\nfilters and the same currency until it is null; a page may hold fewer items than the limit, even none."},"GiftCardCategory":{"required":["category","name"],"type":"object","properties":{"category":{"enum":["shopping","foodAndDining","entertainment","gaming","travel","paymentCards","softwareAndDigital","other"],"type":"string"},"name":{"type":"string"}},"additionalProperties":false,"description":"A value of the item `category` and of the `category` filter, with its display name."},"GiftCardCategoryList":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardCategory"}}},"additionalProperties":false,"description":"The complete category reference list. The taxonomy is small and fixed, so it is not paged."},"GiftCardCode":{"type":"object","properties":{"cardNumber":{"type":["string","null"]},"pinCode":{"type":["string","null"]},"instructions":{"type":["string","null"]}},"additionalProperties":false},"GiftCardDelivery":{"required":["status"],"type":"object","properties":{"status":{"enum":["pending","processing","retry","sent","failed"],"type":"string"}},"additionalProperties":false,"description":"State of the gift email, which is sent independently of fulfillment. The recipient's address is part of the\npurchased product's inputs, so the result does not repeat it."},"GiftCardDetails":{"required":["isRedeemableGlobally"],"type":"object","properties":{"isRedeemableGlobally":{"type":"boolean"},"redemptionInstructions":{"type":["string","null"]}},"additionalProperties":false,"description":"Gift card facts outside the item keys every partner service shares. `isRedeemableGlobally` is true when\nthe card can be redeemed outside its issuing country; `redemptionInstructions` is the detailed\nredemption text, or null."},"GiftCardFulfillment":{"required":["status"],"type":"object","properties":{"status":{"enum":["pending","fulfilled","rejected"],"type":"string","description":"`pending`, `fulfilled` or `rejected`."},"result":{"oneOf":[{"$ref":"#/components/schemas/GiftCardFulfillmentResult"},{"enum":[null],"type":["string","null"]}]},"failure":{"description":"Why delivery was rejected (`11001`, `FULFILLMENT_REJECTED`); set only when\n            `rejected`.","anyOf":[{"$ref":"#/components/schemas/FulfillmentFailure"},{"type":"null"}]},"progress":{"anyOf":[{"$ref":"#/components/schemas/FulfillmentProgress"},{"type":"null"}]}},"additionalProperties":false},"GiftCardFulfillmentDetails":{"required":["codes"],"type":"object","properties":{"codes":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardCode"}},"delivery":{"description":"State of the gift email, which is sent independently of fulfillment. The recipient's address is part of the\npurchased product's inputs, so the result does not repeat it.","anyOf":[{"$ref":"#/components/schemas/GiftCardDelivery"},{"type":"null"}]}},"additionalProperties":false,"description":"The issued codes and, for a gift, the email delivery. `codes` is empty while the order item does not\nrelease them, for example after a refund. `delivery` is null for a card that is not a gift."},"GiftCardFulfillmentResult":{"required":["details"],"type":"object","properties":{"deliveredValue":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"details":{"allOf":[{"$ref":"#/components/schemas/GiftCardFulfillmentDetails"}],"description":"The issued codes and, for a gift, the email delivery. `codes` is empty while the order item does not\nrelease them, for example after a refund. `delivery` is null for a card that is not a gift."}},"additionalProperties":false,"description":"What a fulfilled gift card item delivered. `deliveredValue` is the issued card's face value, null until\na card is issued. Order reads and the `order.fulfillment.updated` webhook carry the same result."},"GiftCardFulfillmentUpdate":{"required":["fulfillment","id","productType"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productType":{"enum":["giftCard"],"type":"string"},"fulfillment":{"$ref":"#/components/schemas/GiftCardFulfillment"}},"additionalProperties":false},"GiftCardInputs":{"type":"object","properties":{"recipientIdentifier":{"type":["string","null"],"description":"Recipient's government or tax identifier; required only when the offer lists it."},"recipientEmail":{"type":["string","null"],"description":"Optional: sends the card to this address as a gift email; at most 254 characters."},"giftMessage":{"type":["string","null"],"description":"Message for the gift email, at most 500 characters; allowed only with `recipientEmail`."},"value":{"description":"Required for a range offer, within its min and max and on its step; optional for a fixed offer, where it must equal the offer's amount; in the offer's value currency.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]},"maxPrice":{"description":"Optional highest accepted unit price, in the order or cart currency; a higher current unit price gives 409 / 11002.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]}},"additionalProperties":false,"description":"A gift card item's `inputs`: the offer's `requiredInputs` plus the standard purchase fields\n`value` and `maxPrice`."},"GiftCardMixedOrderRequestItem":{"required":["publicId","productType"],"type":"object","properties":{"publicId":{"type":"string","description":"Required. The offer's `publicId` from the product's search, item or quote response. An unknown,\nexpired or other-product value is rejected with code `11004` at `items[i]`."},"quantity":{"type":"integer","description":"Number of units, at least 1 (default 1). Each unit becomes its own order item; an order has at most five\nunits in total. A product may allow fewer.","format":"int32"},"productType":{"enum":["giftCard"],"type":"string"},"inputs":{"$ref":"#/components/schemas/GiftCardInputs"}},"additionalProperties":false},"GiftCardMixedQuoteItem":{"required":["name","price","publicId","quantity","value","productType"],"type":"object","properties":{"productType":{"enum":["giftCard"],"type":"string"},"publicId":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"name":{"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false},"GiftCardOffer":{"required":["name","price","publicId","requiredInputs","value"],"type":"object","properties":{"publicId":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"value":{"$ref":"#/components/schemas/OfferValue"},"price":{"$ref":"#/components/schemas/OfferPrice"},"requiredInputs":{"type":"array","items":{"$ref":"#/components/schemas/InputField"}}},"additionalProperties":false,"description":"One orderable denomination of a card: a fixed face value or a range of them. `publicId` is the\nidentifier quote and order take. `price` is indicative and in the requested price currency."},"GiftCardOrder":{"required":["createdAt","fulfillmentVersion","id","items","origin","refunded","status","timeline","total","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Order id.","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderOrigin"}],"description":"Where the order was created."},"status":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"Current order status: `paymentPending`, `processing`, `completed`,\n            `partiallyFulfilled`, `fulfillmentFailed`, `partiallyRefunded`, `refunded` or `cancelled`."},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What was charged for the order, in the order's currency, before refunds: the item prices plus\n            completed amendment charges, less completed amendment credits."},"refunded":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What completed item refunds returned, in the order's currency; zero when nothing was\n            returned. You paid `total` minus `refunded`, the sum of the items' `effectivePaidAmount`."},"payment":{"description":"The latest payment attempt; `null` when none was made.","anyOf":[{"$ref":"#/components/schemas/OrderPayment"},{"type":"null"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardOrderItem"},"description":"The order items, one per unit bought."},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/OrderTimelineEntry"},"description":"Every status the order has had, oldest first, each once per stretch."},"createdAt":{"type":"string","description":"When the order was created (UTC).","format":"date-time"},"updatedAt":{"type":"string","description":"When anything in the order last changed (UTC): its status, an item's fulfillment, a refund\n            or an amendment.","format":"date-time"},"fulfillmentVersion":{"type":"integer","description":"Increases with every fulfillment change; matches the\n            `order.fulfillment.updated` webhook.","format":"int64"},"referenceId":{"type":["string","null"],"description":"Your own order reference, when one was sent."},"customer":{"description":"The traveller who paid on your hosted site, masked; `null` unless the origin is `site`, and\n            once the traveller's details are deleted at the end of their retention period.","anyOf":[{"$ref":"#/components/schemas/OrderCustomer"},{"type":"null"}]}},"additionalProperties":false,"description":"The current state of an order."},"GiftCardOrderItem":{"required":["actions","createdAt","effectivePaidAmount","fulfillment","id","orderId","price","productType","purchasedProduct"],"type":"object","properties":{"id":{"type":"string","description":"Order item id, used by the order-item endpoints. It is not the offer's `publicId`.","format":"uuid"},"orderId":{"type":"string","description":"The order the item belongs to.","format":"uuid"},"productType":{"enum":["giftCard"],"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The price paid for the item at purchase, in the order's currency."},"purchasedProduct":{"$ref":"#/components/schemas/GiftCardPurchasedProduct"},"fulfillment":{"$ref":"#/components/schemas/GiftCardFulfillment"},"actions":{"allOf":[{"$ref":"#/components/schemas/OrderItemActions"}],"description":"Whether the item can be amended or cancelled now."},"createdAt":{"type":"string","description":"When the item was created (UTC).","format":"date-time"},"effectivePaidAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What you have paid for the item, net of every amount returned: `price` plus\n            completed amendment charges, less completed amendment credits and less the completed `refund`."},"refund":{"description":"The recorded refund, or `null` when no refund has been started.","anyOf":[{"$ref":"#/components/schemas/OrderItemRefund"},{"type":"null"}]}},"additionalProperties":false},"GiftCardOrderRequest":{"required":["items"],"type":"object","properties":{"currency":{"type":["string","null"],"description":"Order currency, three letters in either case; the API key's currency when omitted. An unsupported code gives\n400 / 10001 at `currency`, reason `NOT_SUPPORTED`, before any item is checked."},"referenceId":{"type":["string","null"],"description":"Optional partner order reference, unique per partner, at most 128 characters without leading or trailing\nspaces. A quote validates it and ignores it."},"items":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardOrderRequestItem"},"description":"1 to 5 items, with at most 5 cards in total."}},"additionalProperties":false,"description":"The body B2B gift card quote and order both take."},"GiftCardOrderRequestItem":{"required":["publicId"],"type":"object","properties":{"publicId":{"type":"string","description":"Offer public ID from search, the one-card route, the catalog or a quote."},"quantity":{"type":"integer","description":"Number of cards, at least 1; default 1. Each card becomes its own order item.","format":"int32"},"inputs":{"description":"The inputs the offer's `requiredInputs` list, plus `value` and `maxPrice`. May be omitted for a\nfixed offer that does not list `recipientIdentifier`; a range offer needs at least `value`.","anyOf":[{"$ref":"#/components/schemas/GiftCardInputs"},{"type":"null"}]}},"additionalProperties":false,"description":"One item of a gift card quote or order request."},"GiftCardPurchasedDetails":{"required":["brandName","isRedeemableGlobally"],"type":"object","properties":{"brandName":{"type":"string"},"isRedeemableGlobally":{"type":"boolean"},"redemptionInstructions":{"type":["string","null"]}},"additionalProperties":false,"description":"Gift card facts outside the purchased-product keys every partner service shares, as captured when the card was\nadded. `redemptionInstructions` is the detailed text, or the summary when the card has only that."},"GiftCardPurchasedInputs":{"type":"object","properties":{"recipientIdentifier":{"type":["string","null"]},"recipientEmail":{"type":["string","null"]},"giftMessage":{"type":["string","null"]}},"additionalProperties":false,"description":"The item's `inputs` under the request's keys. `recipientIdentifier` and\n`recipientEmail` are masked; `giftMessage` is returned as given. The identifier is echoed\nonly when the card required it."},"GiftCardPurchasedProduct":{"required":["details","inputs","name"],"type":"object","properties":{"name":{"type":"string"},"countryCode":{"type":["string","null"]},"logoUrl":{"type":["string","null"]},"value":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"inputs":{"allOf":[{"$ref":"#/components/schemas/GiftCardPurchasedInputs"}],"description":"The item's `inputs` under the request's keys. `recipientIdentifier` and\n`recipientEmail` are masked; `giftMessage` is returned as given. The identifier is echoed\nonly when the card required it."},"details":{"allOf":[{"$ref":"#/components/schemas/GiftCardPurchasedDetails"}],"description":"Gift card facts outside the purchased-product keys every partner service shares, as captured when the card was\nadded. `redemptionInstructions` is the detailed text, or the summary when the card has only that."}},"additionalProperties":false,"description":"The card an order item bought. `name` is the card at its `value`, named as the quote names\nit, and `inputs` echoes the item's inputs with customer identifiers masked. `value` is the\ncard's face value; it is null only for older orders placed before the face value was recorded, which are named by\nthe brand alone. `countryCode` is the issuing country's ISO 3166-1 alpha-2 code, or null for a card\nwithout one, as in browse."},"GiftCardQuote":{"required":["currency","items","total"],"type":"object","properties":{"currency":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardQuoteItem"}},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false,"description":"Current prices for the requested items, in request order. `total` is the sum of each item's unit price\ntimes its quantity. A quote reserves nothing and does not expire."},"GiftCardQuoteItem":{"required":["name","price","publicId","quantity","value"],"type":"object","properties":{"publicId":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"name":{"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false,"description":"One quoted item. `price` is the current unit price in the quote currency. A range offer may be quoted\non an equivalent offer of the same card that sells the same value for less; `publicId` is then that\noffer's ID rather than the requested one, and the order should use it."},"GiftCardSearchResult":{"required":["items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GiftCard"}},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of a list response."}},"additionalProperties":false,"description":"A page of cards; `pagination.totalCount` counts cards that still have an offer after filtering."},"GiftCardUpdateInputs":{"type":"object","properties":{"recipientEmail":{"type":["string","null"],"description":"The address the gift email is sent to, at most 254 characters. Required for a card bought without a\n            recipient."},"giftMessage":{"type":["string","null"],"description":"Message for the gift email, at most 500 characters."}},"additionalProperties":false,"description":"A gift card update's `inputs`: a new gift recipient or message. The gift email is then sent again, to the new\naddress with the new message. A member left out or sent as `null` keeps its current value; at least one member\nmust be present."},"Guest":{"required":["firstName","lastName"],"type":"object","properties":{"nationality":{"type":["string","null"],"description":"Two-letter ISO 3166-1 alpha-2 nationality as sent; null when none was sent. Always null in `booking`: the\nbooking keeps none."},"countryOfResidence":{"type":["string","null"],"description":"Two-letter ISO 3166-1 alpha-2 country of residence as sent; null when none was sent. Always null in\n`booking`: the booking keeps none."},"title":{"type":["string","null"],"description":"Title, for example `Mr`, `Mrs` or `Miss`; null when there is none."},"firstName":{"type":"string","description":"First name."},"lastName":{"type":"string","description":"Last name."},"middleName":{"type":["string","null"],"description":"Middle name; null when there is none."},"age":{"type":["integer","null"],"description":"Age in years; null when none was given. A guest is a child when it is 0–17 and an adult when it is 18 or more or\nnull.","format":"int32"}},"additionalProperties":false,"description":"One guest: as sent in the purchased product's `inputs`, as booked now in the result's `booking`. A\nmember without a value is null."},"GuestAmendmentCapabilities":{"required":["addMore","ages","guestType","names","remove"],"type":"object","properties":{"addMore":{"type":"boolean"},"remove":{"type":"boolean"},"guestType":{"type":"boolean","description":"A guest may switch between adult and child."},"names":{"type":"boolean"},"ages":{"type":"boolean"}},"additionalProperties":false,"description":"What may change about the guests inside a room."},"GuestInput":{"required":["firstName","lastName"],"type":"object","properties":{"nationality":{"type":["string","null"],"description":"Optional two-letter ISO 3166-1 alpha-2 nationality. Some rates are priced for one guest market and then\nrequire it to match the search's `guestNationality`."},"countryOfResidence":{"type":["string","null"],"description":"Optional two-letter ISO 3166-1 alpha-2 country of residence. Some rates are priced for one guest market and\nthen require it to match the search's country of residence."},"title":{"type":["string","null"],"description":"Title, for example `Mr`, `Mrs` or `Miss`."},"firstName":{"type":"string","description":"First name."},"lastName":{"type":"string","description":"Last name."},"middleName":{"type":["string","null"],"description":"Middle name, if any."},"age":{"type":["integer","null"],"description":"Age in years. Send it for every child: the children's ages must match the search's `childrenAges`.","format":"int32"}},"additionalProperties":false,"description":"One guest. A guest is a child when `age` is 0–17 and an adult when it is 18 or more or omitted."},"GuestNameRules":{"required":["allowedCharacters","distinctFullNames","maxLength","minLength","pattern"],"type":"object","properties":{"minLength":{"type":"integer","description":"Fewest characters in a first or last name.","format":"int32"},"maxLength":{"type":"integer","description":"Most characters in a first or last name.","format":"int32"},"pattern":{"type":"string","description":"Regular expression every first and last name must match."},"allowedCharacters":{"type":"string","description":"The pattern in words, for a hint next to the field."},"distinctFullNames":{"type":"boolean","description":"Whether two guests of the booking may not share the same first and last name together. Sharing only a first\nname is always accepted."}},"additionalProperties":false,"description":"What the booking accepts as a holder's or guest's first and last name, so a form can check the names before\nthe order is sent. Quote, order and cart add enforce the same rules."},"HolderAmendmentCapabilities":{"required":["change"],"type":"object","properties":{"change":{"type":"boolean"}},"additionalProperties":false,"description":"Whether the booking holder may change."},"Hotel":{"required":["details","id","name","offers"],"type":"object","properties":{"id":{"type":"string","description":"The hotel's ID (`hotel_…`). Send it in `searchCriteria.hotelIds` to search this hotel again; it is not an\noffer and cannot be quoted or ordered. Stable for a hotel in the OpenRoam catalog; for any other hotel a temporary,\npartner-scoped ID that stops working after 30 minutes."},"name":{"type":"string","description":"The hotel's name."},"countryCode":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 code of the hotel's country; null when it is not known."},"category":{"type":["string","null"],"description":"Always null: the property type is not available yet."},"logoUrl":{"type":["string","null"],"description":"The hotel's main image, hosted by OpenRoam; null when there is none."},"description":{"type":["string","null"],"description":"The stored hotel description, in HTML. Null on location-search pages, which leave it out."},"offers":{"type":"array","items":{"$ref":"#/components/schemas/HotelOffer"},"description":"Orderable rates for the stay: every rate on a `hotelIds` search, the cheapest one on a location-search page."},"details":{"allOf":[{"$ref":"#/components/schemas/HotelDetails"}],"description":"Hotel facts outside the item keys every partner service shares."}},"additionalProperties":false,"description":"One hotel, as search and the dashboard group route return it. An order names one of its `offers` by\npublic ID; prices are indicative and quote recalculates them. `properties/{id}` and the catalog files return\nCatalogHotel, the same item without offers."},"HotelAmendmentCapabilities":{"required":["dates","guests","holder","rooms"],"type":"object","properties":{"guests":{"allOf":[{"$ref":"#/components/schemas/GuestAmendmentCapabilities"}],"description":"What may change about the guests inside a room."},"rooms":{"allOf":[{"$ref":"#/components/schemas/RoomAmendmentCapabilities"}],"description":"What may change about the rooms themselves. Adding a room is offered nowhere; removing one only where a single\nroom of a multi-room stay can be cancelled on its own (`roomRemovalOnly`)."},"dates":{"allOf":[{"$ref":"#/components/schemas/DateAmendmentCapabilities"}],"description":"Whether the check-in and check-out dates may move."},"holder":{"allOf":[{"$ref":"#/components/schemas/HolderAmendmentCapabilities"}],"description":"Whether the booking holder may change."}},"additionalProperties":false,"description":"Which parts of the booked stay an amendment can change for this booking: its room and guest <b>composition</b>,\nits dates and its holder."},"HotelAmenityGroup":{"required":["codes","key"],"type":"object","properties":{"key":{"type":"string","description":"Stable group key, matching an amenity group enum member."},"codes":{"type":"array","items":{"type":"string"},"description":"Canonical codes in this group, in enum declaration order."}},"additionalProperties":false,"description":"One grouped section of a hotel card's amenities."},"HotelBooking":{"required":["checkInDate","checkOutDate","holder","roomGuests"],"type":"object","properties":{"checkInDate":{"type":"string","description":"The check-in date booked now.","format":"date"},"checkOutDate":{"type":"string","description":"The check-out date booked now.","format":"date"},"holder":{"allOf":[{"$ref":"#/components/schemas/LeadGuest"}],"description":"The lead guest booked now, with email and phone masked."},"roomGuests":{"type":"array","items":{"$ref":"#/components/schemas/RoomGuests"},"description":"The guests of each room booked now, in room order. The booking keeps no guest nationality or country of\nresidence, so those are null."}},"additionalProperties":false,"description":"The stay as booked now, from the booking profile, always filled. It reads as the purchased product's stay until an\namendment changes its dates, holder or guests."},"HotelCatalogExport":{"required":["files","hotelCount"],"type":"object","properties":{"generatedAt":{"type":["string","null"],"description":"When the current files were built (UTC); null before the first build, and after a release that changes the line\nformat until the first build in the new format.","format":"date-time"},"hotelCount":{"type":"integer","description":"Hotels in each file; 0 when there are no files.","format":"int32"},"files":{"type":"array","items":{"$ref":"#/components/schemas/HotelCatalogFile"},"description":"The current catalog zips, one per variant; empty whenever `generatedAt` is null."},"replacements":{"description":"The complete confirmed ID replacement map for this build; null before its first build.","anyOf":[{"$ref":"#/components/schemas/HotelCatalogReplacementFile"},{"type":"null"}]}},"additionalProperties":false},"HotelCatalogFile":{"required":["sizeBytes","url","variant"],"type":"object","properties":{"variant":{"enum":["withoutImages","withImages"],"type":"string"},"url":{"type":"string"},"sizeBytes":{"type":"integer","format":"int64"}},"additionalProperties":false,"description":"A downloadable partner hotel catalog zip."},"HotelCatalogReplacementFile":{"required":["count","sizeBytes","url"],"type":"object","properties":{"url":{"type":"string"},"sizeBytes":{"type":"integer","format":"int64"},"count":{"type":"integer","format":"int32"}},"additionalProperties":false,"description":"The complete map of confirmed replacements for this catalog build."},"HotelContact":{"type":"object","properties":{"phone":{"type":["string","null"],"description":"Phone number."},"email":{"type":["string","null"],"description":"Email address."},"website":{"type":["string","null"],"description":"Website URL."},"address":{"description":"Postal address.","anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]}},"additionalProperties":false,"description":"Contact details."},"HotelDestination":{"required":["category","id","name"],"type":"object","properties":{"id":{"type":"string","description":"The place's ID (a UUID). Send it as `searchCriteria.location.geoNodeId` in a hotel search; it finds the hotels of every place inside this one. Stable: it can be stored."},"name":{"type":"string","description":"The place with its parents, for example `Downtown Dubai, Dubai, United Arab Emirates`."},"countryCode":{"type":["string","null"],"description":"The ISO 3166-1 alpha-2 code of the place's country, or null when it is not known."},"category":{"enum":["country","region","city","area"],"type":"string","description":"The place's level: `country`, `region`, `city` or `area` (a district or neighbourhood)."},"logoUrl":{"type":["string","null"],"description":"Always null: places have no image."}},"additionalProperties":false,"description":"One place to search hotels in, such as a country, a city or a district."},"HotelDestinationList":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/HotelDestination"},"description":"The matching places; empty when none matches."}},"additionalProperties":false,"description":"The places to search hotels in that best match `q`, most relevant first: at most `limit`, not paged."},"HotelDetails":{"required":["amenityGroups","imageUrls"],"type":"object","properties":{"starRating":{"type":["number","null"],"description":"Star rating, for example 4 or 4.5; null when not known.","format":"decimal"},"address":{"description":"The hotel's address; null when not known.","anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"coordinates":{"description":"The hotel's position; null when not known.","anyOf":[{"$ref":"#/components/schemas/Coordinates"},{"type":"null"}]},"imageUrls":{"type":"array","items":{"type":"string"},"description":"Gallery images hosted by OpenRoam. A location-search page carries at most the first one."},"amenityGroups":{"type":"array","items":{"$ref":"#/components/schemas/HotelAmenityGroup"},"description":"The hotel's amenities as codes in display groups; label them from `hotels/amenities/catalog`."},"contact":{"description":"The hotel's phone, email and website; null when none is known.","anyOf":[{"$ref":"#/components/schemas/HotelContact"},{"type":"null"}]},"displayGroup":{"description":"Dashboard only: set on a card that stands for several bookable units, which `hotels/groups/{id}` lists;\nnull otherwise.","anyOf":[{"$ref":"#/components/schemas/UnitAvailability"},{"type":"null"}]}},"additionalProperties":false,"description":"Hotel facts outside the item keys every partner service shares."},"HotelFulfillment":{"required":["status"],"type":"object","properties":{"status":{"enum":["pending","fulfilled","rejected"],"type":"string","description":"`pending`, `fulfilled` or `rejected`."},"result":{"oneOf":[{"$ref":"#/components/schemas/HotelFulfillmentResult"},{"enum":[null],"type":["string","null"]}]},"failure":{"description":"Why delivery was rejected (`11001`, `FULFILLMENT_REJECTED`); set only when\n            `rejected`.","anyOf":[{"$ref":"#/components/schemas/FulfillmentFailure"},{"type":"null"}]},"progress":{"anyOf":[{"$ref":"#/components/schemas/FulfillmentProgress"},{"type":"null"}]}},"additionalProperties":false},"HotelFulfillmentDetails":{"required":["amendmentComposition","booking","bookingStatus"],"type":"object","properties":{"bookingStatus":{"enum":["confirmed","pending","onRequest","cancelled","failed"],"type":"string","description":"The booking's status at the hotel."},"hotelConfirmationNumber":{"type":["string","null"],"description":"The hotel's own confirmation number, the one the guest gives at the desk; null until the hotel issues one, which\nmay come after fulfillment."},"amendmentComposition":{"allOf":[{"$ref":"#/components/schemas/HotelAmendmentCapabilities"}],"description":"What an amendment may change about the booked rooms and guests. Dates and the holder are always amendable."},"booking":{"allOf":[{"$ref":"#/components/schemas/HotelBooking"}],"description":"The dates, holder and guests as booked now."}},"additionalProperties":false,"description":"The booking's facts. The stay bought stays in the purchased product; `booking` is the stay as booked\nnow."},"HotelFulfillmentResult":{"required":["details"],"type":"object","properties":{"details":{"allOf":[{"$ref":"#/components/schemas/HotelFulfillmentDetails"}],"description":"The booking's status, confirmation number, amendable composition and current stay."}},"additionalProperties":false,"description":"What a fulfilled hotel order item booked. A hotel stay has no monetary value, so there is no\n`deliveredValue`; the booking facts sit under `details`. Order reads and the\n`order.fulfillment.updated` webhook carry the same result."},"HotelFulfillmentUpdate":{"required":["fulfillment","id","productType"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productType":{"enum":["hotel"],"type":"string"},"fulfillment":{"$ref":"#/components/schemas/HotelFulfillment"}},"additionalProperties":false},"HotelInputs":{"required":["holder","roomGuests"],"type":"object","properties":{"holder":{"allOf":[{"$ref":"#/components/schemas/LeadGuestInput"}],"description":"The lead guest: the booking is made in this name and the hotel contacts this person."},"roomGuests":{"type":"array","items":{"$ref":"#/components/schemas/RoomGuestsInput"},"description":"Exactly one entry per searched room, with `roomIndex` 1 to N. Each room's guests must match its\nsearched adults, children and child ages."},"specialRequests":{"type":["string","null"],"description":"Free-text requests for the hotel, up to 500 characters."},"specialRequestCodes":{"type":["array","null"],"items":{"type":"string"},"description":"Opaque codes from the rate's specialRequestOptions, applied to every room. Up to 32 distinct codes."},"maxPrice":{"description":"Optional highest accepted unit price, in the order or cart currency; a higher current unit price gives 409 / 11002.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]}},"additionalProperties":false,"description":"A hotel item's `inputs`: the people of the booking, optional special requests and the optional price guard\n`maxPrice`. Stay dates and rooms come from the selected rate, so they are not sent here. Unknown fields are\nrejected."},"HotelMixedOrderRequestItem":{"required":["publicId","productType","inputs"],"type":"object","properties":{"publicId":{"type":"string","description":"Required. The offer's `publicId` from the product's search, item or quote response. An unknown,\nexpired or other-product value is rejected with code `11004` at `items[i]`."},"quantity":{"type":"integer","description":"Number of units, at least 1 (default 1). Each unit becomes its own order item; an order has at most five\nunits in total. A product may allow fewer.","format":"int32"},"productType":{"enum":["hotel"],"type":"string"},"inputs":{"$ref":"#/components/schemas/HotelInputs"}},"additionalProperties":false},"HotelMixedQuoteItem":{"required":["details","name","price","publicId","quantity","productType"],"type":"object","properties":{"productType":{"enum":["hotel"],"type":"string"},"publicId":{"type":"string","description":"A new opaque offer ID (`rate_…`) for the rate at this price, which replaces the one the request sent: order\nwith it before `details.expiresAt`."},"quantity":{"type":"integer","description":"Always 1: an item books one rate.","format":"int32"},"name":{"type":"string","description":"`\"{hotel} · {offer}\"`, the hotel's name and the offer's name, for example\n`Hotel Arts Barcelona · Deluxe King, Breakfast, Free cancellation`."},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"Price for the whole stay, all rooms and nights, in the quote currency. An order of the returned `publicId`\nwithout `inputs.maxPrice` is refused if the rate then costs more."},"details":{"allOf":[{"$ref":"#/components/schemas/HotelQuoteItemDetails"}],"description":"The quoted stay and the rate's terms."}},"additionalProperties":false},"HotelOffer":{"required":["details","name","price","publicId"],"type":"object","properties":{"publicId":{"type":"string","description":"Opaque offer ID (`rate_…`) to quote or order, valid until `details.expiresAt`; pass it back unchanged.\nIt identifies this rate, not the hotel."},"name":{"type":"string","description":"`\"{rooms}, {board}, {terms}\"`, for example `Deluxe King, Breakfast, Free cancellation`. The terms are\n`Free cancellation` when `details.terms.cancellation.type` is `fullyRefundable` and\n`Non-refundable` when it is `nonRefundable`; a partially refundable rate has none."},"description":{"type":["string","null"],"description":"Always null."},"price":{"allOf":[{"$ref":"#/components/schemas/OfferPrice"}],"description":"Price for the whole stay, all rooms and nights, in the search currency. Indicative: quote and order price the rate\nagain."},"details":{"allOf":[{"$ref":"#/components/schemas/HotelOfferDetails"}],"description":"The rate's terms."}},"additionalProperties":false,"description":"One orderable rate of a hotel: rooms, board and terms. A hotel stay has no monetary value, so the offer has no\n`value`."},"HotelOfferDetails":{"required":["amendabilityStatus","board","expiresAt","guestNameRules","nightlyPrices","rateRules","rateTags","remarks","rooms","surcharges","terms","withTransfers"],"type":"object","properties":{"expiresAt":{"type":"string","description":"When `publicId` stops being accepted (UTC): at most 30 minutes after the search, and never after an expiry the\nhotel system states. Quote or order before then.","format":"date-time"},"rooms":{"type":"array","items":{"$ref":"#/components/schemas/Room"},"description":"The rooms of the rate, one per searched room, with that room's searched occupancy."},"board":{"allOf":[{"$ref":"#/components/schemas/MealPlan"}],"description":"The meal plan."},"terms":{"allOf":[{"$ref":"#/components/schemas/BookingTerms"}],"description":"How the stay is paid, what cancelling gives back and whether it can be changed, in the rate's currency and with\nOpenRoam's fees included. Each cancellation instant is also stated on the hotel's clock."},"taxes":{"description":"Taxes included in or added to the price, as far as they are stated; null when not stated.","anyOf":[{"$ref":"#/components/schemas/TaxBreakdown"},{"type":"null"}]},"priceIsBinding":{"type":["boolean","null"],"description":"Whether the price is stated as binding; null when not stated."},"nightlyPrices":{"type":"array","items":{"$ref":"#/components/schemas/NightlyPrice"},"description":"The price split by night, every night in the price's currency; the nights add up to the price. Empty when the\nprice is not split by night: on a B2B location search, when no nightly amounts are given, or when a night\ncould not be converted to the search currency."},"surcharges":{"type":"array","items":{"$ref":"#/components/schemas/Surcharge"},"description":"Fees outside the room rate, such as a city tax or a deposit, in the quote's and the order item's shape: `price`\nin the property's currency, `approxPrice` in the search currency or null when it could not be converted, and\n`includedInTotal` when the fee is already in the offer's price. Indicative: the quote's surcharges are binding.\nEmpty on a B2B location search."},"rateTags":{"type":"array","items":{"type":"string"},"description":"Short labels on the rate, such as a promotion name."},"remarks":{"type":"array","items":{"type":"string"},"description":"Remarks about the rate, verbatim."},"withTransfers":{"type":"boolean","description":"Whether the rate includes transfers."},"rateRules":{"type":"array","items":{"enum":["unknown","nonRefundable","package"],"type":"string"},"description":"The rate's classes, such as `nonRefundable` or `package`."},"amendabilityStatus":{"enum":["unknown","yes","no"],"type":"string","description":"Whether a booking of this rate can be amended."},"guestNameRules":{"allOf":[{"$ref":"#/components/schemas/GuestNameRules"}],"description":"What the booking accepts as a holder's or guest's first and last name, so a form can check the names before the\norder is sent."},"minimumSellingPrice":{"description":"Minimum resale price for the whole stay; use its stated currency. Null when unavailable.","anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"allowsSpecialRequests":{"type":["boolean","null"],"description":"Whether every room accepts requests; omitted when unstated."},"specialRequestOptions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpecialRequestOption"},"description":"Available requests, subject to availability at check-in; null for free-text requests."}},"additionalProperties":false,"description":"Rate facts outside the offer keys every partner service shares."},"HotelOrder":{"required":["createdAt","fulfillmentVersion","id","items","origin","refunded","status","timeline","total","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Order id.","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderOrigin"}],"description":"Where the order was created."},"status":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"Current order status: `paymentPending`, `processing`, `completed`,\n            `partiallyFulfilled`, `fulfillmentFailed`, `partiallyRefunded`, `refunded` or `cancelled`."},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What was charged for the order, in the order's currency, before refunds: the item prices plus\n            completed amendment charges, less completed amendment credits."},"refunded":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What completed item refunds returned, in the order's currency; zero when nothing was\n            returned. You paid `total` minus `refunded`, the sum of the items' `effectivePaidAmount`."},"payment":{"description":"The latest payment attempt; `null` when none was made.","anyOf":[{"$ref":"#/components/schemas/OrderPayment"},{"type":"null"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/HotelOrderItem"},"description":"The order items, one per unit bought."},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/OrderTimelineEntry"},"description":"Every status the order has had, oldest first, each once per stretch."},"createdAt":{"type":"string","description":"When the order was created (UTC).","format":"date-time"},"updatedAt":{"type":"string","description":"When anything in the order last changed (UTC): its status, an item's fulfillment, a refund\n            or an amendment.","format":"date-time"},"fulfillmentVersion":{"type":"integer","description":"Increases with every fulfillment change; matches the\n            `order.fulfillment.updated` webhook.","format":"int64"},"referenceId":{"type":["string","null"],"description":"Your own order reference, when one was sent."},"customer":{"description":"The traveller who paid on your hosted site, masked; `null` unless the origin is `site`, and\n            once the traveller's details are deleted at the end of their retention period.","anyOf":[{"$ref":"#/components/schemas/OrderCustomer"},{"type":"null"}]}},"additionalProperties":false,"description":"The current state of an order."},"HotelOrderItem":{"required":["actions","createdAt","effectivePaidAmount","fulfillment","id","orderId","price","productType","purchasedProduct"],"type":"object","properties":{"id":{"type":"string","description":"Order item id, used by the order-item endpoints. It is not the offer's `publicId`.","format":"uuid"},"orderId":{"type":"string","description":"The order the item belongs to.","format":"uuid"},"productType":{"enum":["hotel"],"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The price paid for the item at purchase, in the order's currency."},"purchasedProduct":{"$ref":"#/components/schemas/HotelPurchasedProduct"},"fulfillment":{"$ref":"#/components/schemas/HotelFulfillment"},"actions":{"allOf":[{"$ref":"#/components/schemas/OrderItemActions"}],"description":"Whether the item can be amended or cancelled now."},"createdAt":{"type":"string","description":"When the item was created (UTC).","format":"date-time"},"effectivePaidAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What you have paid for the item, net of every amount returned: `price` plus\n            completed amendment charges, less completed amendment credits and less the completed `refund`."},"refund":{"description":"The recorded refund, or `null` when no refund has been started.","anyOf":[{"$ref":"#/components/schemas/OrderItemRefund"},{"type":"null"}]}},"additionalProperties":false},"HotelOrderRequest":{"required":["items"],"type":"object","properties":{"currency":{"type":["string","null"],"description":"Quote and order currency, three letters in either case; the API key's currency when omitted. An order must be\nin the currency the offers were priced in; a quote prices them in it. An unsupported code gives 400 / 10001 at\n`currency`, reason `NOT_SUPPORTED`, before any item is checked."},"referenceId":{"type":["string","null"],"description":"Your own order reference, up to 128 characters without leading or trailing spaces, unique per partner.\nReusing it for a different order returns 409. A quote checks it and ignores it."},"items":{"type":"array","items":{"$ref":"#/components/schemas/HotelOrderRequestItem"},"description":"1 to 5 items; each prices or books one rate."}},"additionalProperties":false,"description":"The body of a B2B hotel quote and order: the currency, an optional reference and the rates to price or book."},"HotelOrderRequestItem":{"required":["publicId"],"type":"object","properties":{"publicId":{"type":"string","description":"An offer's `publicId` from search, or the newer one a quote returned. A hotel's own `id` is not an\noffer."},"quantity":{"type":"integer","description":"Must be 1: one item books one rate.","format":"int32"},"inputs":{"description":"The holder and one `roomGuests` entry per searched room, with the optional `specialRequests` and\n`maxPrice`. Required to order. A quote may leave them out; when sent, it checks them as the order does.","anyOf":[{"$ref":"#/components/schemas/HotelInputs"},{"type":"null"}]}},"additionalProperties":false,"description":"One item of a hotel quote or order: `{ publicId, quantity, inputs }`."},"HotelPurchasedDetails":{"required":["checkInDate","checkOutDate","hotel","rate","requestedRooms","terms"],"type":"object","properties":{"checkInDate":{"type":"string","description":"The check-in date bought.","format":"date"},"checkOutDate":{"type":"string","description":"The check-out date bought.","format":"date"},"requestedRooms":{"type":"array","items":{"$ref":"#/components/schemas/RoomOccupancy"},"description":"The rooms bought, in room order: adults, children and child ages, in the quote's `requestedRooms` shape."},"hotel":{"allOf":[{"$ref":"#/components/schemas/BookedHotel"}],"description":"The hotel of the stay."},"terms":{"allOf":[{"$ref":"#/components/schemas/BookingTerms"}],"description":"The terms the stay was bought on, as quoted: they do not change when a free window later closes. Each cancellation\ninstant is also stated on the hotel's clock."},"rate":{"allOf":[{"$ref":"#/components/schemas/QuotedRate"}],"description":"The rate bought: rooms, board, taxes, nightly prices and surcharges, as on the quote."}},"additionalProperties":false,"description":"Hotel facts outside the purchased-product keys every partner service shares."},"HotelPurchasedInputs":{"required":["holder","roomGuests"],"type":"object","properties":{"holder":{"allOf":[{"$ref":"#/components/schemas/LeadGuest"}],"description":"The lead guest, with email and phone masked."},"roomGuests":{"type":"array","items":{"$ref":"#/components/schemas/RoomGuests"},"description":"One entry per room, in room order, with the guests as sent."},"specialRequests":{"type":["string","null"],"description":"The requests sent to the hotel; null when none were sent."},"specialRequestCodes":{"type":["array","null"],"items":{"type":"string"},"description":"Selected opaque request codes applied to every room, when supplied."}},"additionalProperties":false,"description":"The item's `inputs` under the request's keys. The price guard `maxPrice` is not echoed."},"HotelPurchasedProduct":{"required":["details","inputs","name"],"type":"object","properties":{"name":{"type":"string","description":"`\"{hotel} · {offer}\"`, named as the quote names it, for example\n`Hotel Arts Barcelona · Deluxe King, Breakfast, Free cancellation`."},"countryCode":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 code of the hotel's country, in upper case; null when it is unknown."},"logoUrl":{"type":["string","null"],"description":"The hotel's main image; null when it has none."},"inputs":{"allOf":[{"$ref":"#/components/schemas/HotelPurchasedInputs"}],"description":"The item's inputs, with the holder's email and phone masked."},"details":{"allOf":[{"$ref":"#/components/schemas/HotelPurchasedDetails"}],"description":"The stay, the hotel and the rate bought."}},"additionalProperties":false,"description":"The stay an order item bought. A hotel stay has no monetary value, so there is no `value`. It never changes\nafter purchase."},"HotelQuote":{"required":["currency","items","total"],"type":"object","properties":{"currency":{"type":"string","description":"The quote currency: the body `currency`, or the API key's currency when it is omitted."},"items":{"type":"array","items":{"$ref":"#/components/schemas/HotelQuoteItem"},"description":"One quoted item per request item, in request order."},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The sum of each item's `price` times its `quantity`, in the quote currency."}},"additionalProperties":false,"description":"Current prices for the requested items, in request order. Each item carries a new `publicId` for its rate at\nthat price: order with it before the item's `details.expiresAt`."},"HotelQuoteItem":{"required":["details","name","price","publicId","quantity"],"type":"object","properties":{"publicId":{"type":"string","description":"A new opaque offer ID (`rate_…`) for the rate at this price, which replaces the one the request sent: order\nwith it before `details.expiresAt`."},"quantity":{"type":"integer","description":"Always 1: an item books one rate.","format":"int32"},"name":{"type":"string","description":"`\"{hotel} · {offer}\"`, the hotel's name and the offer's name, for example\n`Hotel Arts Barcelona · Deluxe King, Breakfast, Free cancellation`."},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"Price for the whole stay, all rooms and nights, in the quote currency. An order of the returned `publicId`\nwithout `inputs.maxPrice` is refused if the rate then costs more."},"details":{"allOf":[{"$ref":"#/components/schemas/HotelQuoteItemDetails"}],"description":"The quoted stay and the rate's terms."}},"additionalProperties":false,"description":"One quoted rate, at its current price. A hotel stay has no monetary value, so the item has no `value`."},"HotelQuoteItemDetails":{"required":["availability","checkInDate","checkOutDate","expiresAt","rate","requestedRooms","terms"],"type":"object","properties":{"expiresAt":{"type":"string","description":"When the returned `publicId` stops being accepted (UTC): at most 30 minutes after the quote, and never after an\nexpiry the hotel system states.","format":"date-time"},"availability":{"enum":["confirmed","onRequest"],"type":"string","description":"`confirmed` when the rate is confirmed; `onRequest` when it is held only on request, which\nan order refuses with 409 / 11003."},"checkInDate":{"type":"string","description":"The searched check-in date.","format":"date"},"checkOutDate":{"type":"string","description":"The searched check-out date.","format":"date"},"requestedRooms":{"type":"array","items":{"$ref":"#/components/schemas/RoomOccupancy"},"description":"The searched rooms, in search order: adults, children and child ages."},"terms":{"allOf":[{"$ref":"#/components/schemas/BookingTerms"}],"description":"How the stay is paid, what cancelling gives back and whether it can be changed, as quoted, in the quote currency\nand with OpenRoam's fees included. Each cancellation instant is also stated on the hotel's clock."},"rate":{"allOf":[{"$ref":"#/components/schemas/QuotedRate"}],"description":"The rate as quoted: rooms, board, taxes, nightly prices and surcharges. The quote's surcharges are the binding list."}},"additionalProperties":false,"description":"Quote facts outside the quote item keys every partner service shares."},"HotelSearchArea":{"type":"object","properties":{"cityCode":{"type":["string","null"],"description":"Three-letter IATA city code, for example `DXB`."},"geoNodeId":{"type":["string","null"],"description":"Destination ID (a UUID): a place's `id` from `GET /hotels/destinations`. A destination covers every\nplace inside it, so a city ID finds the hotels in all its areas. Takes precedence over `cityCode` when\nboth are sent.","format":"uuid"},"coordinates":{"description":"Centre point of a radius search; use with `radiusKm`.","anyOf":[{"$ref":"#/components/schemas/CoordinatesInput"},{"type":"null"}]},"radiusKm":{"type":["integer","null"],"description":"Radius around `coordinates` in kilometres, 1–150.","format":"int32"}},"additionalProperties":false,"description":"A search area. Send at least one of `geoNodeId`, `cityCode` or `coordinates`."},"HotelSearchCriteria":{"type":"object","properties":{"hotelIds":{"type":["array","null"],"items":{"type":"string"},"description":"Up to 50 hotel `publicId` values (`hotel_…`) from an earlier search, to get every rate of those\nhotels with full rate detail."},"location":{"description":"The area to search, by `geoNodeId`, `cityCode` or `coordinates`. Results are paged.","anyOf":[{"$ref":"#/components/schemas/HotelSearchArea"},{"type":"null"}]}},"additionalProperties":false},"HotelSearchDetails":{"type":"object","properties":{"availableFilters":{"description":"Amenity filter values for this search with hotel counts. Computed for a `cityCode` search only; null on\n`geoNodeId`, coordinate and `hotelIds` searches.","anyOf":[{"$ref":"#/components/schemas/HotelSearchFacets"},{"type":"null"}]}},"additionalProperties":false,"description":"Hotel search facts outside the root keys every partner service shares."},"HotelSearchFacets":{"required":["amenities","amenityGroups"],"type":"object","properties":{"amenities":{"type":"array","items":{"$ref":"#/components/schemas/AmenityFacet"}},"amenityGroups":{"type":"array","items":{"$ref":"#/components/schemas/AmenityGroup"}}},"additionalProperties":false,"description":"The filter values worth offering for this search, with how many hotels each would keep."},"HotelSearchFilters":{"type":"object","properties":{"minStarRating":{"type":["integer","null"],"description":"Lowest star rating to keep, 1–5.","format":"int32"},"maxStarRating":{"type":["integer","null"],"description":"Highest star rating to keep, 1–5; not below `minStarRating`.","format":"int32"},"minPrice":{"type":["number","null"],"description":"Keeps rates whose price for the whole stay is at least this, in the search currency; greater than 0.","format":"decimal"},"maxPrice":{"type":["number","null"],"description":"Keeps rates whose price for the whole stay is at most this, in the search currency; greater than 0 and not\nbelow `minPrice`.","format":"decimal"},"boardTypes":{"type":["array","null"],"items":{"enum":["unknown","roomOnly","breakfast","halfBoard","fullBoard","allInclusive"],"type":"string"},"description":"Meal plans to keep; `Unknown` is not accepted."},"cancellationTypes":{"type":["array","null"],"items":{"enum":["fullyRefundable","partiallyRefundable","nonRefundable"],"type":"string","description":"What cancelling a booked product gives back, OpenRoam's own fee included."},"description":"Cancellation types to keep, by the offer's `details.terms.cancellation.type`: `fullyRefundable`,\n`partiallyRefundable` or `nonRefundable`. Not empty when sent; omit it to keep every type."},"amenityCodes":{"type":["array","null"],"items":{"enum":["wifi","freeWifi","parking","freeParking","pool","gym","breakfast","freeBreakfast","restaurant","bar","roomService","airConditioning","heating","elevator","laundry","safe","airportShuttle","freeAirportShuttle","petsAllowed","familyRooms","nonSmoking","smokingArea","accessible","frontDesk24H","concierge","dailyHousekeeping","luggageStorage","terraceGarden","businessServices","expressCheckIn","spa","beach","kitchen","evCharging","hotTub"],"type":"string"},"description":"Amenity codes a hotel must have <em>all</em> of, as names such as `FreeWifi`; the codes are listed by\n`hotels/amenities/catalog`. A hotel without any amenity information never matches."}},"additionalProperties":false,"description":"Optional search filters; every filter sent must match."},"HotelSearchPagination":{"required":["currentCount","hasMore","limit"],"type":"object","properties":{"currentCount":{"type":"integer","description":"Hotels on this page, the length of `items`.","format":"int32"},"limit":{"type":"integer","description":"Hotels asked for per page: on a location search the `limit` sent, 20 by default and at most 50; on a\n`hotelIds` search the number of `hotelIds` sent, which lists fewer hotels when some have no offer\nnow. A location page can hold fewer hotels than this, even none, while `hasMore` is true.","format":"int32"},"hasMore":{"type":"boolean","description":"Whether `nextCursor` is set: send it back as `cursor` for the next page."}},"additionalProperties":false,"description":"Where a hotel search page sits in the cursor walk."},"HotelSearchRequest":{"required":["checkIn","checkOut","guestNationality","rooms"],"type":"object","properties":{"searchCriteria":{"description":"What to search: `location` or `hotelIds`. Required.","anyOf":[{"$ref":"#/components/schemas/HotelSearchCriteria"},{"type":"null"}]},"checkIn":{"type":"string","description":"Check-in date (`yyyy-MM-dd`), the hotel's local date: today or later there. Only a date that\n            has ended everywhere is refused; availability decides the rest.","format":"date"},"checkOut":{"type":"string","description":"Check-out date (`yyyy-MM-dd`); after `checkIn`, at most 30 nights later.","format":"date"},"rooms":{"type":"array","items":{"$ref":"#/components/schemas/RoomOccupancyInput"},"description":"One entry per room, 1–9 rooms. Each room is matched by its 1-based position when ordering."},"guestNationality":{"type":["string","null"],"description":"Guests' nationality as a two-letter ISO 3166-1 alpha-2 code, for example `AE`. Required: rates are\npriced for this market."},"guestCountryOfResidence":{"type":["string","null"],"description":"Guests' country of residence as a two-letter ISO 3166-1 alpha-2 code. Optional; defaults to\n`guestNationality`."},"filters":{"description":"Optional filters on star rating, price, board type and amenities.","anyOf":[{"$ref":"#/components/schemas/HotelSearchFilters"},{"type":"null"}]},"cursor":{"type":["string","null"],"description":"Location searches only: the previous response's `nextCursor`, to get the next page. Opaque; do not\nbuild or change it. A malformed cursor returns 400."},"limit":{"type":["integer","null"],"description":"Location searches only: hotels per page, 1–50 (default 20); larger values are capped at 50.","format":"int32"},"currency":{"type":["string","null"],"description":"Three-letter ISO 4217 price currency; the API key's currency when omitted."}},"additionalProperties":false,"description":"Hotel search: where to search, the stay, the rooms, the guest market and the price currency."},"HotelSearchResult":{"required":["details","items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Hotel"},"description":"The hotels of this page, each with its offers."},"pagination":{"allOf":[{"$ref":"#/components/schemas/HotelSearchPagination"}],"description":"Where this page sits. A location search walks the area's hotels with a cursor, so it states no page number and no\ntotal."},"nextCursor":{"type":["string","null"],"description":"Send it back as `cursor`, with the same body, for the next page; null on the last page. A location page can\nhold fewer hotels than the limit, even none, while it is set."},"details":{"allOf":[{"$ref":"#/components/schemas/HotelSearchDetails"}],"description":"Hotel search facts outside the keys every partner service shares."}},"additionalProperties":false,"description":"One page of hotels with their offers. A location search is paged with `nextCursor`; a `hotelIds` search\nis one complete page. A hotel without an orderable offer is not listed."},"IdentityDocument":{"required":["expiresOn","issuingCountryCode","type","uniqueIdentifier"],"type":"object","properties":{"type":{"enum":["passport","taxId","knownTravelerNumber","passengerRedressNumber"],"type":"string"},"uniqueIdentifier":{"type":"string"},"issuingCountryCode":{"type":"string"},"expiresOn":{"type":"string","format":"date"}},"additionalProperties":false,"description":"A passenger's travel document as booked; the number shows only its last four characters."},"IdentityDocumentInput":{"required":["expiresOn","issuingCountryCode","type","uniqueIdentifier"],"type":"object","properties":{"type":{"enum":["passport","taxId","knownTravelerNumber","passengerRedressNumber"],"type":"string","description":"One of the offer's `supportedDocumentTypes`: `passport`, `taxId`, `knownTravelerNumber` or\n`passengerRedressNumber`."},"uniqueIdentifier":{"type":"string","description":"The document number, as printed on the document. Responses show only its last four characters."},"issuingCountryCode":{"type":"string","description":"ISO 3166-1 alpha-2 code of the country that issued the document, for example `GB`."},"expiresOn":{"type":"string","description":"The date the document expires (`yyyy-MM-dd`).","format":"date"}},"additionalProperties":false,"description":"A travel document of the passenger. Send one when the offer's identityDocumentsRequired is true."},"InputField":{"required":["description","name","required","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"enum":["text","phone","email","date","boolean","object","array","integer"],"type":"string"},"required":{"type":"boolean"},"description":{"type":["string","null"]},"fields":{"type":["array","null"],"items":{"$ref":"#/components/schemas/InputField"},"description":"The members of an object input, or of each element of an array input; null for any other type."}},"additionalProperties":false,"description":"One field an order item supplies in `inputs`. `name` is its key: for a top-level input its path\ninside `inputs`, for example `phoneNumber` or `settings.pin`; for a nested field its key inside its\nparent, for example `email` inside `holder`. An `object` input lists its members in\n`fields`, and an `array` input lists the members of each element; build both with\nM:ObjectOf(System.String,System.Boolean,System.String,System.Collections.Generic.IReadOnlyList{InputField}) and M:ArrayOf(System.String,System.Boolean,System.String,System.Collections.Generic.IReadOnlyList{InputField}). Every other type has no fields, and the key is left out."},"Itinerary":{"required":["details","id","name","offers"],"type":"object","properties":{"id":{"type":"string","description":"Search-scoped itinerary id (`itin_…`), new in every response; quote, order and the seat map reject it with 400 / 11004."},"name":{"type":"string","description":"\"{route} · {dates} · {airline}\", for example \"LHR ⇄ JFK · 12–19 Dec · British Airways\"."},"countryCode":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country of the trip's destination; null when unknown."},"category":{"type":["string","null"],"description":"Always null: trip type and market are fixed by the request."},"logoUrl":{"type":["string","null"],"description":"The owning airline's logo, or null."},"description":{"type":["string","null"],"description":"Always null."},"offers":{"type":"array","items":{"$ref":"#/components/schemas/FlightOffer"},"description":"The fares bookable on this itinerary, cheapest first."},"details":{"allOf":[{"$ref":"#/components/schemas/ItineraryDetails"}],"description":"The flights and the airlines, shared by every fare."}},"additionalProperties":false,"description":"One itinerary: the same flights sold by the same airline, with the fares bookable on it as offers, cheapest first.\n`id` names the itinerary within this response only and is never orderable: quote and order an\noffer's `publicId`. Prices are indicative; quote recalculates them."},"ItineraryDetails":{"required":["marketingCarriers","operatingCarriers","owner","slices","totalDurationMinutes","totalStops"],"type":"object","properties":{"owner":{"allOf":[{"$ref":"#/components/schemas/Airline"}],"description":"The airline that sells the itinerary."},"slices":{"type":"array","items":{"$ref":"#/components/schemas/Slice"},"description":"The flights of the trip, in order. Fare facts (cabin and baggage per segment, fare basis) are on each offer."},"marketingCarriers":{"type":"array","items":{"$ref":"#/components/schemas/Airline"},"description":"Airlines that market a segment."},"operatingCarriers":{"type":"array","items":{"$ref":"#/components/schemas/Airline"},"description":"Airlines that fly a segment."},"totalDurationMinutes":{"type":"integer","description":"Flying and connection time across all slices.","format":"int32"},"totalStops":{"type":"integer","description":"Connections across all slices.","format":"int32"},"totalEmissionsKg":{"type":["number","null"],"description":"The CO₂ estimate for all passengers on this itinerary, as given with its cheapest fare; null when not given.","format":"decimal"}},"additionalProperties":false,"description":"Itinerary facts shared by every fare on it."},"LeadGuest":{"required":["email","firstName","lastName","phone"],"type":"object","properties":{"title":{"type":["string","null"],"description":"The title as sent; null when none was sent."},"firstName":{"type":"string","description":"The first name as sent."},"lastName":{"type":"string","description":"The last name as sent."},"email":{"type":"string","description":"The email, masked as `a***@example.com`."},"phone":{"type":"string","description":"The phone number, masked as `+34***3456`."}},"additionalProperties":false,"description":"The lead guest the stay is booked for."},"LeadGuestInput":{"required":["email","firstName","lastName","phone"],"type":"object","properties":{"title":{"type":["string","null"],"description":"Title, for example `Mr`, `Mrs` or `Ms`."},"firstName":{"type":"string","description":"First name."},"lastName":{"type":"string","description":"Last name."},"email":{"type":"string","description":"Email address, at most 100 characters."},"phone":{"type":"string","description":"Phone number in international format, for example `+15551234567`."}},"additionalProperties":false,"description":"The lead guest: the booking is made in this name and the hotel contacts this person."},"ManualAmendmentApproveRequest":{"type":"object","properties":{"walletId":{"type":["string","null"],"description":"Optional ID of your wallet to settle the amendment from; the wallet proposed with the quote is used when\nomitted. It cannot be changed while an approval is in progress.","format":"uuid"}},"additionalProperties":false,"description":"Approval of a quoted manual amendment."},"ManualAmendmentCreateRequest":{"type":"object","properties":{"attributes":{"description":"The requested change, as a JSON object; anything omitted keeps its booked value. Fields:\n`checkInDate` and `checkOutDate` (`yyyy-MM-dd`); `holder` (`title`,\n`firstName`, `lastName`, `email`, `phone`); `roomGuests`, one entry per booked room\nwith a 1-based `roomIndex` and its `guests` (`title`, `firstName`, `lastName`,\n`middleName`, `isAdult` defaulting to true, and `age` for a child). Occupancy follows the\nguest list. Order reads return the holder's `email` and `phone` masked: send one back as returned,\nor empty, to keep the booked one; any other masked value is refused with 400 / 10001. Their guests carry no\n`isAdult`: send `false` for a guest aged 0–17."}},"additionalProperties":false,"description":"A manual amendment request for a hotel booking."},"ManualAmendmentResult":{"required":["amendmentId"],"type":"object","properties":{"amendmentId":{"type":"string","description":"ID of the amendment request.","format":"uuid"}},"additionalProperties":false},"ManualAmendmentStatusWebhook":{"required":["data","eventId","eventType","timestamp"],"type":"object","properties":{"eventId":{"type":"string","format":"uuid"},"eventType":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"data":{"allOf":[{"$ref":"#/components/schemas/ManualAmendmentStatusWebhookData"}]},"isTest":{"type":"boolean","description":"True for a synthetic test delivery. Omitted on live events."}},"additionalProperties":false},"ManualAmendmentStatusWebhookData":{"required":["actionRequired","amendmentId","amountToPay","amountToRefund","currencyCode","orderId","orderItemId","publicId","status"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"orderItemId":{"type":"string","format":"uuid"},"publicId":{"type":"string"},"amendmentId":{"type":"string","format":"uuid"},"status":{"enum":["quoted","completed","failed","cancelled"],"type":"string","description":"The amendment's status, spelled as `GET /order-items/{id}/amendments` shows it: `quoted`,\n            `completed`, `failed` or `cancelled`."},"actionRequired":{"type":"boolean"},"amountToPay":{"type":"number","format":"decimal"},"amountToRefund":{"type":"number","format":"decimal"},"currencyCode":{"type":"string"},"wallet":{"anyOf":[{"$ref":"#/components/schemas/ManualAmendmentWallet"},{"type":"null"}]},"reason":{"type":["string","null"]},"quoteRevision":{"type":["integer","null"],"format":"int32"}},"additionalProperties":false},"ManualAmendmentWallet":{"required":["currency","id","label"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"currency":{"allOf":[{"$ref":"#/components/schemas/Currency"}],"description":"A supported currency with its current rate."}},"additionalProperties":false},"MealPlan":{"required":["boardType","code","name"],"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"boardType":{"enum":["unknown","roomOnly","breakfast","halfBoard","fullBoard","allInclusive"],"type":"string"}},"additionalProperties":false,"description":"The meal plan a rate is sold with. `boardType` is the value to branch or filter on;\n`code` is its short form (`RO`, `BB`, `HB`, `FB`, `AI`, or `OTHER`\nwhen the plan has no standard equivalent) and `name` the text to show."},"MixedOrderRequest":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MixedOrderRequestItem"},"description":"Required. One to five items; the sum of their `quantity` is at most five."},"currency":{"type":["string","null"],"description":"Three-letter currency code the order is priced and charged in, for example `USD`. When omitted or\nempty, the API key's default currency is used. An unsupported code gives 400 / 10001 at `currency`,\nreason `NOT_SUPPORTED`, before any item is checked."},"referenceId":{"type":["string","null"],"description":"Optional reference of your own, up to 128 characters, without leading or trailing whitespace. It must be\nunique among your orders (a reused value returns `409`) and can be used to find the order with the\n`referenceId` filter of the order list."},"maxTotal":{"description":"Optional highest accepted order total, in the order currency: the sum of every item's price times its\nquantity. A higher total gives 409 / 11002 at maxTotal before anything is charged; a currency other than the\norder currency gives 400 / 10001 at maxTotal.currency.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]}},"additionalProperties":false,"description":"An order of one to five items, of one or several product types, paid from the wallet."},"MixedOrderRequestItem":{"required":["productType","publicId"],"type":"object","oneOf":[{"$ref":"#/components/schemas/EsimMixedOrderRequestItem"},{"$ref":"#/components/schemas/HotelMixedOrderRequestItem"},{"$ref":"#/components/schemas/FlightMixedOrderRequestItem"},{"$ref":"#/components/schemas/GiftCardMixedOrderRequestItem"},{"$ref":"#/components/schemas/AirtimeMixedOrderRequestItem"},{"$ref":"#/components/schemas/UtilityMixedOrderRequestItem"}],"properties":{"publicId":{"type":"string","description":"Required. The offer's `publicId` from the product's search, item or quote response. An unknown,\nexpired or other-product value is rejected with code `11004` at `items[i]`."},"inputs":{"description":"Product-specific purchase inputs, as defined by the product's own order request, such as the phone\nnumber for airtime or the passengers for flights. Required for hotels and flights.","nullable":true},"quantity":{"type":"integer","description":"Number of units, at least 1 (default 1). Each unit becomes its own order item; an order has at most five\nunits in total. A product may allow fewer.","format":"int32"},"productType":{"enum":["esim","hotel","flight","carRental","train","lounge","ticket","tour","activity","cruise","remittance","vpn","transportation","insurance","billPayment","giftCard","loyaltyProgram","voip","airtime","utility"],"type":"string","description":"Required. The product type of the offer, as a string, for example `giftCard`. It must match the\nproduct of `publicId`."}},"additionalProperties":false,"description":"One line of an order: an offer, how many to buy and the purchase inputs.","discriminator":{"propertyName":"productType","mapping":{"esim":"#/components/schemas/EsimMixedOrderRequestItem","hotel":"#/components/schemas/HotelMixedOrderRequestItem","flight":"#/components/schemas/FlightMixedOrderRequestItem","giftCard":"#/components/schemas/GiftCardMixedOrderRequestItem","airtime":"#/components/schemas/AirtimeMixedOrderRequestItem","utility":"#/components/schemas/UtilityMixedOrderRequestItem"}}},"MixedQuote":{"required":["currency","items","total"],"type":"object","properties":{"currency":{"type":"string","description":"The quote currency: the body `currency`, or the API key's currency when it is omitted."},"items":{"type":"array","items":{"$ref":"#/components/schemas/MixedQuoteItem"},"description":"One quoted item per request item, in request order. Each is the quote item of its product with\n`productType`; its `publicId` may be a new one that the order should use."},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The sum of each item's `price` times its `quantity`, in the quote currency."},"expiresAt":{"type":["string","null"],"description":"The earliest `details.expiresAt` of the items that have one (UTC): order before then. `null` when no item\nhas an expiry.","format":"date-time"}},"additionalProperties":false,"description":"Current prices for the items of a mixed order body, in request order."},"MixedQuoteItem":{"type":"object","oneOf":[{"$ref":"#/components/schemas/EsimMixedQuoteItem"},{"$ref":"#/components/schemas/HotelMixedQuoteItem"},{"$ref":"#/components/schemas/FlightMixedQuoteItem"},{"$ref":"#/components/schemas/GiftCardMixedQuoteItem"},{"$ref":"#/components/schemas/AirtimeMixedQuoteItem"},{"$ref":"#/components/schemas/UtilityMixedQuoteItem"}],"description":"A quoted item: the product's own quote item, plus `productType`.","discriminator":{"propertyName":"productType","mapping":{"esim":"#/components/schemas/EsimMixedQuoteItem","hotel":"#/components/schemas/HotelMixedQuoteItem","flight":"#/components/schemas/FlightMixedQuoteItem","giftCard":"#/components/schemas/GiftCardMixedQuoteItem","airtime":"#/components/schemas/AirtimeMixedQuoteItem","utility":"#/components/schemas/UtilityMixedQuoteItem"}}},"MobileNetwork":{"required":["countryName","mcc","mnc","operator"],"type":"object","properties":{"mcc":{"type":"string"},"mnc":{"type":"string"},"countryCode":{"type":["string","null"]},"countryName":{"type":"string"},"operator":{"type":"string"},"dialCode":{"type":["string","null"]}},"additionalProperties":false,"description":"One mobile network code (ITU E.212). `mcc` is the 3-digit mobile country code and `mnc`\nthe 2- or 3-digit network code, kept as strings because leading zeros matter. `countryCode` is ISO\n3166-1 alpha-2, null for international and non-ISO networks; `countryName` and\n`dialCode` come from the countries dataset when the country is known, as on /common/countries."},"MobileNetworkList":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MobileNetwork"}}},"additionalProperties":false,"description":"Mobile network codes ordered by MCC then MNC. The list is a few thousand rows of reference data, so it is not paged."},"Money":{"required":["amount","currency"],"type":"object","properties":{"amount":{"type":"number","format":"decimal"},"currency":{"type":"string"}},"additionalProperties":false},"MoneyInput":{"required":["amount","currency"],"type":"object","properties":{"amount":{"type":"number","format":"decimal"},"currency":{"type":"string"}},"additionalProperties":false,"description":"An amount and its ISO 4217 currency sent in a request, such as `inputs.value` and the `inputs.maxPrice`\nprice guard. Unknown members are rejected."},"NightlyPrice":{"required":["amount","currency","date"],"type":"object","properties":{"date":{"type":"string","format":"date"},"amount":{"type":"number","format":"decimal"},"currency":{"type":"string"}},"additionalProperties":false},"NumberCarrier":{"required":["lineType"],"type":"object","properties":{"name":{"type":["string","null"]},"normalizedName":{"type":["string","null"]},"lineType":{"enum":["unknown","mobile","fixedLine","fixedLineOrMobile","tollFree","premiumRate","sharedCost","voip","personalNumber","pager","uan","voicemail"],"type":"string"},"isPorted":{"type":["boolean","null"]}},"additionalProperties":false,"description":"Carrier information from the number lookup. `name` may identify the original number-block\nowner when portability data is unavailable; it does not guarantee the current carrier after porting.\n`normalizedName` is the reported parent network when\nknown. `lineType` is the carrier's view of the line. `isPorted` is null when the lookup does\nnot say, which is common outside the US. For display only: the operator OpenRoam sells for a number comes from search."},"NumberLookup":{"required":["dialCode","internationalFormat","isValid","lineType","nationalFormat","nationalNumber","phoneNumber"],"type":"object","properties":{"phoneNumber":{"type":"string"},"isValid":{"type":"boolean"},"countryCode":{"type":["string","null"]},"dialCode":{"type":"string"},"nationalNumber":{"type":"string"},"internationalFormat":{"type":"string"},"nationalFormat":{"type":"string"},"lineType":{"enum":["unknown","mobile","fixedLine","fixedLineOrMobile","tollFree","premiumRate","sharedCost","voip","personalNumber","pager","uan","voicemail"],"type":"string"},"carrier":{"description":"Carrier information from the number lookup. `name` may identify the original number-block\nowner when portability data is unavailable; it does not guarantee the current carrier after porting.\n`normalizedName` is the reported parent network when\nknown. `lineType` is the carrier's view of the line. `isPorted` is null when the lookup does\nnot say, which is common outside the US. For display only: the operator OpenRoam sells for a number comes from search.","anyOf":[{"$ref":"#/components/schemas/NumberCarrier"},{"type":"null"}]}},"additionalProperties":false,"description":"What a phone number's own digits say about it, from numbering-plan data, plus carrier data from a carrier lookup.\n`phoneNumber` is the number in E.164. `isValid` is false when the digits do not form a\nnumber its country assigns; the other fields then hold whatever could still be read, and `lineType` is\nunknown. `countryCode` is ISO 3166-1 alpha-2, null when the number belongs to no single country.\n`dialCode` is the calling code with its leading plus. The formats are for display only.\n`carrier` comes from a carrier lookup made only for a valid number; it is null for an invalid one."},"OfferPassenger":{"required":["availableServices","includedBaggage","passengerIndex"],"type":"object","properties":{"passengerIndex":{"type":"integer","description":"1-based position in the offer's passenger list; order inputs use it to name the passenger.","format":"int32"},"type":{"enum":["adult","child","infantWithSeat","infantWithoutSeat"],"type":["string","null"]},"age":{"type":["integer","null"],"format":"int32"},"fareType":{"type":["string","null"]},"includedBaggage":{"type":"array","items":{"$ref":"#/components/schemas/Baggage"}},"availableServices":{"type":"array","items":{"$ref":"#/components/schemas/AvailableService"}}},"additionalProperties":false},"OfferPrice":{"oneOf":[{"$ref":"#/components/schemas/FixedPrice"},{"$ref":"#/components/schemas/PriceRange"}],"description":"Price OpenRoam charges the partner for an offer: one amount, or bounds for a range offer.\nThe variants carry no discriminator, so this type is written to responses and never bound."},"OfferValue":{"oneOf":[{"$ref":"#/components/schemas/FixedValue"},{"$ref":"#/components/schemas/ValueRange"}],"description":"Monetary value an offer delivers to the partner's customer: one fixed amount or a range.\nThe discriminator literals are spelled out because the webhook serializer does not camel-case\ndiscriminators the way the API hosts do. Declare members as OfferValue: a member\ntyped as a variant is written without its `type`.","discriminator":{"propertyName":"type","mapping":{"fixed":"#/components/schemas/FixedValue","range":"#/components/schemas/ValueRange"}}},"Order":{"required":["createdAt","fulfillmentVersion","id","items","origin","refunded","status","timeline","total","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Order id.","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderOrigin"}],"description":"Where the order was created."},"status":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"Current order status: `paymentPending`, `processing`, `completed`,\n            `partiallyFulfilled`, `fulfillmentFailed`, `partiallyRefunded`, `refunded` or `cancelled`."},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What was charged for the order, in the order's currency, before refunds: the item prices plus\n            completed amendment charges, less completed amendment credits."},"refunded":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What completed item refunds returned, in the order's currency; zero when nothing was\n            returned. You paid `total` minus `refunded`, the sum of the items' `effectivePaidAmount`."},"payment":{"description":"The latest payment attempt; `null` when none was made.","anyOf":[{"$ref":"#/components/schemas/OrderPayment"},{"type":"null"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"},"description":"The order items, one per unit bought."},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/OrderTimelineEntry"},"description":"Every status the order has had, oldest first, each once per stretch."},"createdAt":{"type":"string","description":"When the order was created (UTC).","format":"date-time"},"updatedAt":{"type":"string","description":"When anything in the order last changed (UTC): its status, an item's fulfillment, a refund\n            or an amendment.","format":"date-time"},"fulfillmentVersion":{"type":"integer","description":"Increases with every fulfillment change; matches the\n            `order.fulfillment.updated` webhook.","format":"int64"},"referenceId":{"type":["string","null"],"description":"Your own order reference, when one was sent."},"customer":{"description":"The traveller who paid on your hosted site, masked; `null` unless the origin is `site`, and\n            once the traveller's details are deleted at the end of their retention period.","anyOf":[{"$ref":"#/components/schemas/OrderCustomer"},{"type":"null"}]}},"additionalProperties":false,"description":"The current state of an order."},"OrderCancellationPreview":{"required":["currency","items","orderId","totals"],"type":"object","properties":{"orderId":{"type":"string","description":"Order id.","format":"uuid"},"currency":{"type":"string","description":"The order's currency; every amount is in it."},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderCancellationPreviewItem"},"description":"One entry per order item."},"totals":{"allOf":[{"$ref":"#/components/schemas/OrderCancellationPreviewTotals"}],"description":"The sums over the `previewable` items."}},"additionalProperties":false,"description":"A preview of cancelling every item of an order now. It changes nothing and does not lock the amounts."},"OrderCancellationPreviewItem":{"required":["orderItemId","productType","status"],"type":"object","properties":{"orderItemId":{"type":"string","description":"Order item id (`items[].id` from the order response).","format":"uuid"},"productType":{"enum":["esim","hotel","flight","carRental","train","lounge","ticket","tour","activity","cruise","remittance","vpn","transportation","insurance","billPayment","giftCard","loyaltyProgram","voip","airtime","utility"],"type":"string","description":"The item's product type."},"status":{"enum":["previewable","notCancellable"],"type":"string","description":"`previewable`: `preview` prices cancelling the item now; `notCancellable`:\n            `reason` says why it is not priced."},"reason":{"enum":["notFulfilled","refunded","refundInProgress","amendmentInProgress","manualReview","notAllowed"],"type":["string","null"],"description":"`notFulfilled`, `refunded`, `refundInProgress`, `amendmentInProgress`,\n            `manualReview` or `notAllowed`; `null` when `previewable`."},"preview":{"description":"The item's cancellation preview; `null` when `notCancellable`.","anyOf":[{"$ref":"#/components/schemas/OrderItemCancellationPreview"},{"type":"null"}]}},"additionalProperties":false,"description":"The cancellation preview of one order item."},"OrderCancellationPreviewTotals":{"required":["cancellationFee","isComplete","penaltyAmount","refundAmount"],"type":"object","properties":{"penaltyAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The sum of the items' `penaltyAmount`."},"cancellationFee":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The sum of the items' `cancellationFee`; 0 when none applies."},"refundAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The sum of the items' `refundAmount`."},"isComplete":{"type":"boolean","description":"`true` only when every item is `previewable`."}},"additionalProperties":false,"description":"The sums over the `previewable` items, in the order currency."},"OrderCustomer":{"required":["countryCode","email","language","name"],"type":"object","properties":{"email":{"type":"string","description":"The traveller's email, masked: its first character and its domain, for example\n            `t***@example.com`."},"name":{"type":"string","description":"The traveller's name as entered at checkout."},"phone":{"type":["string","null"],"description":"The traveller's phone number, masked to its country code and last four digits; `null` when\n            none was given."},"language":{"type":"string","description":"The language the traveller used on the site, for example `en`."},"countryCode":{"type":"string","description":"The traveller's country, ISO 3166-1 alpha-2."}},"additionalProperties":false,"description":"The traveller who paid for an order on one of your hosted sites, masked. Only an order with origin\n            `site` has one."},"OrderEmailResendRequest":{"required":["type"],"type":"object","properties":{"type":{"enum":["receipt","delivery"],"type":["string","null"],"description":"Required. `receipt` (the receipt of what was charged to the traveller's card) or\n            `delivery` (one item's delivery email: its codes, eSIM installation, top-up or booking confirmation)."},"orderItemId":{"type":["string","null"],"description":"Required for `delivery`: the item (`items[].id`) whose delivery email is sent.\n            Not allowed for `receipt`, which covers the whole order.","format":"uuid"}},"additionalProperties":false,"description":"An email of a hosted-site order to send to its traveller again."},"OrderEmailResendResult":{"required":["orderId","type"],"type":"object","properties":{"orderId":{"type":"string","description":"The order.","format":"uuid"},"type":{"enum":["receipt","delivery"],"type":"string","description":"`receipt` or `delivery`, as requested."},"orderItemId":{"type":["string","null"],"description":"The item of a `delivery` email; `null` for a `receipt`.","format":"uuid"},"recipient":{"type":["string","null"],"description":"The traveller's email address the order recorded at checkout, masked: its first character\n            and its domain, for example `t***@example.com`. The email is only ever sent there. `null` only when a\n            request that was already sent is sent again after the traveller's details were erased."}},"additionalProperties":false,"description":"The email that was sent again."},"OrderFulfillmentStatus":{"required":["fulfillmentVersion","id","items"],"type":"object","properties":{"id":{"type":"string","description":"Order id.","format":"uuid"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"},"description":"The order items with their fulfillment."},"fulfillmentVersion":{"type":"integer","description":"Increases with every fulfillment change; matches the\n            `order.fulfillment.updated` webhook.","format":"int64"}},"additionalProperties":false,"description":"The current fulfillment state of an order's items."},"OrderFulfillmentWebhook":{"required":["data","eventId","eventType","timestamp"],"type":"object","properties":{"eventId":{"type":"string","format":"uuid"},"eventType":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"data":{"allOf":[{"$ref":"#/components/schemas/OrderFulfillmentWebhookData"}]},"isTest":{"type":"boolean","description":"True for a synthetic test delivery. Omitted on live events."}},"additionalProperties":false},"OrderFulfillmentWebhookData":{"required":["fulfillmentVersion","items","orderId","origin","status"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderOrigin"}],"description":"Where an order was created."},"status":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"The order's status, including the refunds of its delivered items."},"fulfillmentVersion":{"type":"integer","format":"int64"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentUpdate"}}},"additionalProperties":false},"OrderItem":{"type":"object","oneOf":[{"$ref":"#/components/schemas/EsimOrderItem"},{"$ref":"#/components/schemas/HotelOrderItem"},{"$ref":"#/components/schemas/FlightOrderItem"},{"$ref":"#/components/schemas/GiftCardOrderItem"},{"$ref":"#/components/schemas/AirtimeOrderItem"},{"$ref":"#/components/schemas/UtilityOrderItem"}],"description":"One purchased unit of an order.","discriminator":{"propertyName":"productType","mapping":{"esim":"#/components/schemas/EsimOrderItem","hotel":"#/components/schemas/HotelOrderItem","flight":"#/components/schemas/FlightOrderItem","giftCard":"#/components/schemas/GiftCardOrderItem","airtime":"#/components/schemas/AirtimeOrderItem","utility":"#/components/schemas/UtilityOrderItem"}}},"OrderItemActions":{"required":["amendment","cancellation","update"],"type":"object","properties":{"amendment":{"allOf":[{"$ref":"#/components/schemas/ActionAvailability"}],"description":"Whether the item can be changed through a priced amendment (hotels and flights)."},"cancellation":{"allOf":[{"$ref":"#/components/schemas/ActionAvailability"}],"description":"Whether the item can be cancelled now."},"update":{"allOf":[{"$ref":"#/components/schemas/ActionAvailability"}],"description":"Whether the item can be updated now with `POST /order-items/{id}/update`, a change that\n            never charges. `notAvailable` for every product that cannot be updated."}},"additionalProperties":false,"description":"Item-level actions."},"OrderItemAmendment":{"required":["amountToPay","amountToRefund","createdAt","id","orderItemId","productType","status"],"type":"object","properties":{"id":{"type":"string","description":"Amendment id.","format":"uuid"},"orderItemId":{"type":"string","description":"The amended order item.","format":"uuid"},"status":{"enum":["pending","completed","cancelled","failed","inProgress","quoted","partnerApproved","approvalInProgress"],"type":"string","description":"Amendment status."},"productType":{"enum":["esim","hotel","flight","carRental","train","lounge","ticket","tour","activity","cruise","remittance","vpn","transportation","insurance","billPayment","giftCard","loyaltyProgram","voip","airtime","utility"],"type":"string","description":"The item's product type."},"createdAt":{"type":"string","description":"When the amendment was created (UTC).","format":"date-time"},"amountToPay":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The surcharge for the change."},"amountToRefund":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The credit for the change."}},"additionalProperties":false,"description":"An amendment of an order item."},"OrderItemCancelRequest":{"required":["reason"],"type":"object","properties":{"reason":{"enum":["requestedByCustomer","duplicate","fraudulent","fulfillmentFailed"],"type":"string","description":"Required. Why the item is refunded: `requestedByCustomer`, `duplicate`, `fraudulent`, or\n`fulfillmentFailed`, which is accepted only for an item whose fulfillment was rejected."}},"additionalProperties":false,"description":"The reason for refunding an order item."},"OrderItemCancelResult":{"required":["amount","method","orderItemId","status"],"type":"object","properties":{"orderItemId":{"type":"string","description":"The refunded order item.","format":"uuid"},"amount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The amount refunded, in the order's currency."},"method":{"enum":["balance","card"],"type":"string","description":"How the amount is returned; `balance` returns it to the wallet that paid."},"status":{"enum":["pending","refunded","failed","processing"],"type":"string","description":"Refund status: `refunded` when complete; `pending` or `processing` while it\n            settles; `failed` when it did not complete."},"wallet":{"description":"The wallet the refund was returned to and the amount it received, in the wallet's currency;\n            `null` until money is back in a wallet, and for a refund to a card.","anyOf":[{"$ref":"#/components/schemas/OrderRefundWallet"},{"type":"null"}]}},"additionalProperties":false,"description":"The refund of an order item."},"OrderItemCancellationPreview":{"required":["effectiveCancellationDate","isRefundable","penaltyAmount","refundAmount"],"type":"object","properties":{"penaltyAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The penalty that would be kept, in the order currency."},"cancellationFee":{"description":"A cancellation fee taken in addition to the penalty, in the order currency; `null` when none applies. It\ncomes out of what the penalty leaves, so it never makes the refund negative.","anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"refundAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The amount that would be refunded, in the order currency: what was paid less the penalty and the\n            cancellation fee."},"isRefundable":{"type":"boolean","description":"Whether anything would be refunded; `false` is not an error."},"appliedPenalties":{"type":["array","null"],"items":{"$ref":"#/components/schemas/CancellationPenalty"},"description":"The cancellation band in effect now, priced at `penaltyAmount`: at most one entry. Empty when the\nitem's bands have not started yet; `null` when it states none."},"effectiveCancellationDate":{"type":"string","description":"The cancellation time the preview is calculated for (UTC).","format":"date-time"},"checkInDate":{"type":["string","null"],"description":"The check-in date of the booked stay; `null` for an item that has no stay, such as a flight.","format":"date"}},"additionalProperties":false,"description":"A preview of cancelling an order item now. It changes nothing and does not lock the amounts."},"OrderItemRefund":{"required":["amount","status","updatedAt"],"type":"object","properties":{"status":{"enum":["pending","refunded","failed","processing"],"type":"string","description":"`pending`, `processing`, `refunded` or `failed`."},"amount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The recorded refund amount in its currency; settled only when `refunded`."},"updatedAt":{"type":"string","description":"When the refund was last updated (UTC).","format":"date-time"},"wallet":{"description":"The wallet the refund was returned to and the amount it received; `null` until money is\n            back in a wallet, and for a refund to a card.","anyOf":[{"$ref":"#/components/schemas/OrderRefundWallet"},{"type":"null"}]}},"additionalProperties":false,"description":"The recorded refund state, independent of whether another refund action is available."},"OrderItemRefundedWebhook":{"required":["data","eventId","eventType","timestamp"],"type":"object","properties":{"eventId":{"type":"string","format":"uuid"},"eventType":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"data":{"allOf":[{"$ref":"#/components/schemas/OrderItemRefundedWebhookData"}]},"isTest":{"type":"boolean","description":"True for a synthetic test delivery. Omitted on live events."}},"additionalProperties":false},"OrderItemRefundedWebhookData":{"required":["currencyCode","orderId","orderItemId","paymentMethod","publicId","reason","refundAmount","refundId","status"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"orderItemId":{"type":"string","format":"uuid"},"publicId":{"type":"string"},"refundId":{"type":"string","format":"uuid"},"refundAmount":{"type":"number","format":"decimal"},"currencyCode":{"type":"string"},"paymentMethod":{"enum":["balance","card"],"type":"string","description":"How a payment was made: `balance` from a wallet, or `card`."},"status":{"enum":["pending","refunded","failed","processing"],"type":"string"},"reason":{"enum":["requestedByCustomer","duplicate","fraudulent","fulfillmentFailed"],"type":"string"}},"additionalProperties":false},"OrderItemUpdateRequest":{"required":["inputs"],"type":"object","properties":{"inputs":{"oneOf":[{"$ref":"#/components/schemas/GiftCardUpdateInputs"}],"description":"Required. A JSON object with the members to change; the item's kind defines them. At launch only a\n            gift card can be updated, with `recipientEmail` and `giftMessage`. A member left out or sent as\n            `null` keeps its current value, and at least one member must be present. A member that the item's kind does not\n            define is `400 / 10001` with `UNSUPPORTED_FIELD` at `inputs.<member>`."}},"additionalProperties":false,"description":"The change to make to a purchased item. An update never charges or refunds anything."},"OrderList":{"required":["orders","pagination"],"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/OrderSummary"},"description":"The orders on this page."},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of the list."}},"additionalProperties":false,"description":"A page of orders, newest first."},"OrderOrigin":{"required":["channel"],"type":"object","properties":{"channel":{"enum":["api","dashboard","site"],"type":"string","description":"`api`, `dashboard` or `site` (placed through one of the partner's sites)."}},"additionalProperties":false,"description":"Where an order was created."},"OrderPayment":{"required":["amount","method","status"],"type":"object","properties":{"status":{"enum":["pending","completed","failed","partiallyRefunded","refunded","cancelled","authorized"],"type":"string","description":"`pending`; `authorized` (a traveller's card on your hosted site is held for the order\n            and is charged for what is delivered); `completed`; `failed`; `partiallyRefunded` (some items were\n            refunded); `refunded` (every item was refunded); or `cancelled` (the order ended without payment, or a\n            card hold was released with nothing charged)."},"method":{"enum":["balance","card"],"type":"string","description":"How the payment was made; `balance` for wallet payments, `card` for a card, including\n            a traveller's card on your hosted site."},"amount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The amount charged, in the order's currency."},"wallet":{"description":"The wallet charged by a balance payment, when known; otherwise `null`.","anyOf":[{"$ref":"#/components/schemas/OrderPaymentWallet"},{"type":"null"}]},"failure":{"description":"Why the payment failed; `null` unless it failed.","anyOf":[{"$ref":"#/components/schemas/PaymentFailure"},{"type":"null"}]}},"additionalProperties":false,"description":"A payment attempt."},"OrderPaymentWallet":{"required":["debited","label"],"type":"object","properties":{"label":{"type":"string","description":"The wallet's label."},"debited":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The amount taken, in the wallet's currency."}},"additionalProperties":false,"description":"The wallet a balance payment was taken from."},"OrderRefundWallet":{"required":["credited","label"],"type":"object","properties":{"label":{"type":"string","description":"The wallet's label."},"credited":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The amount added to the wallet, in the wallet's currency. It is the same share of what the\n            payment took from this wallet as the refund is of what it paid, so a full refund returns exactly what was\n            taken."}},"additionalProperties":false,"description":"The wallet a refund was returned to."},"OrderSummary":{"required":["createdAt","id","itemCount","origin","refunded","status","total","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Order id.","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderOrigin"}],"description":"Where the order was created."},"status":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"Current order status: `paymentPending`, `processing`, `completed`,\n            `partiallyFulfilled`, `fulfillmentFailed`, `partiallyRefunded`, `refunded` or `cancelled`."},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What was charged for the order, in the order's currency, before refunds."},"refunded":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What completed item refunds returned, in the order's currency; zero when nothing was\n            returned. You paid `total` minus `refunded`."},"payment":{"description":"The latest payment attempt; `null` when none was made.","anyOf":[{"$ref":"#/components/schemas/OrderPayment"},{"type":"null"}]},"itemCount":{"type":"integer","description":"Number of order items.","format":"int32"},"createdAt":{"type":"string","description":"When the order was created (UTC).","format":"date-time"},"updatedAt":{"type":"string","description":"When anything in the order last changed (UTC): its status, an item's fulfillment, a refund\n            or an amendment.","format":"date-time"},"referenceId":{"type":["string","null"],"description":"Your own order reference, when one was sent."}},"additionalProperties":false,"description":"One order in the order list."},"OrderTimelineEntry":{"required":["occurredAt","status"],"type":"object","properties":{"status":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"The order status."},"occurredAt":{"type":"string","description":"When the order entered it (UTC).","format":"date-time"}},"additionalProperties":false,"description":"A status the order entered. Each status appears once per stretch: `processing` at the time the\n            payment succeeded, `partiallyRefunded` or `refunded` at the time of the refund that caused it."},"Pagination":{"required":["currentCount","hasMore","limit","page","skip","totalCount","totalPages"],"type":"object","properties":{"currentCount":{"type":"integer","description":"Number of items on this page.","format":"int32"},"totalCount":{"type":"integer","description":"Number of items matching the filters, across all pages.","format":"int64"},"skip":{"type":"integer","description":"Number of items before this page.","format":"int32"},"limit":{"type":"integer","description":"Page size.","format":"int32"},"hasMore":{"type":"boolean","description":"Whether another page follows."},"page":{"type":"integer","description":"One-based page number.","format":"int32"},"totalPages":{"type":"integer","description":"Number of pages at this page size.","format":"int32"}},"additionalProperties":false,"description":"Paging of a list response."},"Passenger":{"required":["familyName","givenName","identityDocuments","passengerIndex","selectedSeats"],"type":"object","properties":{"passengerIndex":{"type":"integer","description":"The passenger's 1-based position in the fare's `offerPassengers`.","format":"int32"},"title":{"type":["string","null"],"description":"As sent, for example `mr`."},"givenName":{"type":"string","description":"As sent."},"familyName":{"type":"string","description":"As sent."},"gender":{"type":["string","null"],"description":"As sent, for example `m`."},"bornOn":{"type":["string","null"],"description":"Date of birth, as sent.","format":"date"},"email":{"type":["string","null"],"description":"Masked, for example `t***@example.com`; null when none was sent."},"phoneNumber":{"type":["string","null"],"description":"Masked, for example `+44***0123`; null when none was sent."},"identityDocuments":{"type":"array","items":{"$ref":"#/components/schemas/IdentityDocument"},"description":"The passenger's travel document, at most one; empty when none was given."},"selectedSeats":{"type":"array","items":{"$ref":"#/components/schemas/SelectedSeat"},"description":"The seats chosen for the passenger; empty when none was chosen."}},"additionalProperties":false,"description":"One passenger as booked. Names, title, gender and date of birth read as sent; `email` and\n`phoneNumber` are masked, and a document number shows only its last four characters."},"PassengerInput":{"required":["familyName","givenName","passengerIndex"],"type":"object","properties":{"passengerIndex":{"type":"integer","description":"1-based position in the fare's `details.offerPassengers`.","format":"int32"},"givenName":{"type":"string","description":"First name, as on the travel document."},"familyName":{"type":"string","description":"Last name, as on the travel document."},"title":{"type":["string","null"],"description":"Title, for example `mr`, `mrs` or `ms`."},"gender":{"type":["string","null"],"description":"Gender as on the travel document, for example `m` or `f`."},"bornOn":{"type":["string","null"],"description":"Date of birth (`yyyy-MM-dd`).","format":"date"},"email":{"type":["string","null"],"description":"Passenger's email address."},"phoneNumber":{"type":["string","null"],"description":"Passenger's phone number in international format, for example `+442080160509`."},"selectedSeats":{"type":"array","items":{"$ref":"#/components/schemas/SelectedSeatInput"},"description":"Seats from the seat map, at most one per segment."},"identityDocuments":{"type":"array","items":{"$ref":"#/components/schemas/IdentityDocumentInput"},"description":"The passenger's travel document, at most one. Required for every passenger when the offer's\n`identityDocumentsRequired` is true, and then the airline needs a passport; its `type` must be one of\nthe offer's `supportedDocumentTypes`."}},"additionalProperties":false},"PassengerPricing":{"required":["count","passengerType","pricePerPassenger"],"type":"object","properties":{"passengerType":{"enum":["adult","child","infantWithSeat","infantWithoutSeat"],"type":"string"},"count":{"type":"integer","format":"int32"},"pricePerPassenger":{"description":"The price of one passenger of this type, when the fare states it; otherwise null. Never an even share\n            of the total: use the fare's `price` for what the passengers cost together.","anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"priceBreakdown":{"description":"Base fare and taxes of `pricePerPassenger`; null when that is null or the fare gives no\n            split.","anyOf":[{"$ref":"#/components/schemas/PriceBreakdown"},{"type":"null"}]},"fareBasisCode":{"type":["string","null"]},"bookingClass":{"type":["string","null"]}},"additionalProperties":false},"PaymentFailure":{"required":["code","message","name"],"type":"object","properties":{"code":{"type":"integer","description":"Numeric code, `16000`.","format":"int32"},"name":{"type":"string","description":"Machine name, `PAYMENT_FAILED`."},"message":{"type":"string","description":"Safe human-readable message; do not branch on it."}},"additionalProperties":false,"description":"Why a payment failed. Part of a successful response, not an HTTP error."},"PaymentTerms":{"required":["dueNow","type"],"type":"object","properties":{"type":{"enum":["payNow","payAtProperty","deposit"],"type":"string","description":"`payNow`, `payAtProperty` or `deposit`."},"dueNow":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What the partner's wallet is charged at order."},"dueLater":{"description":"What the guest pays later, indicative; null for `payNow`.","anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"dueLaterAt":{"enum":["property"],"type":["string","null"],"description":"`property` when DueLater is set; otherwise null."}},"additionalProperties":false},"PriceBreakdown":{"type":"object","properties":{"base":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"tax":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]}},"additionalProperties":false},"PriceLine":{"required":["amount","category","description","quantity"],"type":"object","properties":{"description":{"type":"string"},"amount":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"quantity":{"type":"integer","format":"int32"},"serviceType":{"enum":["other","seat","baggage","meal"],"type":["string","null"]},"category":{"enum":["fare","taxes","selectedService","managedService","other"],"type":"string"}},"additionalProperties":false,"description":"One line of what the item cost; `amount` is the line's total in the order currency."},"PriceRange":{"required":["currency","max","min"],"type":"object","properties":{"min":{"type":"number","format":"decimal"},"max":{"type":["number","null"],"format":"decimal"},"currency":{"type":"string"}},"additionalProperties":false,"description":"Price bounds of a range offer; `max` is null when the value has no upper bound."},"QuotedRate":{"required":["amendabilityStatus","board","nightlyPrices","rateConditions","rateRules","rateTags","remarks","rooms","surcharges","withTransfers"],"type":"object","properties":{"rooms":{"type":"array","items":{"$ref":"#/components/schemas/Room"}},"board":{"allOf":[{"$ref":"#/components/schemas/MealPlan"}],"description":"The meal plan a rate is sold with. `boardType` is the value to branch or filter on;\n`code` is its short form (`RO`, `BB`, `HB`, `FB`, `AI`, or `OTHER`\nwhen the plan has no standard equivalent) and `name` the text to show."},"taxes":{"description":"The taxes already in the rate's price. A tax the guest pays at the hotel is not here: it is a surcharge with\n`includedInTotal: false` and `payableAt: property`.","anyOf":[{"$ref":"#/components/schemas/TaxBreakdown"},{"type":"null"}]},"priceIsBinding":{"type":["boolean","null"]},"nightlyPrices":{"type":"array","items":{"$ref":"#/components/schemas/NightlyPrice"}},"rateTags":{"type":"array","items":{"type":"string"}},"remarks":{"type":"array","items":{"type":"string"}},"rateConditions":{"type":"array","items":{"type":"string"}},"withTransfers":{"type":"boolean"},"rateRules":{"type":"array","items":{"enum":["unknown","nonRefundable","package"],"type":"string"}},"amendabilityStatus":{"enum":["unknown","yes","no"],"type":"string"},"surcharges":{"type":"array","items":{"$ref":"#/components/schemas/Surcharge"}},"minimumSellingPrice":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"allowsSpecialRequests":{"type":["boolean","null"]},"specialRequestOptions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpecialRequestOption"}}},"additionalProperties":false},"Room":{"required":["amenities","beds","imageUrls","name","roomIndex"],"type":"object","properties":{"roomGroupKey":{"type":["string","null"],"description":"Identifies the physical room across every rate that sells it, so rates can be grouped per\nroom. Null means the room could not be identified; group nothing on a null rather than treating it\nas a group."},"name":{"type":"string"},"description":{"type":["string","null"]},"beds":{"type":"array","items":{"$ref":"#/components/schemas/Bed"}},"maxOccupancy":{"type":["integer","null"],"format":"int32"},"sizeSquareMeters":{"type":["number","null"],"format":"decimal"},"amenities":{"type":"array","items":{"type":"string"}},"imageUrls":{"type":"array","items":{"type":"string"}},"roomIndex":{"type":"integer","description":"1-based room index (1 = first room, 2 = second room, and so on). Send the same index with each room's\nguests when ordering, so every room is matched to its occupancy in a multi-room booking.","format":"int32"},"adultsCount":{"type":["integer","null"],"description":"Number of adults for this specific room","format":"int32"},"childrenCount":{"type":["integer","null"],"description":"Number of children for this specific room","format":"int32"},"childrenAges":{"type":["array","null"],"items":{"type":"integer","format":"int32"},"description":"Ages of the children for the searched occupancy of this room."}},"additionalProperties":false,"description":"A room on a rate."},"RoomAmendmentCapabilities":{"required":["addMore","remove"],"type":"object","properties":{"addMore":{"type":"boolean"},"remove":{"type":"boolean"}},"additionalProperties":false,"description":"What may change about the rooms themselves. Adding a room is offered nowhere; removing one only where a single\nroom of a multi-room stay can be cancelled on its own (`roomRemovalOnly`)."},"RoomGuests":{"required":["guests","roomIndex"],"type":"object","properties":{"roomIndex":{"type":"integer","description":"1-based position of the room in the searched rooms.","format":"int32"},"guests":{"type":"array","items":{"$ref":"#/components/schemas/Guest"},"description":"Every guest staying in the room, adults and children, in the order they were sent."}},"additionalProperties":false,"description":"The guests of one room."},"RoomGuestsInput":{"required":["guests","roomIndex"],"type":"object","properties":{"roomIndex":{"type":"integer","description":"1-based position of the room in the search's `rooms`; each room appears once.","format":"int32"},"guests":{"type":"array","items":{"$ref":"#/components/schemas/GuestInput"},"description":"Every guest staying in the room, adults and children."}},"additionalProperties":false,"description":"The guests of one room."},"RoomOccupancy":{"required":["adults","children"],"type":"object","properties":{"adults":{"type":"integer","description":"Number of adults in the room","format":"int32"},"children":{"type":"integer","description":"Number of children in the room","format":"int32"},"childrenAges":{"type":["array","null"],"items":{"type":"integer","format":"int32"},"description":"Ages of the children used to select this rate"}},"additionalProperties":false,"description":"Simplified room occupancy for API responses"},"RoomOccupancyInput":{"type":"object","properties":{"adults":{"type":"integer","description":"Adults in the room, 1–9. Defaults to 2.","format":"int32"},"children":{"type":"integer","description":"Children in the room, 0–9. Defaults to 0.","format":"int32"},"childrenAges":{"type":["array","null"],"items":{"type":"integer","format":"int32"},"description":"One age (0–17) per child; omit or leave empty when there are no children. The guests named at booking must\nhave the same ages."}},"additionalProperties":false,"description":"Who stays in one room."},"SeatAvailability":{"required":["passengerIndex"],"type":"object","properties":{"passengerIndex":{"type":"integer","format":"int32"},"price":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]}},"additionalProperties":false},"SeatMap":{"required":["isSupported","segments","warnings"],"type":"object","properties":{"isSupported":{"type":"boolean"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/SeatMapSegment"}},"warnings":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"description":"Partner seat map. Segments name their position in the offer; seats are chosen by\nsliceIndex, segmentIndex, passengerIndex and seatDesignator."},"SeatMapElement":{"required":["availableFor","characteristics","isAvailable","type"],"type":"object","properties":{"type":{"type":"string"},"seatDesignator":{"type":["string","null"]},"label":{"type":["string","null"]},"isAvailable":{"type":"boolean"},"characteristics":{"type":"array","items":{"type":"string"}},"availableFor":{"type":"array","items":{"$ref":"#/components/schemas/SeatAvailability"},"description":"Passengers who can take this seat, with the price for each."}},"additionalProperties":false},"SeatMapRow":{"required":["number","sections"],"type":"object","properties":{"number":{"type":"integer","format":"int32"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/SeatMapSection"}}},"additionalProperties":false},"SeatMapSection":{"required":["elements"],"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/SeatMapElement"}}},"additionalProperties":false},"SeatMapSegment":{"required":["aisles","rows","segmentIndex","sliceIndex"],"type":"object","properties":{"sliceIndex":{"type":"integer","format":"int32"},"segmentIndex":{"type":"integer","format":"int32"},"cabinClass":{"enum":["economy","premiumEconomy","business","first"],"type":["string","null"]},"deck":{"type":["integer","null"],"format":"int32"},"aisles":{"type":"array","items":{"type":"integer","format":"int32"}},"rows":{"type":"array","items":{"$ref":"#/components/schemas/SeatMapRow"}}},"additionalProperties":false},"Segment":{"required":["arrivalAt","departureAt","destination","durationMinutes","isCodeshare","marketingCarrier","marketingFlightNumber","origin","stops"],"type":"object","properties":{"origin":{"allOf":[{"$ref":"#/components/schemas/Airport"}],"description":"Where the leg departs."},"destination":{"allOf":[{"$ref":"#/components/schemas/Airport"}],"description":"Where the leg lands."},"departureAt":{"type":"string","description":"When the leg departs, a UTC instant; `origin.timezone` gives the airport's clock.","format":"date-time"},"departureLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the departure airport (`origin.timezone`) at `departureAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `departureAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"arrivalAt":{"type":"string","description":"When the leg lands, a UTC instant; `destination.timezone` gives the airport's clock.","format":"date-time"},"arrivalLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the arrival airport (`destination.timezone`) at `arrivalAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `arrivalAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"durationMinutes":{"type":"integer","description":"Flying time of the leg.","format":"int32"},"marketingCarrier":{"allOf":[{"$ref":"#/components/schemas/Airline"}],"description":"The airline that sells the leg under its flight number."},"marketingFlightNumber":{"type":"string","description":"The marketing carrier's flight number."},"operatingCarrier":{"description":"The airline that flies the leg.","anyOf":[{"$ref":"#/components/schemas/Airline"},{"type":"null"}]},"operatingFlightNumber":{"type":["string","null"],"description":"The operating carrier's flight number."},"aircraft":{"description":"The aircraft type, when the airline gives it.","anyOf":[{"$ref":"#/components/schemas/Aircraft"},{"type":"null"}]},"stops":{"type":"array","items":{"$ref":"#/components/schemas/Stop"},"description":"Technical stops without a change of aircraft."},"isCodeshare":{"type":"boolean","description":"Whether another airline than the marketing carrier flies the leg."}},"additionalProperties":false,"description":"One leg of a slice: a single flight number from takeoff to landing."},"SegmentFare":{"required":["baggage","segmentIndex","sliceIndex"],"type":"object","properties":{"sliceIndex":{"type":"integer","format":"int32"},"segmentIndex":{"type":"integer","format":"int32"},"cabinClass":{"enum":["economy","premiumEconomy","business","first"],"type":["string","null"]},"baggage":{"type":"array","items":{"$ref":"#/components/schemas/Baggage"}}},"additionalProperties":false,"description":"A fare's cabin and baggage on one segment; slice and segment positions are 1-based."},"SegmentPosition":{"required":["segmentIndex","sliceIndex"],"type":"object","properties":{"sliceIndex":{"type":"integer","format":"int32"},"segmentIndex":{"type":"integer","format":"int32"}},"additionalProperties":false,"description":"1-based position of a segment in the offer: slices[sliceIndex - 1].segments[segmentIndex - 1]."},"SelectedSeat":{"required":["seatDesignator","segmentIndex","sliceIndex"],"type":"object","properties":{"sliceIndex":{"type":"integer","description":"The slice's position in `details.slices`.","format":"int32"},"segmentIndex":{"type":"integer","description":"The segment's position within the slice.","format":"int32"},"seatDesignator":{"type":"string","description":"The seat, for example `32A`."}},"additionalProperties":false,"description":"A seat chosen for a passenger, on the segment at these 1-based positions."},"SelectedSeatInput":{"required":["seatDesignator","segmentIndex","sliceIndex"],"type":"object","properties":{"sliceIndex":{"type":"integer","description":"1-based slice position of the segment, as in the seat map.","format":"int32"},"segmentIndex":{"type":"integer","description":"1-based segment position within the slice, as in the seat map.","format":"int32"},"seatDesignator":{"type":"string","description":"Seat as shown in the seat map, for example \"14B\"."}},"additionalProperties":false},"SelectedService":{"required":["label","quantity"],"type":"object","properties":{"type":{"enum":["other","seat","baggage","meal"],"type":["string","null"],"description":"The service type: `baggage`, `meal`, `seat` or `other`; null when unknown."},"label":{"type":"string","description":"What was bought, for example `1 × 23 kg`."},"passengerIndex":{"type":["integer","null"],"description":"The passenger the service is for; null when it is not tied to one passenger.","format":"int32"},"sliceIndex":{"type":["integer","null"],"description":"The slice of the segment the service is for; null when it is not tied to one segment.","format":"int32"},"segmentIndex":{"type":["integer","null"],"description":"The segment within that slice; null when it is not tied to one segment.","format":"int32"},"quantity":{"type":"integer","description":"Units bought.","format":"int32"}},"additionalProperties":false,"description":"A paid extra bought, with a label such as `1 × 23 kg`, `1 × checked bag` or `1 × meal`. Positions\nare 1-based, as in SelectedServiceInput."},"SelectedServiceInput":{"type":"object","properties":{"id":{"type":["string","null"],"description":"The service's `id` from the quote item's `details.availableServices`, valid until the offer expires; null\nwhen the service is chosen by `type`."},"type":{"enum":["other","seat","baggage","meal"],"type":["string","null"],"description":"The service type, for example `baggage` or `meal`; it chooses the service when no `id` is sent."},"passengerIndex":{"type":["integer","null"],"description":"1-based position of the passenger the service is for; null when it is not tied to one passenger. A request may\nleave it out when the service `id` names one passenger.","format":"int32"},"sliceIndex":{"type":["integer","null"],"description":"1-based position of the slice, with `segmentIndex`; null when the service is not tied to one segment.","format":"int32"},"segmentIndex":{"type":["integer","null"],"description":"1-based position of the segment within the slice, with `sliceIndex`; null when the service is not tied to\none segment.","format":"int32"},"quantity":{"type":"integer","description":"Units, greater than 0 and at most the service's `maxQuantity`; defaults to 1.","format":"int32"}},"additionalProperties":false},"SimCard":{"required":["iccid"],"type":"object","properties":{"iccid":{"type":"string","description":"The ICCID of the SIM card."},"lpaCode":{"type":["string","null"],"description":"Full LPA activation string in the format `LPA:1$smdpAddress$activationCode`. Scan it with the device camera to install."},"smdpAddress":{"type":["string","null"],"description":"SM-DP+ server address taken from the LPA code."},"activationCode":{"type":["string","null"],"description":"Activation code taken from the LPA code."},"qrCodeUrl":{"type":["string","null"],"description":"URL of a QR code image of the LPA code."},"pin":{"type":["string","null"],"description":"SIM PIN, when the network issues one."},"puk":{"type":["string","null"],"description":"SIM PUK, when the network issues one."},"number":{"type":["string","null"],"description":"Phone number assigned to this eSIM, when the plan includes one."},"iosQuickInstall":{"type":["string","null"],"description":"Deep-link URL for one-tap eSIM installation on iOS."},"androidQuickInstall":{"type":["string","null"],"description":"Deep-link URL for one-tap eSIM installation on Android."},"usage":{"description":"The base plan's usage last read, without top-ups; null until usage has first been read.","anyOf":[{"$ref":"#/components/schemas/EsimUsage"},{"type":"null"}]}},"additionalProperties":false,"description":"The eSIM's SIM card details: how to install it and its usage last read."},"Slice":{"required":["arrivalAt","departureAt","destination","durationMinutes","origin","segments","stops"],"type":"object","properties":{"origin":{"allOf":[{"$ref":"#/components/schemas/Airport"}],"description":"Where the slice departs."},"destination":{"allOf":[{"$ref":"#/components/schemas/Airport"}],"description":"Where the slice arrives."},"departureAt":{"type":"string","description":"When the slice departs, a UTC instant; `origin.timezone` gives the airport's clock.","format":"date-time"},"departureLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the departure airport (`origin.timezone`) at `departureAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `departureAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"arrivalAt":{"type":"string","description":"When the slice lands, a UTC instant; `destination.timezone` gives the airport's clock.","format":"date-time"},"arrivalLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the arrival airport (`destination.timezone`) at `arrivalAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `arrivalAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"durationMinutes":{"type":"integer","description":"Flying and connection time of the slice.","format":"int32"},"stops":{"type":"integer","description":"Connections on this slice.","format":"int32"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/Segment"},"description":"The legs flown, in order."}},"additionalProperties":false,"description":"One flight of the trip. Fare facts (cabin and baggage per segment, fare basis) are on each offer."},"SpecialRequestOption":{"required":["code","name"],"type":"object","properties":{"code":{"type":"string","description":"Opaque option code; pass back unchanged in inputs.specialRequestCodes."},"name":{"type":"string","description":"The request's display name."}},"additionalProperties":false,"description":"An optional request, subject to availability at check-in."},"Stop":{"required":["airport","arrivingAt","departingAt","durationMinutes"],"type":"object","properties":{"airport":{"allOf":[{"$ref":"#/components/schemas/Airport"}],"description":"The airport of the stop."},"arrivingAt":{"type":"string","description":"When the aircraft lands at the stop, a UTC instant; `airport.timezone` gives the airport's clock.","format":"date-time"},"arrivingLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the stop's airport (`airport.timezone`) at `arrivingAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `arrivingAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"departingAt":{"type":"string","description":"When the aircraft leaves the stop, a UTC instant; `airport.timezone` gives the airport's clock.","format":"date-time"},"departingLocalTime":{"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","type":["string","null"],"description":"The clock at the stop's airport (`airport.timezone`) at `departingAt`. Written yyyy-MM-ddTHH:mm:ss with no zone, for display only: compute and compare with `departingAt`. Null when the place's time zone is unknown.","examples":["2026-12-01T08:30:00"]},"durationMinutes":{"type":"integer","description":"How long the aircraft stays at the stop.","format":"int32"}},"additionalProperties":false,"description":"A technical stop within a leg, where the aircraft lands and leaves again."},"Surcharge":{"required":["description","includedInTotal","price","type"],"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"approxPrice":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"includedInTotal":{"type":"boolean"},"payableAt":{"enum":["property","booking"],"type":["string","null"]}},"additionalProperties":false,"description":"A fee outside the room rate, in the same shape on search, quote and the order item."},"Tax":{"required":["amount","name"],"type":"object","properties":{"name":{"type":"string","description":"The tax's name as stated, for example `VAT`."},"amount":{"type":"number","description":"The tax's amount, in `currency`.","format":"decimal"},"currency":{"type":["string","null"],"description":"ISO 4217 code of `amount`; null when it is the price's currency."},"includedInPrice":{"type":["boolean","null"],"description":"Always `true` in a rate's `taxes`: a tax not in the price is a surcharge."}},"additionalProperties":false,"description":"One tax in the rate's price."},"TaxBreakdown":{"required":["included","items"],"type":"object","properties":{"included":{"type":"boolean","description":"`true` when every tax stated for the rate is in its price; `false` when at least one is paid at the\nhotel, and is then listed in `surcharges`."},"totalTaxAmount":{"type":["number","null"],"description":"The total of the taxes in the price, in the price's currency. Never includes a tax paid at the hotel.","format":"decimal"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Tax"},"description":"The taxes in the price, one entry per tax. It may list only part of the total, or nothing."}},"additionalProperties":false,"description":"The taxes already in the rate's price. A tax the guest pays at the hotel is not here: it is a surcharge with\n`includedInTotal: false` and `payableAt: property`."},"TicketDocument":{"required":["type","uniqueIdentifier"],"type":"object","properties":{"type":{"enum":["electronicTicket","electronicMiscellaneousDocumentAssociated","electronicMiscellaneousDocumentStandalone","other"],"type":"string","description":"`electronicTicket`, `electronicMiscellaneousDocumentAssociated`,\n`electronicMiscellaneousDocumentStandalone` or `other`."},"uniqueIdentifier":{"type":"string","description":"The document's number."}},"additionalProperties":false,"description":"A document the airline issued for the booking and its number, for example an e-ticket number."},"UnitAvailability":{"required":["availableUnitCount","bookingRequiresUnitSelection"],"type":"object","properties":{"availableUnitCount":{"type":"integer","format":"int32"},"bookingRequiresUnitSelection":{"type":"boolean"}},"additionalProperties":false},"UtilityCatalogPage":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Biller"}},"nextCursor":{"type":["string","null"]}},"additionalProperties":false,"description":"A page of the partner catalog walk, ordered by biller ID. Continue with `nextCursor`, the same\nfilters and the same currency until it is null; a page may hold fewer items than the limit, even none."},"UtilityFulfillment":{"required":["status"],"type":"object","properties":{"status":{"enum":["pending","fulfilled","rejected"],"type":"string","description":"`pending`, `fulfilled` or `rejected`."},"result":{"oneOf":[{"$ref":"#/components/schemas/UtilityFulfillmentResult"},{"enum":[null],"type":["string","null"]}]},"failure":{"description":"Why delivery was rejected (`11001`, `FULFILLMENT_REJECTED`); set only when\n            `rejected`.","anyOf":[{"$ref":"#/components/schemas/FulfillmentFailure"},{"type":"null"}]},"progress":{"anyOf":[{"$ref":"#/components/schemas/FulfillmentProgress"},{"type":"null"}]}},"additionalProperties":false},"UtilityFulfillmentDetails":{"type":"object","properties":{"token":{"type":["string","null"]}},"additionalProperties":false,"description":"The prepaid token a token biller delivered, once the payment is ready. Null for direct-credit billers."},"UtilityFulfillmentResult":{"required":["details"],"type":"object","properties":{"deliveredValue":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"details":{"allOf":[{"$ref":"#/components/schemas/UtilityFulfillmentDetails"}],"description":"The prepaid token a token biller delivered, once the payment is ready. Null for direct-credit billers."}},"additionalProperties":false,"description":"What a fulfilled bill payment delivered. `deliveredValue` is the amount that reached\nthe customer, null until it is known; a later confirmation advances `fulfillmentVersion`. Order reads and the\n`order.fulfillment.updated` webhook carry the same result."},"UtilityFulfillmentUpdate":{"required":["fulfillment","id","productType"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"productType":{"enum":["utility"],"type":"string"},"fulfillment":{"$ref":"#/components/schemas/UtilityFulfillment"}},"additionalProperties":false},"UtilityInputs":{"type":"object","properties":{"accountNumber":{"type":["string","null"],"description":"The customer's account or meter number with the biller."},"mobileNumber":{"type":["string","null"],"description":"The customer's mobile number with the biller, in international format starting with + or 00."},"beneficiaryMobileNumber":{"type":["string","null"],"description":"The beneficiary's mobile number, in international format starting with + or 00."},"invoiceId":{"type":["string","null"],"description":"The ID of the bill to pay, at most 64 characters, for an offer that lists it."},"value":{"description":"Required for a range offer, within its min and max and on its step; optional for a fixed offer, where it must equal the offer's amount; in the offer's value currency.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]},"maxPrice":{"description":"Optional highest accepted unit price, in the order or cart currency; a higher current unit price gives 409 / 11002.","anyOf":[{"$ref":"#/components/schemas/MoneyInput"},{"type":"null"}]}},"additionalProperties":false,"description":"A utility item's `inputs`: the inputs the offer's `requiredInputs` list, plus the standard purchase fields\n`value` and `maxPrice`. The offer public ID names the package or amount."},"UtilityMixedOrderRequestItem":{"required":["publicId","productType"],"type":"object","properties":{"publicId":{"type":"string","description":"Required. The offer's `publicId` from the product's search, item or quote response. An unknown,\nexpired or other-product value is rejected with code `11004` at `items[i]`."},"quantity":{"type":"integer","description":"Number of units, at least 1 (default 1). Each unit becomes its own order item; an order has at most five\nunits in total. A product may allow fewer.","format":"int32"},"productType":{"enum":["utility"],"type":"string"},"inputs":{"$ref":"#/components/schemas/UtilityInputs"}},"additionalProperties":false},"UtilityMixedQuoteItem":{"required":["details","name","price","publicId","quantity","value","productType"],"type":"object","properties":{"productType":{"enum":["utility"],"type":"string"},"publicId":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"name":{"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"details":{"allOf":[{"$ref":"#/components/schemas/UtilityQuoteItemDetails"}],"description":"Quoted item facts outside the quote item keys every partner service shares."}},"additionalProperties":false},"UtilityOffer":{"required":["name","price","publicId","requiredInputs","value"],"type":"object","properties":{"publicId":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"value":{"$ref":"#/components/schemas/OfferValue"},"price":{"$ref":"#/components/schemas/OfferPrice"},"requiredInputs":{"type":"array","items":{"$ref":"#/components/schemas/InputField"}}},"additionalProperties":false,"description":"One orderable offer of a biller: a fixed amount or a range of amounts. `publicId` is the\nidentifier quote and order take. `price` is indicative and in the requested price currency."},"UtilityOrder":{"required":["createdAt","fulfillmentVersion","id","items","origin","refunded","status","timeline","total","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Order id.","format":"uuid"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderOrigin"}],"description":"Where the order was created."},"status":{"enum":["paymentPending","processing","completed","partiallyFulfilled","fulfillmentFailed","partiallyRefunded","refunded","cancelled"],"type":"string","description":"Current order status: `paymentPending`, `processing`, `completed`,\n            `partiallyFulfilled`, `fulfillmentFailed`, `partiallyRefunded`, `refunded` or `cancelled`."},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What was charged for the order, in the order's currency, before refunds: the item prices plus\n            completed amendment charges, less completed amendment credits."},"refunded":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What completed item refunds returned, in the order's currency; zero when nothing was\n            returned. You paid `total` minus `refunded`, the sum of the items' `effectivePaidAmount`."},"payment":{"description":"The latest payment attempt; `null` when none was made.","anyOf":[{"$ref":"#/components/schemas/OrderPayment"},{"type":"null"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/UtilityOrderItem"},"description":"The order items, one per unit bought."},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/OrderTimelineEntry"},"description":"Every status the order has had, oldest first, each once per stretch."},"createdAt":{"type":"string","description":"When the order was created (UTC).","format":"date-time"},"updatedAt":{"type":"string","description":"When anything in the order last changed (UTC): its status, an item's fulfillment, a refund\n            or an amendment.","format":"date-time"},"fulfillmentVersion":{"type":"integer","description":"Increases with every fulfillment change; matches the\n            `order.fulfillment.updated` webhook.","format":"int64"},"referenceId":{"type":["string","null"],"description":"Your own order reference, when one was sent."},"customer":{"description":"The traveller who paid on your hosted site, masked; `null` unless the origin is `site`, and\n            once the traveller's details are deleted at the end of their retention period.","anyOf":[{"$ref":"#/components/schemas/OrderCustomer"},{"type":"null"}]}},"additionalProperties":false,"description":"The current state of an order."},"UtilityOrderItem":{"required":["actions","createdAt","effectivePaidAmount","fulfillment","id","orderId","price","productType","purchasedProduct"],"type":"object","properties":{"id":{"type":"string","description":"Order item id, used by the order-item endpoints. It is not the offer's `publicId`.","format":"uuid"},"orderId":{"type":"string","description":"The order the item belongs to.","format":"uuid"},"productType":{"enum":["utility"],"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The price paid for the item at purchase, in the order's currency."},"purchasedProduct":{"$ref":"#/components/schemas/UtilityPurchasedProduct"},"fulfillment":{"$ref":"#/components/schemas/UtilityFulfillment"},"actions":{"allOf":[{"$ref":"#/components/schemas/OrderItemActions"}],"description":"Whether the item can be amended or cancelled now."},"createdAt":{"type":"string","description":"When the item was created (UTC).","format":"date-time"},"effectivePaidAmount":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"What you have paid for the item, net of every amount returned: `price` plus\n            completed amendment charges, less completed amendment credits and less the completed `refund`."},"refund":{"description":"The recorded refund, or `null` when no refund has been started.","anyOf":[{"$ref":"#/components/schemas/OrderItemRefund"},{"type":"null"}]}},"additionalProperties":false},"UtilityOrderRequest":{"required":["items"],"type":"object","properties":{"currency":{"type":["string","null"],"description":"Order currency, the currency you are charged in, three letters in either case; the API key's currency when\nomitted. An unsupported code gives 400 / 10001 at `currency`, reason `NOT_SUPPORTED`, before any\nitem is checked."},"referenceId":{"type":["string","null"],"description":"Optional partner order reference, unique per partner, at most 128 characters without leading or trailing\nspaces. A quote validates it and ignores it."},"items":{"type":"array","items":{"$ref":"#/components/schemas/UtilityOrderRequestItem"},"description":"1 to 5 items, each paying one bill."}},"additionalProperties":false,"description":"The body B2B utility quote and order both take."},"UtilityOrderRequestItem":{"required":["publicId"],"type":"object","properties":{"publicId":{"type":"string","description":"Offer public ID from search, the one-biller route or the catalog; a biller's own ID is not one."},"quantity":{"type":"integer","description":"Always 1: one bill payment per item.","format":"int32"},"inputs":{"description":"The inputs the offer's `requiredInputs` list, plus `value` and `maxPrice`. May be omitted only when\nthe offer lists no inputs and is not a range.","anyOf":[{"$ref":"#/components/schemas/UtilityInputs"},{"type":"null"}]}},"additionalProperties":false,"description":"One item of a utility quote or order request."},"UtilityPurchasedDetails":{"required":["deliveryType","serviceType"],"type":"object","properties":{"serviceType":{"enum":["prepaid","postpaid"],"type":"string"},"deliveryType":{"enum":["unknown","token","directCredit"],"type":"string"}},"additionalProperties":false,"description":"Biller facts outside the purchased-product keys every partner service shares, as captured when the item was added.\n`deliveryType` is `unknown` for items added before it was captured."},"UtilityPurchasedInputs":{"type":"object","properties":{"accountNumber":{"type":["string","null"]},"mobileNumber":{"type":["string","null"]},"beneficiaryMobileNumber":{"type":["string","null"]},"invoiceId":{"type":["string","null"]}},"additionalProperties":false,"description":"The item's `inputs` under the request's keys, each masked: `mobileNumber` and\n`beneficiaryMobileNumber` as phone numbers, `accountNumber` and `invoiceId`\n(the biller's reference of the bill) as identifiers. An input is echoed only when the item stored it."},"UtilityPurchasedProduct":{"required":["countryCode","details","inputs","name","value"],"type":"object","properties":{"name":{"type":"string"},"countryCode":{"type":"string"},"logoUrl":{"type":["string","null"]},"value":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"inputs":{"allOf":[{"$ref":"#/components/schemas/UtilityPurchasedInputs"}],"description":"The item's `inputs` under the request's keys, each masked: `mobileNumber` and\n`beneficiaryMobileNumber` as phone numbers, `accountNumber` and `invoiceId`\n(the biller's reference of the bill) as identifiers. An input is echoed only when the item stored it."},"details":{"allOf":[{"$ref":"#/components/schemas/UtilityPurchasedDetails"}],"description":"Biller facts outside the purchased-product keys every partner service shares, as captured when the item was added.\n`deliveryType` is `unknown` for items added before it was captured."}},"additionalProperties":false,"description":"The bill payment an order item bought. `name` is the name its quote gave it: a stored package's label,\notherwise the biller at the purchased value. `value` is the requested amount in the biller's\ncurrency, and `inputs` echoes the item's inputs with customer identifiers masked. `logoUrl`\nis always null, because the purchase keeps no logo; read it from the biller."},"UtilityQuote":{"required":["currency","items","total"],"type":"object","properties":{"currency":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/UtilityQuoteItem"}},"total":{"allOf":[{"$ref":"#/components/schemas/Money"}]}},"additionalProperties":false,"description":"Current prices for the requested items, in request order. `total` is the sum of each item's unit price\ntimes its quantity. A quote reserves nothing and does not expire."},"UtilityQuoteItem":{"required":["details","name","price","publicId","quantity","value"],"type":"object","properties":{"publicId":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"name":{"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"price":{"allOf":[{"$ref":"#/components/schemas/Money"}]},"details":{"allOf":[{"$ref":"#/components/schemas/UtilityQuoteItemDetails"}],"description":"Quoted item facts outside the quote item keys every partner service shares."}},"additionalProperties":false,"description":"One quoted item: the offer, the value it pays and its current unit price in the quote currency."},"UtilityQuoteItemDetails":{"required":["deliveryType"],"type":"object","properties":{"deliveryType":{"enum":["unknown","token","directCredit"],"type":"string"}},"additionalProperties":false,"description":"Quoted item facts outside the quote item keys every partner service shares."},"UtilitySearchResult":{"required":["items","pagination"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Biller"}},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of a list response."}},"additionalProperties":false,"description":"A page of billers; `pagination.totalCount` counts billers that still have an offer after filtering."},"ValueRange":{"required":["currency","max","min","step","type"],"type":"object","properties":{"min":{"type":"number","format":"decimal"},"max":{"type":["number","null"],"format":"decimal"},"step":{"type":"number","description":"The product's own increment, or, when it sets none, the smallest unit of `Currency`\n(`CurrencyMinorUnitHelper.SmallestUnit`): 0.01 in most currencies, 1 in yen, 0.001 in dinars.","format":"decimal"},"currency":{"type":"string"},"type":{"enum":["range"],"type":"string"}},"additionalProperties":false,"description":"Any amount from `min` to `max` that satisfies\n`(amount - Min) % Step == 0`. A null `max` means there is no upper bound."},"Wallet":{"required":["balance","createdAt","currency","id","isSelected","label","percentageDifference","totalCredits","totalDebits","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"Wallet id.","format":"uuid"},"label":{"type":"string","description":"Display name."},"balance":{"type":"number","description":"Available balance, in the wallet's currency.","format":"decimal"},"lowBalanceThreshold":{"type":["number","null"],"description":"Low-balance threshold for the `partner.balance.low` webhook; `null`\n            when not set.","format":"decimal"},"isSelected":{"type":"boolean","description":"Whether this is the selected wallet that pays for orders."},"currency":{"allOf":[{"$ref":"#/components/schemas/Currency"}],"description":"The wallet's currency."},"createdAt":{"type":"string","description":"When the wallet was created (UTC).","format":"date-time"},"updatedAt":{"type":"string","description":"When the wallet last changed (UTC).","format":"date-time"},"totalDebits":{"type":"number","description":"Total of completed `debit` transactions: funds taken from the wallet.","format":"decimal"},"totalCredits":{"type":"number","description":"Total of completed `credit` transactions: funds added to the wallet.","format":"decimal"},"percentageDifference":{"type":"number","description":"`totalDebits` as a percentage of `totalCredits`, or 0 when nothing\n            was added.","format":"decimal"}},"additionalProperties":false,"description":"A partner wallet with totals of its completed transactions."},"WalletCreateRequest":{"type":"object","properties":{"currencyId":{"type":"string","description":"Required. The currency's `id` from `GET currencies`.","format":"uuid"},"isSelected":{"type":"boolean","description":"Whether the new wallet becomes the selected wallet that pays for orders. The partner's\n            first wallet is always selected."},"label":{"type":["string","null"],"description":"Display name, unique among the partner's wallets ignoring case. Defaults to the currency\n            code followed by `wallet`, for example `USD wallet`."},"lowBalanceThreshold":{"type":["number","null"],"description":"Optional low-balance threshold in the wallet's currency. When it is above\n            zero, the `partner.balance.low` webhook reports the balance falling toward and below it.","format":"decimal"}},"additionalProperties":false,"description":"A new wallet in a currency the partner has no wallet in yet."},"WalletSummary":{"required":["balance","currency","id","isSelected","label"],"type":"object","properties":{"id":{"type":"string","description":"Wallet id.","format":"uuid"},"label":{"type":"string","description":"Display name."},"balance":{"type":"number","description":"Available balance, in the wallet's currency.","format":"decimal"},"isSelected":{"type":"boolean","description":"Whether this is the selected wallet that pays for orders."},"currency":{"allOf":[{"$ref":"#/components/schemas/Currency"}],"description":"The wallet's currency."}},"additionalProperties":false,"description":"A partner wallet."},"WalletTransaction":{"required":["amount","currency","date","description","id","originalAmount","originalCurrency","source","type"],"type":"object","properties":{"id":{"type":"string","description":"Transaction id.","format":"uuid"},"type":{"enum":["debit","credit"],"type":"string","description":"`debit` takes funds from the wallet, such as an order payment; `credit` adds funds to\n            it, such as a top-up or a refund."},"source":{"enum":["topUp","payOut","order","exchange","reversal"],"type":"string","description":"Why the transaction was made, such as `order`, `topUp` or `exchange`."},"amount":{"type":"number","description":"The amount, in the wallet's currency.","format":"decimal"},"currency":{"type":"string","description":"The wallet's currency."},"description":{"type":"string","description":"What the transaction was for, such as `Wallet top-up` or\n            `Order payment for order {orderId}`."},"orderId":{"type":["string","null"],"description":"The order the transaction belongs to, such as its payment or a refund for it; `null`\n            when it belongs to no order.","format":"uuid"},"originalAmount":{"type":"number","description":"The amount before conversion, in `originalCurrency`.","format":"decimal"},"originalCurrency":{"type":"string","description":"The currency the amount was given in."},"conversionRate":{"type":["number","null"],"description":"The rate applied when the currencies differ.","format":"decimal"},"date":{"type":"string","description":"When the transaction was made (UTC).","format":"date-time"}},"additionalProperties":false,"description":"One wallet transaction."},"WalletTransactionList":{"required":["pagination","transactions"],"type":"object","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/WalletTransaction"},"description":"The transactions on this page."},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Paging of the list."}},"additionalProperties":false,"description":"A page of a wallet's transactions, newest first."},"WalletTransfer":{"required":["receivedAmount","receivedCurrency","sentAmount","sentCurrency","transferDate","transferId"],"type":"object","properties":{"transferId":{"type":"string","description":"Transfer id.","format":"uuid"},"sentAmount":{"type":"number","description":"The amount taken from the source wallet.","format":"decimal"},"sentCurrency":{"type":"string","description":"The source wallet's currency."},"receivedAmount":{"type":"number","description":"The amount added to the destination wallet.","format":"decimal"},"receivedCurrency":{"type":"string","description":"The destination wallet's currency."},"conversionRate":{"type":["number","null"],"description":"Destination currency units per source currency unit.","format":"decimal"},"transferDate":{"type":"string","description":"When the transfer was made (UTC).","format":"date-time"}},"additionalProperties":false,"description":"A completed transfer between two wallets."},"WalletTransferRequest":{"required":["amount","fromWalletId","toWalletId"],"type":"object","properties":{"fromWalletId":{"type":"string","description":"Required. The wallet the funds leave.","format":"uuid"},"toWalletId":{"type":"string","description":"Required. The wallet the funds arrive in; it must differ from the source.","format":"uuid"},"amount":{"type":"number","description":"Required. Amount above zero, in the source wallet's currency, rounded to two\n            decimals.","format":"decimal"}},"additionalProperties":false,"description":"A transfer between two of the partner's wallets."},"WalletUpdateRequest":{"type":"object","properties":{"label":{"type":["string","null"],"description":"New display name, unique among the partner's wallets ignoring case. Leave it out to keep the\n            current label; it cannot be `null` or blank."},"lowBalanceThreshold":{"type":["number","null"],"description":"New low-balance threshold in the wallet's currency, with at most that currency's ISO 4217 decimals\n            (`INVALID_VALUE` at `lowBalanceThreshold` otherwise, whose `message` names the decimals\n            allowed, such as `An amount in JPY cannot have decimals.`). When it is above zero, the\n            `partner.balance.low` webhook reports the balance falling toward and below it. Leave it out to keep\n            the current threshold; send `null` to clear it.","format":"decimal"}},"additionalProperties":false,"description":"The changes to a wallet. A member left out keeps its value; send at least one member. The wallet id\n            comes from the route only."}},"securitySchemes":{"PartnerApiKey":{"type":"apiKey","description":"Partner API Key (X-Partner-Key)","name":"X-Partner-Key","in":"header"}}},"security":[{"PartnerApiKey":[]}],"tags":[{"name":"Account","description":"The partner's account: which services it may sell."},{"name":"Airtime","description":"Mobile airtime top-ups: find the operator of a phone number by carrier lookup (detected flow) or let the customer\nchoose it (manual flow), then quote and order a fixed or range top-up for that number."},{"name":"Common","description":"Reference data shared by every service: countries and territories, and mobile network codes."},{"name":"Currencies","description":"The currencies OpenRoam prices, charges and holds wallets in, with their current USD rates."},{"name":"Esims","description":"Travel eSIM data plans: find plans for a country, region or the whole world, quote and order new eSIMs or top-ups,\nthen install, provision and monitor each eSIM by its ICCID."},{"name":"Flights","description":"Flights: search airline offers, quote an offer with its fare options, seats and extra baggage, and book it, paid\nfrom your wallet balance."},{"name":"GiftCards","description":"Digital gift cards: find a brand's card by country, category or name, then quote and order fixed or range card\nvalues, delivered as codes and optionally emailed to the recipient as a gift."},{"name":"HotelManualAmendments","description":"Hotel manual amendments: request a change to a confirmed hotel booking that is handled by our operations team,\nthen approve or decline the price they quote. Money moves only when you approve."},{"name":"Hotels","description":"Hotels: search live availability and rates, quote a selected rate and book it, paid from your wallet balance.\nAlso finds the places to search in, and serves one hotel's content, the amenity catalog and downloadable hotel\ncontent files."},{"name":"OrderItems","description":"Act on a single purchased item: read it, preview its cancellation, cancel it, update it, and quote, confirm and\nlist amendments. The item id is `items[].id` from the order response."},{"name":"Orders","description":"Place orders for any product, read them and track their payment and fulfillment. Orders are paid from the\npartner's selected wallet; reads need the `read` order permission and changes the `manage` permission."},{"name":"Utility","description":"Utility bill payments: find a biller (electricity, water, TV, internet and more) in a country, then quote and pay a\nfixed or range amount to the customer's account with it."},{"name":"Wallets","description":"Manage the partner's prepaid wallets, one per currency: create and rename them, choose the selected wallet\nthat pays for orders, move funds between them and read their transactions."}],"webhooks":{"order.fulfillment.updated":{"post":{"operationId":"webhooksOrderFulfillmentUpdated","summary":"The delivery of an order's items changed: delivered, rejected, or a delivered result was revised.","description":"Delivered at least once to your webhook URL. Acknowledge with any `2xx` response. A signed body with `isTest: true` contains synthetic data and should be handled as a connectivity check.","security":[],"parameters":[{"name":"X-OpenRoam-Webhook-Id","in":"header","required":true,"description":"The id of the webhook subscription that delivers the event.","schema":{"type":"string"}},{"name":"X-OpenRoam-Timestamp","in":"header","required":true,"description":"When this delivery attempt was signed, in Unix seconds.","schema":{"type":"string"}},{"name":"X-OpenRoam-Event-Id","in":"header","required":true,"description":"The event's unique id, the same as `eventId` in the body. Deduplicate on it.","schema":{"type":"string"}},{"name":"X-OpenRoam-Signature","in":"header","required":true,"description":"Lowercase hex HMAC-SHA256 of `{timestamp}.{eventId}.{raw body}`, keyed with your webhook secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderFulfillmentWebhook"}}}},"responses":{"200":{"description":"The event was accepted."}}}},"esim.profileStatus.updated":{"post":{"operationId":"webhooksEsimProfileStatusUpdated","summary":"The profile status of an eSIM changed.","description":"Delivered at least once to your webhook URL. Acknowledge with any `2xx` response. A signed body with `isTest: true` contains synthetic data and should be handled as a connectivity check.","security":[],"parameters":[{"name":"X-OpenRoam-Webhook-Id","in":"header","required":true,"description":"The id of the webhook subscription that delivers the event.","schema":{"type":"string"}},{"name":"X-OpenRoam-Timestamp","in":"header","required":true,"description":"When this delivery attempt was signed, in Unix seconds.","schema":{"type":"string"}},{"name":"X-OpenRoam-Event-Id","in":"header","required":true,"description":"The event's unique id, the same as `eventId` in the body. Deduplicate on it.","schema":{"type":"string"}},{"name":"X-OpenRoam-Signature","in":"header","required":true,"description":"Lowercase hex HMAC-SHA256 of `{timestamp}.{eventId}.{raw body}`, keyed with your webhook secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsimProfileStatusWebhook"}}}},"responses":{"200":{"description":"The event was accepted."}}}},"esim.usage.updated":{"post":{"operationId":"webhooksEsimUsageUpdated","summary":"The data or expiry usage of an eSIM reached a new band.","description":"Delivered at least once to your webhook URL. Acknowledge with any `2xx` response. A signed body with `isTest: true` contains synthetic data and should be handled as a connectivity check.","security":[],"parameters":[{"name":"X-OpenRoam-Webhook-Id","in":"header","required":true,"description":"The id of the webhook subscription that delivers the event.","schema":{"type":"string"}},{"name":"X-OpenRoam-Timestamp","in":"header","required":true,"description":"When this delivery attempt was signed, in Unix seconds.","schema":{"type":"string"}},{"name":"X-OpenRoam-Event-Id","in":"header","required":true,"description":"The event's unique id, the same as `eventId` in the body. Deduplicate on it.","schema":{"type":"string"}},{"name":"X-OpenRoam-Signature","in":"header","required":true,"description":"Lowercase hex HMAC-SHA256 of `{timestamp}.{eventId}.{raw body}`, keyed with your webhook secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsimUsageWebhook"}}}},"responses":{"200":{"description":"The event was accepted."}}}},"partner.balance.low":{"post":{"operationId":"webhooksPartnerBalanceLow","summary":"A wallet balance fell to a lower low-balance threshold band.","description":"Delivered at least once to your webhook URL. Acknowledge with any `2xx` response. A signed body with `isTest: true` contains synthetic data and should be handled as a connectivity check.","security":[],"parameters":[{"name":"X-OpenRoam-Webhook-Id","in":"header","required":true,"description":"The id of the webhook subscription that delivers the event.","schema":{"type":"string"}},{"name":"X-OpenRoam-Timestamp","in":"header","required":true,"description":"When this delivery attempt was signed, in Unix seconds.","schema":{"type":"string"}},{"name":"X-OpenRoam-Event-Id","in":"header","required":true,"description":"The event's unique id, the same as `eventId` in the body. Deduplicate on it.","schema":{"type":"string"}},{"name":"X-OpenRoam-Signature","in":"header","required":true,"description":"Lowercase hex HMAC-SHA256 of `{timestamp}.{eventId}.{raw body}`, keyed with your webhook secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceLowWebhook"}}}},"responses":{"200":{"description":"The event was accepted."}}}},"order-item.refunded":{"post":{"operationId":"webhooksOrderItemRefunded","summary":"A refund of an order item progressed or finished.","description":"Delivered at least once to your webhook URL. Acknowledge with any `2xx` response. A signed body with `isTest: true` contains synthetic data and should be handled as a connectivity check.","security":[],"parameters":[{"name":"X-OpenRoam-Webhook-Id","in":"header","required":true,"description":"The id of the webhook subscription that delivers the event.","schema":{"type":"string"}},{"name":"X-OpenRoam-Timestamp","in":"header","required":true,"description":"When this delivery attempt was signed, in Unix seconds.","schema":{"type":"string"}},{"name":"X-OpenRoam-Event-Id","in":"header","required":true,"description":"The event's unique id, the same as `eventId` in the body. Deduplicate on it.","schema":{"type":"string"}},{"name":"X-OpenRoam-Signature","in":"header","required":true,"description":"Lowercase hex HMAC-SHA256 of `{timestamp}.{eventId}.{raw body}`, keyed with your webhook secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderItemRefundedWebhook"}}}},"responses":{"200":{"description":"The event was accepted."}}}},"order-item.manual-amendment.status":{"post":{"operationId":"webhooksOrderItemManualAmendmentStatus","summary":"A manual amendment request progressed, or needs your action.","description":"Delivered at least once to your webhook URL. Acknowledge with any `2xx` response. A signed body with `isTest: true` contains synthetic data and should be handled as a connectivity check.","security":[],"parameters":[{"name":"X-OpenRoam-Webhook-Id","in":"header","required":true,"description":"The id of the webhook subscription that delivers the event.","schema":{"type":"string"}},{"name":"X-OpenRoam-Timestamp","in":"header","required":true,"description":"When this delivery attempt was signed, in Unix seconds.","schema":{"type":"string"}},{"name":"X-OpenRoam-Event-Id","in":"header","required":true,"description":"The event's unique id, the same as `eventId` in the body. Deduplicate on it.","schema":{"type":"string"}},{"name":"X-OpenRoam-Signature","in":"header","required":true,"description":"Lowercase hex HMAC-SHA256 of `{timestamp}.{eventId}.{raw body}`, keyed with your webhook secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManualAmendmentStatusWebhook"}}}},"responses":{"200":{"description":"The event was accepted."}}}}}}