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

Create an order

Request

Creates an order.

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

Bodyapplication/json

currencyCodestring(3 letter ISO 4217)required

The currency the guest used to complete a purchase. Set this to the organization’s default currency.

Example: "EUR"

orderedAtstring(date-time)required

The date and time when the order was made.

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

pricenumber(number (currency))required

The amount paid for the order.

Example: 50

referenceIdstring(string)required

A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR.

Example: "B94TXY-1"

createdAtstring(date-time)

The date and time when the resource was created in Sitecore CDP.

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

modifiedAtstring(date-time)

The date and time when the resource was updated in Sitecore CDP.

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

paymentTypestring(string (title case recommended))

The method of payment for the order.

Example: "Card"

cardTypestring(string (title case recommended))

The card type used to pay for the order.

Example: "Visa"

pointOfSalestring(string (predefined by the client))

The point of sale used in the order.

Example: "home"

channelstring

The channel used in the order.

Enum"WEB""MOBILE_WEB""MOBILE_APP""CALL_CENTER""AIRPORT_KIOSK""BRANCH""KIOSK""OFFLINE""GDS""OTA"

Example: "WEB"

statusstring

The status of the order.

Enum"BROWSED""CANCELLED""CONFIRMED""DECLINED""PARTIALY_CONFIRMED""PARTIALY_REFUNDED""PAYMENT_PENDING""PENDING""PURCHASED""REFUNDED"

Example: "PURCHASED"

curl -i -X POST \
  -u <username>:<password> \
  https://api-engage-ap.sitecorecloud.io/v2.1/orders \
  -H 'Content-Type: application/json' \
  -d '{
    "createdAt": "2024-01-01T16:17:16Z",
    "modifiedAt": "2024-01-01T16:17:16Z",
    "orderedAt": "2024-01-01T16:17:16Z",
    "currencyCode": "EUR",
    "price": 50,
    "referenceId": "B94TXY-1",
    "paymentType": "Card",
    "cardType": "Visa",
    "pointOfSale": "home",
    "channel": "WEB",
    "status": "PURCHASED"
  }'

Responses

Resource successfully created

Bodyapplication/json

refstring(UUID)

The order reference. This is a unique identifier of the order record. Use the order reference to interact with a specific order, for example, to retrieve it, update it, or create a data extension for it.

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

hrefstring

The link to the order.

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

createdAtstring(date-time)

The date and time when the resource was created in Sitecore CDP.

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

modifiedAtstring(date-time)

The date and time when the resource was updated in Sitecore CDP.

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

orderedAtstring(date-time)

The date and time when the order was made.

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

currencyCodestring(3 letter ISO 4217)

The currency the guest used to complete a purchase.

Example: "EUR"

pricenumber(number (currency))

The amount paid for the order.

Example: 50

referenceIdstring(string)

A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR.

Example: "B94TXY-1"

paymentTypestring(string (title case recommended))

The method of payment for the order.

Example: "Card"

cardTypestring(string (title case recommended))

The card type used to pay for the order.

Example: "Visa"

pointOfSalestring(string (predefined by the client))

The point of sale used in the order.

Example: "home"

channelstring

The channel used in the order.

Enum"WEB""MOBILE_WEB""MOBILE_APP""CALL_CENTER""AIRPORT_KIOSK""BRANCH""KIOSK""OFFLINE""GDS""OTA"

Example: "WEB"

statusstring

The status of the order.

Enum"BROWSED""CANCELLED""CONFIRMED""DECLINED""PARTIALY_CONFIRMED""PARTIALY_REFUNDED""PAYMENT_PENDING""PENDING""PURCHASED""REFUNDED"

Example: "PURCHASED"

contactsobject(OrderContactResponse)

Contact details, containing a list of items.

consumersobject(OrderConsumerResponse)

Consumer details, containing a list of items.

orderItemsobject(OrderItemResponse)

Order item details, containing a list of items.

Response

application/json

{
  "ref": "2d7de9df-45a2-45ea-872c-30e45139007d",
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d",
  "createdAt": "2024-01-01T16:17:16Z",
  "modifiedAt": "2024-01-01T16:17:16Z",
  "orderedAt": "2024-01-01T16:17:16Z",
  "currencyCode": "EUR",
  "price": 50,
  "referenceId": "B94TXY-1",
  "paymentType": "Card",
  "cardType": "Visa",
  "pointOfSale": "home",
  "channel": "WEB",
  "status": "PURCHASED",
  "contacts": {
    "items": []
  },
  "consumers": {
    "items": []
  },
  "orderItems": {
    "items": []
  }
}

