Sitecore CDP Order REST API (v2.1)

Use the Order REST API to create, retrieve, update, and delete order data in Sitecore CDP.

This REST API lets you interact with the following objects:

Order - the parent for all other objects, containing attributes common to the entire order.
Order item - something that has been purchased as part of the order.
Order contact - the primary contact person for an order.
Order consumer - the person that consumes the order item.
Order data extension - any key-value pairs you want to add to the order object.
Order item data extension - any key-value pairs you want to add to the order item object.

Note the following:

To use this REST API, you must authenticate your API requests.
All API requests are made in your production environment.
This reference documentation describes Sitecore CDP functionality for data model 2.1.

For more information, see the official Sitecore CDP developer documentation, including examples of order items and order item data extensions.

Authentication

The Order REST API uses basic authentication. Basic authentication involves sending a user name and a password with every request. To find your user name and password, in Sitecore CDP, on the navigation pane, click Settings > API access:

The user name is the Client key.
The password is the API token.

You must include the user name and password in every request you make. For example:

curl -X GET '{baseURL}/v2.1/orders' \ 
-u '{YOUR_USERNAME}:{YOUR_PASSWORD}' \ 
-H 'Accept: application/json'

Get started

To create your first order and find it in Sitecore CDP:

Create an order. The response contains the order reference.
Create an order contact using the order reference. Make sure to provide enough identity information according to your organization's identity rules. This associates a guest with the order. In the response, in guest.href, the guest reference is the string that follows the final slash.
Copy the guest reference.
In Sitecore CDP, click Guests. In the Search field, enter the guest reference, then click the Guest type: All filter. Then, Sitecore CDP lists the guest profile for the guest.
On the Guest Profile page, click the Orders tab. The order you previously created displays.

Download OpenAPI description

index.json

index.yaml

Overview

License Apache 2.0

Servers

Production server AP

https://api-engage-ap.sitecorecloud.io/

Production server EU

https://api-engage-eu.sitecorecloud.io/

Production server JP

https://api-engage-jpe.sitecorecloud.io/

Production server US

https://api-engage-us.sitecorecloud.io/

Order

An order object is the parent for all other objects and contains attributes that are common to the entire order. The Order REST API matches orders that have the same referenceId values and have orderedAt values (purchase dates) within two days of another.

Operations

Order item

The order item object represents something that has been purchased as part of the order. For an airline reservation, an order item is typically one or more flight segments, or an ancillary item purchased in addition to the flight, such as excess baggage allowance or priority boarding.

Operations

Order contact

An order contact is a person who is the primary contact for an order. The same guest can be both the order contact and order consumer.

Operations

Order consumer

An order consumer represents a person who is consuming an order item. If the order item is a flight, the order consumer is the traveler or passenger of the flight segment. If more than one order consumer is consuming the same order item, the order item has a quantity representing the number of order consumers.

The same guest can be both the order contact and order consumer.

Operations

Create an order consumer

Request

Creates a consumer on an order. In identifiers, make sure to provide enough identity information according to your organization's identity rules.

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

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

Bodyapplication/json

titlestring(title case)

The title of the person.

Example values: "Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr"

Example: "Mr"

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

genderstring(lowercase)

The person's gender.

Example values: "male", "female", "unknown"

Enum"male""female""unknown"

Example: "male"

dateOfBirthstring(date-time)

The person's date of birth. Validation: Date must be in the past.

Example: "1991-01-01T16:17:16Z"

emailsArray of strings

All the email addresses of the person.

Example: ["john.doe@gmail.com"]

phoneNumbersArray of strings

The phone numbers of the person.

Example: ["+353161123345","+353161123346"]

nationalitystring(title case)

The person's nationality.

Example values: "Irish", "British", "Spanish", "French"

Example: "Irish"

passportNumberstring(uppercase)

The passport number of the guest.

Example: "PZ4A9565"

countrystring(2-letter ISO 3166-1 Alpha-2 country code)

The guest's country.

Example values: "IE", "GB", "ES", "FR"

Example: "IE"

identifiersArray of objects(Identifier)

The guest's identifiers.

curl -i -X POST \
  -u <username>:<password> \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orders/{orderRef}/consumers' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Mr",
    "firstName": "John",
    "lastName": "Doe",
    "gender": "male",
    "dateOfBirth": "1991-01-01T16:17:16Z",
    "emails": [
      "john.doe@gmail.com"
    ],
    "phoneNumbers": [
      "+353161123345",
      "+353161123346"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "country": "IE",
    "identifiers": [
      {
        "provider": "ProfileSystem",
        "id": "B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41"
      }
    ]
  }'

Responses

Resource successfully created

Bodyapplication/json

refstring(UUID)

The order consumer reference.

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

hrefstring

The link to the order consumer.

