Order consumer REST API v2 (legacy)

Retrieve an order consumer (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/orderConsumers/<orderConsumerRef>

Retrieves an order consumer.

Attribute	Type	Description	Example
`orderConsumerRef`	string	The reference of the consumer on the order. If you do not know the order consumer reference, first retrieve order consumer references for an order.	`f8d1f0d5-365d-46b7-becf-d041e93a5705`

Attribute

Type

Description

Example

orderConsumerRef

string

The reference of the consumer on the order.

If you do not know the order consumer reference, first retrieve order consumer references for an order.

f8d1f0d5-365d-46b7-becf-d041e93a5705

curl -X GET '<baseURL>/v2/orderConsumers/f8d1f0d5-365d-46b7-becf-d041e93a5705' \
-u '<username>:<password>' \
-H 'Accept: application/json'

{
  "href": "<baseURL>/v2/orderConsumers/f8d1f0d5-365d-46b7-becf-d041e93a5705",
  "ref": "f8d1f0d5-365d-46b7-becf-d041e93a5705",
  "createdAt": "2025-08-15T16:00:55.554Z",
  "modifiedAt": "2025-08-21T16:00:51.882Z",
  "title": "Ms",
  "firstName": "Jane",
  "lastName": "Doe",
  "gender": "female",
  "guest": {
        "href": "<baseURL>/v2/guests/567A697E-4E79-4F2C-96D1-A7249A44744F"
    },
   "orderItems": {
        "items": [{
                "href": "<baseURL>/v2/orderItems/FECBB7ED-6DFE-4E8C-85A9-B894B17EF4F3"
            }]
    },
    "order": {
       "href": "<baseURL>/v2/orders/056621C2-C955-492D-B7EE-C77C6BDDFDEE"
  }
}

If you have suggestions for improving this article, let us know!