List orders

Request

Retrieves a list of orders that either have the same reference ID or belong to the same guest. You must include either the referenceId of the order or the guestRef as a query string parameter in the URI of the request, but not both.

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

Query

referenceIdstring

A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR. Specify either referenceId or guestRef in the query parameters, not both.

Example: referenceId=B94TXY-1

guestRefstring

The guest reference. This is a unique identifier of the guest record. If you don't know the guest reference, first retrieve guests using the Sitecore CDP Guest REST API. Specify either referenceId or guestRef in the query parameters, not both.

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

expandArray of strings

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

sortstring

You can sort search results by the date and time when the order was created (created) or made (orderedAt). You can only use orderedAt if you list orders using guestRef.

curl -i -X GET \
  -u <username>:<password> \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orders?expand=true&guestRef=string&limit=40&offset=0&referenceId=B94TXY-1&sort=string'

Responses

Successful operation

Bodyapplication/json

offsetinteger(int32)

The request's offset.

Example: 0

limitinteger(int32)

The request's limit.

Example: 10

firstobject(OrderLinkFirst)

The request's first list of orders URL.

lastobject(OrderLinkLast)

The request's last list of orders URL.

nextobject(OrdersNext)

The request's next list of orders URL.

hrefstring

The request's URL.

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

itemsArray of objects(OrderHref)

Response

application/json

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

Retrieve an order

Request

Retrieves an order.

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

Example: expand=true

curl -i -X GET \
  -u <username>:<password> \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orders/{orderRef}?expand=true'

Responses

Successful operation

Bodyapplication/json

refstring(UUID)

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

hrefstring

The link to the order.

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

createdAtstring(date-time)

The date and time when the resource was created in Sitecore CDP.

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

modifiedAtstring(date-time)

The date and time when the resource was updated in Sitecore CDP.

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

orderedAtstring(date-time)

The date and time when the order was made.

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

currencyCodestring(3 letter ISO 4217)

The currency the guest used to complete a purchase.

Example: "EUR"

pricenumber(number (currency))

The amount paid for the order.

Example: 50

referenceIdstring(string)

A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR.

Example: "B94TXY-1"

paymentTypestring(string (title case recommended))

The method of payment for the order.

Example: "Card"

cardTypestring(string (title case recommended))

The card type used to pay for the order.

Example: "Visa"

pointOfSalestring(string (predefined by the client))

The point of sale used in the order.

Example: "home"

channelstring

The channel used in the order.

Enum"WEB""MOBILE_WEB""MOBILE_APP""CALL_CENTER""AIRPORT_KIOSK""BRANCH""KIOSK""OFFLINE""GDS""OTA"

Example: "WEB"

statusstring

The status of the order.

Enum"BROWSED""CANCELLED""CONFIRMED""DECLINED""PARTIALY_CONFIRMED""PARTIALY_REFUNDED""PAYMENT_PENDING""PENDING""PURCHASED""REFUNDED"

Example: "PURCHASED"

contactsobject(OrderContactResponse)

Contact details, containing a list of items.

consumersobject(OrderConsumerResponse)

Consumer details, containing a list of items.

orderItemsobject(OrderItemResponse)

Order item details, containing a list of items.

Response

application/json

{
  "ref": "2d7de9df-45a2-45ea-872c-30e45139007d",
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d",
  "createdAt": "2024-01-01T16:17:16Z",
  "modifiedAt": "2024-01-01T16:17:16Z",
  "orderedAt": "2024-01-01T16:17:16Z",
  "currencyCode": "EUR",
  "price": 50,
  "referenceId": "B94TXY-1",
  "paymentType": "Card",
  "cardType": "Visa",
  "pointOfSale": "home",
  "channel": "WEB",
  "status": "PURCHASED",
  "contacts": {
    "items": []
  },
  "consumers": {
    "items": []
  },
  "orderItems": {
    "items": []
  }
}

Update an order

Request

Updates an order. You can update orders that have the same referenceId and have orderedAt values (purchase dates) within two days of another. referenceId and orderedAt cannot be updated.

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

currencyCodestring(3 letter ISO 4217)required

The currency the guest used to complete a purchase. Set this to the organization’s default currency.

Example: "EUR"

orderedAtstring(date-time)required

The date and time when the order was made.

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

pricenumber(number (currency))required

The amount paid for the order.

Example: 50

referenceIdstring(string)required

A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR.

Example: "B94TXY-1"

