Retrieve orders
Make one of the following requests:
-
GET /v2/orders?referenceId=<referenceId>
-
GET /v2/orders?guestRef=<guestRef>
Retrieves a list of orders. You must include either the referenceId
of the order or the guestRef
as a query string parameter in the URI of the request.
Parameter name |
Type |
Description |
Example |
---|---|---|---|
|
string |
A unique ID generated by your organization to reference the order. For flight orders, this is often the PNR. |
|
|
string |
The reference of the guest record. If you do not know the guest reference, first retrieve guests. |
|
In the response, in items.href
, the order reference is the string that follows the final slash:
"href": "<baseURL>/v2/orders/<orderRef>"
You use the order reference to interact with a specific order, for example, to retrieve or update it.
Retrieving orders using referenceId
:
curl -X GET '<baseURL>/v2/orders?referenceId=2d7de9df-45a2-45ea-872c-30e45139007d' \
-u '<username>:<password>' \
-H 'Accept: application/json'
Retrieving orders using guestRef
:
curl -X GET '<baseURL>/v2/orders?guestRef=f7aabbca-1c1b-4fc2-be72-3e16294a4f03' \
-u '<username>:<password>' \
-H 'Accept: application/json'
{
"href": "<baseURL>/v2/orders?offset=0&limit=10&guestRef=f7aabbca-1c1b-4fc2-be72-3e16294a4f03",
"offset": 0,
"limit": 10,
"first": {
"href": "<baseURL>/v2/orders?offset=0&limit=10&guestRef=f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
},
"last": {
"href": "<baseURL>/v2/orders?offset=0&limit=10&guestRef=f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
},
"items": [
{
"href": "<baseURL>/v2/orders/d680c9be-4c07-4731-857e-9602034b15f2"
},
{
"href": "<baseURL>/v2/orders/9932bee2-25c2-4653-9ad3-8865865036d9"
},
{
"href": "<baseURL>/v2/orders/4b8eeee6-37f1-41ad-92fb-79e802db29a7"
}
]
}