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

Create an order contact

Request

Creates the primary contact 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 contact reference. Use the order contact reference to interact with a specific contact, 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

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

emailsArray of strings

All the email addresses of the person.

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

identifiersArray of objects(Identifier)

The guest's identifiers.

streetArray of strings

The order contact's street address.

Example: ["Tara St.","Main Ave."]

citystring(String)

The order contact's city.

Example: "Dublin"

statestring(String)

The order contact's post code.

Example: "10001"

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"

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"

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 contact.

Example: "PZ4A9565"

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

The guest's country.

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

Example: "IE"

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

Responses

Resource successfully created

Bodyapplication/json

refstring(UUID)

The order contact reference.

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

hrefstring

The link to the order contact.

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

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

emailsArray of strings

All the email addresses of the person.

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

identifiersArray of objects(Identifier)

The guest's identifiers.

streetArray of strings

The order contact's street address.

Example: ["Tara St.","Main Ave."]

citystring(String)

The order contact's city.

Example: "Dublin"

statestring(String)

The order contact's state.

Example: "New York"

postCodestring(String)

The order contact's post code.

Example: "10001"

titlestring(title case)

The title of the person.

Example: "Mr"

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"

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 contact.

Example: "PZ4A9565"

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

The guest's country.

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

Example: "IE"

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/orderContacts/2d7de9df-45a2-45ea-872c-30e45139007d",
  "firstName": "John",
  "lastName": "Doe",
  "emails": [
    "john.doe@gmail.com"
  ],
  "identifiers": [
    { … }
  ],
  "street": [
    "Tara St.",
    "Main Ave."
  ],
  "city": "Dublin",
  "state": "New York",
  "postCode": "10001",
  "title": "Mr",
  "gender": "male",
  "dateOfBirth": "1991-01-01T16:17:16Z",
  "phoneNumbers": [
    "+353161123345",
    "+353161123346"
  ],
  "nationality": "Irish",
  "passportNumber": "PZ4A9565",
  "country": "IE",
  "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 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.

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/{orderRef}/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

application/json

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

Retrieve an order contact

Request

Retrieves an order contact.

Path

orderContactRefstringrequired

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

Example: 3b5cb55e-c616-424a-991c-a241d0024896

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

Responses

Resource successfully retrieved.

Bodyapplication/json

refstring(UUID)

The order contact reference.

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

hrefstring

The link to the order contact.

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

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

emailsArray of strings

All the email addresses of the person.

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

identifiersArray of objects(Identifier)

The guest's identifiers.

streetArray of strings

The order contact's street address.

Example: ["Tara St.","Main Ave."]

citystring(String)

The order contact's city.

Example: "Dublin"

statestring(String)

The order contact's state.

Example: "New York"

postCodestring(String)

The order contact's post code.

Example: "10001"

titlestring(title case)

The title of the person.

Example: "Mr"

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"

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 contact.

Example: "PZ4A9565"

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

The guest's country.

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

Example: "IE"

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/orderContacts/2d7de9df-45a2-45ea-872c-30e45139007d",
  "firstName": "John",
  "lastName": "Doe",
  "emails": [
    "john.doe@gmail.com"
  ],
  "identifiers": [
    { … }
  ],
  "street": [
    "Tara St.",
    "Main Ave."
  ],
  "city": "Dublin",
  "state": "New York",
  "postCode": "10001",
  "title": "Mr",
  "gender": "male",
  "dateOfBirth": "1991-01-01T16:17:16Z",
  "phoneNumbers": [
    "+353161123345",
    "+353161123346"
  ],
  "nationality": "Irish",
  "passportNumber": "PZ4A9565",
  "country": "IE",
  "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 contact

Request

Updates an order contact.

Path

orderContactRefstringrequired

Example: 3b5cb55e-c616-424a-991c-a241d0024896

Bodyapplication/json

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

emailsArray of strings

All the email addresses of the person.

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

identifiersArray of objects(Identifier)

The guest's identifiers.

streetArray of strings

The order contact's street address.

Example: ["Tara St.","Main Ave."]

citystring(String)

The order contact's city.

Example: "Dublin"

statestring(String)

The order contact's post code.

Example: "10001"

titlestring(title case)

The title of the person.

Example: "Mr"

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"

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 contact.

Example: "PZ4A9565"

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

The guest's country.

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

Example: "IE"

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

Responses

Successful operation

Bodyapplication/json

refstring(UUID)

The order contact reference.

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

hrefstring

The link to the order contact.

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

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

emailsArray of strings

All the email addresses of the person.

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

identifiersArray of objects(Identifier)

The guest's identifiers.

streetArray of strings

The order contact's street address.

Example: ["Tara St.","Main Ave."]