createdAtstring(date-time)

The date and time when the resource was created in Sitecore CDP.

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

modifiedAtstring(date-time)

The date and time when the resource was updated in Sitecore CDP.

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

paymentTypestring(string (title case recommended))

The method of payment for the order.

Example: "Card"

cardTypestring(string (title case recommended))

The card type used to pay for the order.

Example: "Visa"

pointOfSalestring(string (predefined by the client))

The point of sale used in the order.

Example: "home"

channelstring

The channel used in the order.

Enum"WEB""MOBILE_WEB""MOBILE_APP""CALL_CENTER""AIRPORT_KIOSK""BRANCH""KIOSK""OFFLINE""GDS""OTA"

Example: "WEB"

statusstring

The status of the order.

Enum"BROWSED""CANCELLED""CONFIRMED""DECLINED""PARTIALY_CONFIRMED""PARTIALY_REFUNDED""PAYMENT_PENDING""PENDING""PURCHASED""REFUNDED"

Example: "PURCHASED"

curl -i -X PUT \
  -u <username>:<password> \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orders/{orderRef}' \
  -H 'Content-Type: application/json' \
  -d '{
    "createdAt": "2024-01-01T16:17:16Z",
    "modifiedAt": "2024-01-01T16:17:16Z",
    "orderedAt": "2024-01-01T16:17:16Z",
    "currencyCode": "EUR",
    "price": 50,
    "referenceId": "B94TXY-1",
    "paymentType": "Card",
    "cardType": "Visa",
    "pointOfSale": "home",
    "channel": "WEB",
    "status": "PURCHASED"
  }'

Responses

Successful operation

Bodyapplication/json

refstring(UUID)

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

hrefstring

The link to the order.

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

createdAtstring(date-time)

The date and time when the resource was created in Sitecore CDP.

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

modifiedAtstring(date-time)

The date and time when the resource was updated in Sitecore CDP.

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

orderedAtstring(date-time)

The date and time when the order was made.

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

currencyCodestring(3 letter ISO 4217)

The currency the guest used to complete a purchase.

Example: "EUR"

pricenumber(number (currency))

The amount paid for the order.

Example: 50

referenceIdstring(string)

A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR.

Example: "B94TXY-1"

paymentTypestring(string (title case recommended))

The method of payment for the order.

Example: "Card"

cardTypestring(string (title case recommended))

The card type used to pay for the order.

Example: "Visa"

pointOfSalestring(string (predefined by the client))

The point of sale used in the order.

Example: "home"

channelstring

The channel used in the order.

Enum"WEB""MOBILE_WEB""MOBILE_APP""CALL_CENTER""AIRPORT_KIOSK""BRANCH""KIOSK""OFFLINE""GDS""OTA"

Example: "WEB"

statusstring

The status of the order.

Enum"BROWSED""CANCELLED""CONFIRMED""DECLINED""PARTIALY_CONFIRMED""PARTIALY_REFUNDED""PAYMENT_PENDING""PENDING""PURCHASED""REFUNDED"

Example: "PURCHASED"

contactsobject(OrderContactResponse)

Contact details, containing a list of items.

consumersobject(OrderConsumerResponse)

Consumer details, containing a list of items.

orderItemsobject(OrderItemResponse)

Order item details, containing a list of items.

Response

application/json

{
  "ref": "2d7de9df-45a2-45ea-872c-30e45139007d",
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d",
  "createdAt": "2024-01-01T16:17:16Z",
  "modifiedAt": "2024-01-01T16:17:16Z",
  "orderedAt": "2024-01-01T16:17:16Z",
  "currencyCode": "EUR",
  "price": 50,
  "referenceId": "B94TXY-1",
  "paymentType": "Card",
  "cardType": "Visa",
  "pointOfSale": "home",
  "channel": "WEB",
  "status": "PURCHASED",
  "contacts": {
    "items": []
  },
  "consumers": {
    "items": []
  },
  "orderItems": {
    "items": []
  }
}

Partially update an order

Request

Partially updates an order. You can update orders that have the same referenceId and have orderedAt values (purchase dates) within two days of another. referenceId and orderedAt cannot be updated.

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

currencyCodestring(3 letter ISO 4217)required

The currency the guest used to complete a purchase. Set this to the organization’s default currency.

Example: "EUR"

orderedAtstring(date-time)required

The date and time when the order was made.

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

pricenumber(number (currency))required

The amount paid for the order.

Example: 50

referenceIdstring(string)required

A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR.

