List consumers of an order

Request

Retrieves a list of order consumers for an order.

In the response, items.ref contains the order consumer reference. Use the order consumer reference to interact with a specific order consumer, for example, to retrieve or update it.

Security

BasicAuth

Path

orderRefstringrequired

The order reference. This is a unique identifier of the order record. Automatically generated when you created the order. If you don't know the order reference, first list orders.

Example:2d7de9df-45a2-45ea-872c-30e45139007d

Query

expandArray of strings(Expand)

You can expand items in a collection by setting expand=true. This eliminates the need to send multiple follow-up requests (one for the collection and another for each of its items). This also helps you check if the data you intend to create already exists.

Example:expand=true

offsetobject(Offset)

Collection responses use offset pagination. The offset query parameter is used to exclude from a response the first N items of the entire resource collection.

Default:"0"

Example:offset=0

limitobject, [ 10 .. 100 ](Limit)

Collection responses use offset pagination. This query parameter lets you adjust the maximum number of collection items to return for a single request.

Default:"10"

Example:limit=40

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d/consumers?expand=true&offset=0&limit=40'

Responses

Successful operation

Bodyapplication/json

offsetinteger, (int32)

The request's offset.

Example:0

limitinteger, (int32)

The request's limit.

Example:10

firstobject(OrderConsumerLinkFirst)

The request's first list of order consumers URL.

lastobject(OrderConsumerLinkLast)

The request's last list of order consumers URL.

nextobject(OrderConsumerNext)

The request's next list of order consumers URL.

hrefstring

The request's URL.

Example:"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/consumers?offset=0&limit=10"

itemsArray of objects(items)

The order consumer's items.

Response

{
  "offset": 0,
  "limit": 10,
  "first": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/111d106a-feff-42b2-90fb-a6ed136ec333/consumers?offset=1&limit=10"
  },
  "last": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/111d106a-feff-42b2-90fb-a6ed136ec333/consumers?offset=1&limit=10"
  },
  "next": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/111d106a-feff-42b2-90fb-a6ed136ec333/consumers?offset=1&limit=10"
  },
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/consumers?offset=0&limit=10",
  "items": [
    { … }
  ]
}