citystring(String)

The order contact's city.

Example: "Dublin"

statestring(String)

The order contact's state.

Example: "New York"

postCodestring(String)

The order contact's post code.

Example: "10001"

titlestring(title case)

The title of the person.

Example: "Mr"

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"

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 contact.

Example: "PZ4A9565"

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

The guest's country.

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

Example: "IE"

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/orderContacts/2d7de9df-45a2-45ea-872c-30e45139007d",
  "firstName": "John",
  "lastName": "Doe",
  "emails": [
    "john.doe@gmail.com"
  ],
  "identifiers": [
    { … }
  ],
  "street": [
    "Tara St.",
    "Main Ave."
  ],
  "city": "Dublin",
  "state": "New York",
  "postCode": "10001",
  "title": "Mr",
  "gender": "male",
  "dateOfBirth": "1991-01-01T16:17:16Z",
  "phoneNumbers": [
    "+353161123345",
    "+353161123346"
  ],
  "nationality": "Irish",
  "passportNumber": "PZ4A9565",
  "country": "IE",
  "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 contact

Request

Partially updates an order contact.

Path

orderContactRefstringrequired

Example: 3b5cb55e-c616-424a-991c-a241d0024896

Bodyapplication/json

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

emailsArray of strings

All the email addresses of the person.

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

identifiersArray of objects(Identifier)

The guest's identifiers.

streetArray of strings

The order contact's street address.

Example: ["Tara St.","Main Ave."]

citystring(String)

The order contact's city.

Example: "Dublin"

statestring(String)

The order contact's post code.

Example: "10001"

titlestring(title case)

The title of the person.

Example: "Mr"

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"

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 contact.

Example: "PZ4A9565"

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

The guest's country.

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

Example: "IE"

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

Responses

Successful operation

Bodyapplication/json

refstring(UUID)

The order contact reference.

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

hrefstring

The link to the order contact.

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

firstNamestring(title case)

The person's first name.

Example: "John"

lastNamestring(title case recommended)

The person's last name.

Example: "Doe"

emailsArray of strings

All the email addresses of the person.

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

identifiersArray of objects(Identifier)

The guest's identifiers.

streetArray of strings

The order contact's street address.

Example: ["Tara St.","Main Ave."]

citystring(String)

The order contact's city.

Example: "Dublin"

statestring(String)

The order contact's state.

Example: "New York"

postCodestring(String)

The order contact's post code.

Example: "10001"

titlestring(title case)

The title of the person.

Example: "Mr"

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"

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 contact.

Example: "PZ4A9565"

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

The guest's country.

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

Example: "IE"

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/orderContacts/2d7de9df-45a2-45ea-872c-30e45139007d",
  "firstName": "John",
  "lastName": "Doe",
  "emails": [
    "john.doe@gmail.com"
  ],
  "identifiers": [
    { … }
  ],
  "street": [
    "Tara St.",
    "Main Ave."
  ],
  "city": "Dublin",
  "state": "New York",
  "postCode": "10001",
  "title": "Mr",
  "gender": "male",
  "dateOfBirth": "1991-01-01T16:17:16Z",
  "phoneNumbers": [
    "+353161123345",
    "+353161123346"
  ],
  "nationality": "Irish",
  "passportNumber": "PZ4A9565",
  "country": "IE",
  "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 contact

Request

Partially updates an order contact.

Path

orderContactRefstringrequired

Example: 3b5cb55e-c616-424a-991c-a241d0024896

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

Responses

Successful operation

Response

application/json

{
  "status": 400,
  "code": 400,
  "message": "firstName: may not be null.",
  "developerMessage": "firstName: may not be null.",
  "moreInfoUrl": "https://support.sitecore.com"
}

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

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

Create an order contact

Request

Responses

Was this helpful?

List order contacts for an order

Request

Responses

Was this helpful?

Retrieve an order contact

Request

Responses

Was this helpful?

Update an order contact

Request

Responses

Was this helpful?

Partially update an order contact

Request

Responses

Was this helpful?

Delete an order contact

Request

Responses

Was this helpful?

Order consumer

Order data extension

Order item data extension

Sitecore CDP Order REST API (v2.1)

Authentication

Get started

Order

Order item

Order contact

Create an order contact

RequestExpand all

Responses

Was this helpful?

List order contacts for an order

Request

Responses

Was this helpful?

Retrieve an order contact

Request

Responses

Was this helpful?

Update an order contact

RequestExpand all

Responses

Was this helpful?

Partially update an order contact

RequestExpand all

Responses

Was this helpful?

Delete an order contact

Request

Responses

Was this helpful?

Order consumer

Order data extension

Order item data extension

Request

Request

Request