Retrieve order consumer references (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>/consumers

Retrieves a list of order consumers for 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

In the response, in items.href, the order consumer reference is the string that follows the final slash:

"href": "<baseURL>/v2/orderConsumers/<orderConsumerRef>"

You use the order consumer reference to retrieve the order consumer.

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

{
    "href": "<baseURL>/v2/orders/d680c9be-4c07-4731-857e-9602034b15f2/consumers?offset=0&limit=10",
    "offset": 0,
    "limit": 10,
    "items": [{
        "href": "<baseURL>/v2/orderConsumers/FECBB7ED-6DFE-4E8C-85A9-B894B17EF4F3"
    }]
}

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