Example: "https://api-engage-eu.sitecorecloud.io/v2.1/orderConsumers/2d7de9df-45a2-45ea-872c-30e45139007d"

titlestring(title case)

The title of the person.

Example: "Mr"

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

genderstring(lowercase)

The person's gender.

Example values: "male", "female", "unknown"

Enum"male""female""unknown"

Example: "male"

dateOfBirthstring(date-time)

The person's date of birth. Validation: Date must be in the past.

Example: "1991-01-01T16:17:16Z"

emailsArray of strings

All the email addresses of the person.

Example: ["john.doe@gmail.com"]

phoneNumbersArray of strings

The phone numbers of the person.

Example: ["+353161123345","+353161123346"]

nationalitystring(title case)

The person's nationality.

Example values: "Irish", "British", "Spanish", "French"

Example: "Irish"

passportNumberstring(uppercase)

The passport number of the guest.

Example: "PZ4A9565"

countrystring(2-letter ISO 3166-1 Alpha-2 country code)

The guest's country.

Example values: "IE", "GB", "ES", "FR"

Example: "IE"

orderItemsobject(OrderItemResponseObj)

Order item details, containing a list of items.

orderobject

The link to the order.

guestobject

The link to the guest.

Response

application/json

{
  "ref": "2d7de9df-45a2-45ea-872c-30e45139007d",
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orderConsumers/2d7de9df-45a2-45ea-872c-30e45139007d",
  "title": "Mr",
  "firstName": "John",
  "lastName": "Doe",
  "gender": "male",
  "dateOfBirth": "1991-01-01T16:17:16Z",
  "emails": [
    "john.doe@gmail.com"
  ],
  "phoneNumbers": [
    "+353161123345",
    "+353161123346"
  ],
  "nationality": "Irish",
  "passportNumber": "PZ4A9565",
  "country": "IE",
  "orderItems": {
    "orderItems": [ … ]
  },
  "order": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"
  },
  "guest": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
  }
}

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.

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(Limit)[ 10 .. 100 ]

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/{orderRef}/consumers?expand=true&limit=40&offset=0'

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

application/json

{
  "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": [
    { … }
  ]
}

Retrieve an order consumer

Request

Retrieves an order consumer.

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/{orderConsumerRef}'

Responses

Resource successfully retrieved.

Bodyapplication/json

refstring(UUID)

The order consumer reference.

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

hrefstring

The link to the order consumer.

Example: "https://api-engage-eu.sitecorecloud.io/v2.1/orderConsumers/2d7de9df-45a2-45ea-872c-30e45139007d"

titlestring(title case)

The title of the person.

Example: "Mr"

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

genderstring(lowercase)

The person's gender.

Example values: "male", "female", "unknown"

Enum"male""female""unknown"

Example: "male"

dateOfBirthstring(date-time)

The person's date of birth. Validation: Date must be in the past.

Example: "1991-01-01T16:17:16Z"

emailsArray of strings

All the email addresses of the person.

Example: ["john.doe@gmail.com"]

phoneNumbersArray of strings

The phone numbers of the person.

Example: ["+353161123345","+353161123346"]

nationalitystring(title case)

The person's nationality.

Example values: "Irish", "British", "Spanish", "French"

Example: "Irish"

passportNumberstring(uppercase)

The passport number of the guest.

Example: "PZ4A9565"

countrystring(2-letter ISO 3166-1 Alpha-2 country code)

The guest's country.

Example values: "IE", "GB", "ES", "FR"

Example: "IE"

orderItemsobject(OrderItemResponseObj)

Order item details, containing a list of items.

orderobject

The link to the order.

guestobject

The link to the guest.

Response

application/json

{
  "ref": "2d7de9df-45a2-45ea-872c-30e45139007d",
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orderConsumers/2d7de9df-45a2-45ea-872c-30e45139007d",
  "title": "Mr",
  "firstName": "John",
  "lastName": "Doe",
  "gender": "male",
  "dateOfBirth": "1991-01-01T16:17:16Z",
  "emails": [
    "john.doe@gmail.com"
  ],
  "phoneNumbers": [
    "+353161123345",
    "+353161123346"
  ],
  "nationality": "Irish",
  "passportNumber": "PZ4A9565",
  "country": "IE",
  "orderItems": {
    "orderItems": [ … ]
  },
  "order": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"
  },
  "guest": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
  }
}

Update an order consumer

Request

Updates an order consumer.

Path

orderConsumerRefstringrequired

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

Bodyapplication/json

titlestring(title case)

The title of the person.

Example: "Mr"

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

genderstring(lowercase)

The person's gender.

Example values: "male", "female", "unknown"

Enum"male""female""unknown"

Example: "male"

dateOfBirthstring(date-time)

The person's date of birth. Validation: Date must be in the past.