Example: "B94TXY-1"

createdAtstring(date-time)

The date and time when the resource was created in Sitecore CDP.

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

modifiedAtstring(date-time)

The date and time when the resource was updated in Sitecore CDP.

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

paymentTypestring(string (title case recommended))

The method of payment for the order.

Example: "Card"

cardTypestring(string (title case recommended))

The card type used to pay for the order.

Example: "Visa"

pointOfSalestring(string (predefined by the client))

The point of sale used in the order.

Example: "home"

channelstring

The channel used in the order.

Enum"WEB""MOBILE_WEB""MOBILE_APP""CALL_CENTER""AIRPORT_KIOSK""BRANCH""KIOSK""OFFLINE""GDS""OTA"

Example: "WEB"

statusstring

The status of the order.

Enum"BROWSED""CANCELLED""CONFIRMED""DECLINED""PARTIALY_CONFIRMED""PARTIALY_REFUNDED""PAYMENT_PENDING""PENDING""PURCHASED""REFUNDED"

Example: "PURCHASED"

curl -i -X PATCH \
  -u <username>:<password> \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orders/{orderRef}' \
  -H 'Content-Type: application/json' \
  -d '{
    "createdAt": "2024-01-01T16:17:16Z",
    "modifiedAt": "2024-01-01T16:17:16Z",
    "orderedAt": "2024-01-01T16:17:16Z",
    "currencyCode": "EUR",
    "price": 50,
    "referenceId": "B94TXY-1",
    "paymentType": "Card",
    "cardType": "Visa",
    "pointOfSale": "home",
    "channel": "WEB",
    "status": "PURCHASED"
  }'

Responses

Successful operation

Bodyapplication/json

refstring(UUID)

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

hrefstring

The link to the order.

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

createdAtstring(date-time)

The date and time when the resource was created in Sitecore CDP.

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

modifiedAtstring(date-time)

The date and time when the resource was updated in Sitecore CDP.

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

orderedAtstring(date-time)

The date and time when the order was made.

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

currencyCodestring(3 letter ISO 4217)

The currency the guest used to complete a purchase.

Example: "EUR"

pricenumber(number (currency))

The amount paid for the order.

Example: 50

referenceIdstring(string)

A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR.

Example: "B94TXY-1"

paymentTypestring(string (title case recommended))

The method of payment for the order.

Example: "Card"

cardTypestring(string (title case recommended))

The card type used to pay for the order.

Example: "Visa"

pointOfSalestring(string (predefined by the client))

The point of sale used in the order.

Example: "home"

channelstring

The channel used in the order.

Enum"WEB""MOBILE_WEB""MOBILE_APP""CALL_CENTER""AIRPORT_KIOSK""BRANCH""KIOSK""OFFLINE""GDS""OTA"

Example: "WEB"

statusstring

The status of the order.

Enum"BROWSED""CANCELLED""CONFIRMED""DECLINED""PARTIALY_CONFIRMED""PARTIALY_REFUNDED""PAYMENT_PENDING""PENDING""PURCHASED""REFUNDED"

Example: "PURCHASED"

contactsobject(OrderContactResponse)

Contact details, containing a list of items.

consumersobject(OrderConsumerResponse)

Consumer details, containing a list of items.

orderItemsobject(OrderItemResponse)

Order item details, containing a list of items.

Response

application/json

{
  "ref": "2d7de9df-45a2-45ea-872c-30e45139007d",
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d",
  "createdAt": "2024-01-01T16:17:16Z",
  "modifiedAt": "2024-01-01T16:17:16Z",
  "orderedAt": "2024-01-01T16:17:16Z",
  "currencyCode": "EUR",
  "price": 50,
  "referenceId": "B94TXY-1",
  "paymentType": "Card",
  "cardType": "Visa",
  "pointOfSale": "home",
  "channel": "WEB",
  "status": "PURCHASED",
  "contacts": {
    "items": []
  },
  "consumers": {
    "items": []
  },
  "orderItems": {
    "items": []
  }
}

Delete an order

Request

Deletes an order. An empty, 204 No Content response means that the deletion was successful.

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

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

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"
}

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

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

Create an order

Request

Responses

Was this helpful?

List orders

Request

Responses

Was this helpful?

Retrieve an order

Request

Responses

Was this helpful?

Update an order

Request

Responses

Was this helpful?

Partially update an order

Request

Responses

Was this helpful?

Delete an order

Request

Responses

Was this helpful?

Order item

Order contact

Order consumer

Order data extension

Order item data extension