List order contacts for an order

Request

Retrieves a list of order contacts for an order.

In the response, items.ref contains the order contact reference. Use the order contact reference to interact with a specific order contact, 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

expandobject(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

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

Responses

Resource successfully retrieved.

Bodyapplication/json

offsetinteger, (int32)

The request's offset.

Example:0

limitinteger, (int32)

The request's limit.

Example:10

firstobject(OrderContactLinkFirst)

The request's first list of order contacts URL.

lastobject(OrderContactLinkLast)

The request's last list of order contacts URL.

nextobject(OrderContactNext)

The request's next list of order contacts URL.

hrefstring

The request's URL.

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

itemsArray of objects(OrderContactHref)

The order contacts's items.

Response

{
  "offset": 0,
  "limit": 10,
  "first": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d/contacts?offset=1&limit=10"
  },
  "last": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d/contacts?offset=1&limit=10"
  },
  "next": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d/contacts?offset=1&limit=10"
  },
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/contacts?offset=0&limit=10",
  "items": [
    { … }
  ]
}