Example: "1991-01-01T16:17:16Z"

emailsArray of strings

All the email addresses of the person.

Example: ["john.doe@gmail.com"]

phoneNumbersArray of strings

The phone numbers of the person.

Example: ["+353161123345","+353161123346"]

nationalitystring(title case)

The person's nationality.

Example values: "Irish", "British", "Spanish", "French"

Example: "Irish"

passportNumberstring(uppercase)

The passport number of the guest.

Example: "PZ4A9565"

countrystring(2-letter ISO 3166-1 Alpha-2 country code)

The guest's country.

Example values: "IE", "GB", "ES", "FR"

Example: "IE"

identifiersArray of objects(Identifier)

The guest's identifiers.

curl -i -X PUT \
  -u <username>:<password> \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orderConsumers/{orderConsumerRef}' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Mr",
    "firstName": "John",
    "lastName": "Doe",
    "gender": "male",
    "dateOfBirth": "1991-01-01T16:17:16Z",
    "emails": [
      "john.doe@gmail.com"
    ],
    "phoneNumbers": [
      "+353161123345",
      "+353161123346"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "country": "IE",
    "identifiers": [
      {
        "provider": "ProfileSystem",
        "id": "B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41"
      }
    ]
  }'

Responses

Successful operation

Bodyapplication/json

refstring(UUID)

The order consumer reference.

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

hrefstring

The link to the order consumer.

Example: "https://api-engage-eu.sitecorecloud.io/v2.1/orderConsumers/2d7de9df-45a2-45ea-872c-30e45139007d"

titlestring(title case)

The title of the person.

Example: "Mr"

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

genderstring(lowercase)

The person's gender.

Example values: "male", "female", "unknown"

Enum"male""female""unknown"

Example: "male"

dateOfBirthstring(date-time)

The person's date of birth. Validation: Date must be in the past.

Example: "1991-01-01T16:17:16Z"

emailsArray of strings

All the email addresses of the person.

Example: ["john.doe@gmail.com"]

phoneNumbersArray of strings

The phone numbers of the person.

Example: ["+353161123345","+353161123346"]

nationalitystring(title case)

The person's nationality.

Example values: "Irish", "British", "Spanish", "French"

Example: "Irish"

passportNumberstring(uppercase)

The passport number of the guest.

Example: "PZ4A9565"

countrystring(2-letter ISO 3166-1 Alpha-2 country code)

The guest's country.

Example values: "IE", "GB", "ES", "FR"

Example: "IE"

orderItemsobject(OrderItemResponseObj)

Order item details, containing a list of items.

orderobject

The link to the order.

guestobject

The link to the guest.

Response

application/json

{
  "ref": "2d7de9df-45a2-45ea-872c-30e45139007d",
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orderConsumers/2d7de9df-45a2-45ea-872c-30e45139007d",
  "title": "Mr",
  "firstName": "John",
  "lastName": "Doe",
  "gender": "male",
  "dateOfBirth": "1991-01-01T16:17:16Z",
  "emails": [
    "john.doe@gmail.com"
  ],
  "phoneNumbers": [
    "+353161123345",
    "+353161123346"
  ],
  "nationality": "Irish",
  "passportNumber": "PZ4A9565",
  "country": "IE",
  "orderItems": {
    "orderItems": [ … ]
  },
  "order": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"
  },
  "guest": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
  }
}

Partially update an order consumer

Request

Partially updates an order consumer.

Path

orderConsumerRefstringrequired

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

Bodyapplication/json

titlestring(title case)

The title of the person.

Example: "Mr"

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

genderstring(lowercase)

The person's gender.

Example values: "male", "female", "unknown"

Enum"male""female""unknown"

Example: "male"

dateOfBirthstring(date-time)

The person's date of birth. Validation: Date must be in the past.

Example: "1991-01-01T16:17:16Z"

emailsArray of strings

All the email addresses of the person.

Example: ["john.doe@gmail.com"]

phoneNumbersArray of strings

The phone numbers of the person.

Example: ["+353161123345","+353161123346"]

nationalitystring(title case)

The person's nationality.

Example values: "Irish", "British", "Spanish", "French"

Example: "Irish"

passportNumberstring(uppercase)

The passport number of the guest.

Example: "PZ4A9565"

countrystring(2-letter ISO 3166-1 Alpha-2 country code)

The guest's country.

Example values: "IE", "GB", "ES", "FR"

Example: "IE"

identifiersArray of objects(Identifier)

