Retrieve an order (legacy)

Important

A newer version of this REST API (v2.1) is available. If you're new to this REST API, use the new version. Alternatively, if you're already using the old version, read about the differences between v2 and v2.1 so you can upgrade.

GET /v2/orders/<orderRef>

Retrieves an order.

Attribute	Type	Description	Example
`orderRef`	string	The reference of the order. If you do not know the order reference, first retrieve orders.	`d680c9be-4c07-4731-857e-9602034b15f2`

Attribute

Type

Description

Example

orderRef

string

The reference of the order.

If you do not know the order reference, first retrieve orders.

d680c9be-4c07-4731-857e-9602034b15f2

Retrieving an order:

RequestResponse

curl -X GET '<baseURL>/v2/orders/d680c9be-4c07-4731-857e-9602034b15f2' \
-u '<username>:<password>' \
-H 'Accept: application/json'

Using expand to retrieve orderItems of an order:

RequestResponse

curl -X GET '<baseURL>/v2/orders/d680c9be-4c07-4731-857e-9602034b15f2?expand=orderItems' \
-u '<username>:<password>' \
-H 'Accept: application/json'

RequestResponse

{
    "href":"<baseURL>/v2/orders/d680c9be-4c07-4731-857e-9602034b15f2?expand=orderItems",
    "ref":"d680c9be-4c07-4731-857e-9602034b15f2",
    "createdAt":"2025-08-15T16:00:55.554Z",
    "modifiedAt":"2025-08-21T16:00:51.882Z",
    "orderedAt":"2025-08-15T16:00:55.554Z",
    "price": 100.00,
    "currencyCode":"EUR",
    "referenceId": "B94TXY",
    "paymentType": "Card",
    "cardType": "Visa",
    "pointOfSale": "default",
    "channel": "WEB",
    "status": "PURCHASED",
    "contacts":{
        "href":"<baseURL>/v2/orders/d680c9be-4c07-4731-857e-9602034b15f2/contacts"
    },
    "consumers":{
        "href":"<baseURL>/v2/orders/d680c9be-4c07-4731-857e-9602034b15f2/consumers"
    },
    "orderItems":{
        "href":"<baseURL>/v2/orders/d680c9be-4c07-4731-857e-9602034b15f2/orderItems",
        "offset":0,
        "limit":10,
        "items":[
            {
                "href":"<baseURL>/v2/orderItems/d680c9be-4c07-4731-857e-9602034b15f2",
                "ref":"FECBB7ED-6DFE-4E8C-85A9-B894B17EF4F3",
                "createdAt":"2025-08-15T16:00:55.554Z",
                "modifiedAt":"2025-08-21T16:00:51.882Z",
                "type":"FLIGHT",
                "quantity":1,
                "productId":"DUB-LHR",
                "price":100.00,
                "currencyCode":"EUR",
                "originalPrice":112.00,
                "originalCurrencyCode":"USD",
                "referenceId":"B94TXY-item001",
                "status":"PURCHASED",
                "passengerTypeCode":"ADT",
                "flightSegments":[
                    {
                        "origin":"DUB",
                        "destination":"LHR",
                        "departureDateTime":"2025-08-15T16:00:00.000Z",
                        "arrivalDateTime":"2025-08-15T17:20:00.000Z",
                        "flightNumber":"459",
                        "fareClass":"Economy",
                        "fareFamily":"Plus",
                        "carrier":"BX",
                        "operatingCarrier":"BX",
                        "originDestination":"DUB-LHR"
                    },
                    {
                        "origin":"LHR",
                        "destination":"LAS",
                        "departureDateTime":"2025-08-15T20:00:00.000Z",
                        "arrivalDateTime":"2025-08-15T22:40:00.000Z",
                        "flightNumber":"460",
                        "fareClass":"Economy",
                        "fareFamily":"Plus",
                        "carrier":"BX",
                        "operatingCarrier":"BX",
                        "originDestination":"LHR-LAS"
                    }
                ]
            }
        ],
        "order":{
            "href":"<baseURL>/v2/orders/d680c9be-4c07-4731-857e-9602034b15f2"
        }
    }
}

Do you have some feedback for us?

If you have suggestions for improving this article,