List a consumer's order items

Request

Retrieves order items for a consumer.

Security

BasicAuth

Path

orderConsumerRefstringrequired

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

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

curl -i -X GET \
  -u '<username>:<password>' \
  https://api-engage-ap.sitecorecloud.io/v2.1/orderConsumers/2d7de9df-45a2-45ea-872c-30e45139007d/orderItems

Responses

Successful operation

Bodyapplication/json

offsetinteger, (int32)

The request's offset.

Example:0

limitinteger, (int32)

The request's limit.

Example:10

firstobject(OrderItemLinkFirst)

The request's first list of order items URL.

lastobject(OrderItemLinkLast)

The request's last list of order items URL.

nextobject(OrderItemNext)

The request's next list of order items URL.

hrefstring

The request's URL.

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

itemsArray of objects(items)

Response

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