The guest's identifiers.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orderConsumers/{orderConsumerRef}' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Mr",
    "firstName": "John",
    "lastName": "Doe",
    "gender": "male",
    "dateOfBirth": "1991-01-01T16:17:16Z",
    "emails": [
      "john.doe@gmail.com"
    ],
    "phoneNumbers": [
      "+353161123345",
      "+353161123346"
    ],
    "nationality": "Irish",
    "passportNumber": "PZ4A9565",
    "country": "IE",
    "identifiers": [
      {
        "provider": "ProfileSystem",
        "id": "B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41"
      }
    ]
  }'

Responses

Successful operation

Bodyapplication/json

refstring(UUID)

The order consumer reference.

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

hrefstring

The link to the order consumer.

Example: "https://api-engage-eu.sitecorecloud.io/v2.1/orderConsumers/2d7de9df-45a2-45ea-872c-30e45139007d"

titlestring(title case)

The title of the person.

Example: "Mr"

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

genderstring(lowercase)

The person's gender.

Example values: "male", "female", "unknown"

Enum"male""female""unknown"

Example: "male"

dateOfBirthstring(date-time)

The person's date of birth. Validation: Date must be in the past.

Example: "1991-01-01T16:17:16Z"

emailsArray of strings

All the email addresses of the person.

Example: ["john.doe@gmail.com"]

phoneNumbersArray of strings

The phone numbers of the person.

Example: ["+353161123345","+353161123346"]

nationalitystring(title case)

The person's nationality.

Example values: "Irish", "British", "Spanish", "French"

Example: "Irish"

passportNumberstring(uppercase)

The passport number of the guest.

Example: "PZ4A9565"

countrystring(2-letter ISO 3166-1 Alpha-2 country code)

The guest's country.

Example values: "IE", "GB", "ES", "FR"

Example: "IE"

orderItemsobject(OrderItemResponseObj)

Order item details, containing a list of items.

orderobject

The link to the order.

guestobject

The link to the guest.

Response

application/json

{
  "ref": "2d7de9df-45a2-45ea-872c-30e45139007d",
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orderConsumers/2d7de9df-45a2-45ea-872c-30e45139007d",
  "title": "Mr",
  "firstName": "John",
  "lastName": "Doe",
  "gender": "male",
  "dateOfBirth": "1991-01-01T16:17:16Z",
  "emails": [
    "john.doe@gmail.com"
  ],
  "phoneNumbers": [
    "+353161123345",
    "+353161123346"
  ],
  "nationality": "Irish",
  "passportNumber": "PZ4A9565",
  "country": "IE",
  "orderItems": {
    "orderItems": [ … ]
  },
  "order": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"
  },
  "guest": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
  }
}

Delete an order consumer

Request

Delete an order consumer. An empty, 204 response means that the deletion was successful.

Path

orderConsumerRefstringrequired

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

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orderConsumers/{orderConsumerRef}'

Responses

Successful operation

Response

application/json

{
  "status": "UNAUTHORIZED",
  "code": 401,
  "message": "Authentication credentials are required to access the resource. All requests must be authenticated.",
  "moreInfoUrl": "https://support.sitecore.com"
}

List a consumer's order items

Request

Retrieves order items for a consumer.

Path

orderConsumerRefstringrequired

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

curl -i -X GET \
  -u <username>:<password> \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orderConsumers/{orderConsumerRef}/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

application/json

{
  "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": [
    { … }
  ]
}

Order data extension

An order data extension is an object that lets you specify any key-value pairs you want. Order data extensions are optional and enable your organization to capture more robust information about your orders.

To get started with this API, create a data extension for the order you previously created.

Operations

Order item data extension

An order item data extension is an object that lets you specify any key-value pairs you want. Order data extensions are optional and enable your organization to capture more robust information about your order items.

To get started with this API, create a data extension for the order items you previously created.

Operations

Sitecore CDP Order REST API (v2.1)

Authentication

Get started

Order

Order item

Order contact

Order consumer

Create an order consumer

Request

Responses

Was this helpful?

List consumers of an order

Request

Responses

Was this helpful?

Retrieve an order consumer

Request

Responses

Was this helpful?

Update an order consumer

Request

Responses

Was this helpful?

Partially update an order consumer

Request

Responses

Was this helpful?

Delete an order consumer

Request

Responses

Was this helpful?

List a consumer's order items

Request

Responses

Was this helpful?

Order data extension

Order item data extension

Sitecore CDP Order REST API (v2.1)

Authentication

Get started

Order

Order item

Order contact

Order consumer

Create an order consumer

RequestExpand all

Responses

Was this helpful?

List consumers of an order

Request

Responses

Was this helpful?

Retrieve an order consumer

Request

Responses

Was this helpful?

Update an order consumer

RequestExpand all

Responses

Was this helpful?

Partially update an order consumer

RequestExpand all

Responses

Was this helpful?

Delete an order consumer

Request

Responses

Was this helpful?

List a consumer's order items

Request

Responses

Was this helpful?

Order data extension

Order item data extension

Request

Request

Request