Create an order data extension

Request

Creates an order data extension.

To avoid creating key-value pairs that already exist in the data extension for an order, first retrieve all the data extensions for an order to check that the keys you intend to create are unique.

Creating the request body

In the request body, you must provide one object. This object represents the data extension. Note the following about the object:

Can contain primitive values only. You cannot nest objects. If you need to group key-value pairs, use prefixes for the key names.
Can contain a maximum of 100 key-value pairs.
The key-value pairs you include in the object become the extension data. For example, if you include "firstTimeOrder": true in the object, First Time Order with the value of true becomes extension data.
Supported data types for the values:
- string, for example "level2"
- boolean, for example true
- integer, for example 9
- floating-point number, for example 99.9

Naming keys

The keys you enter in the request body must be:

Alphanumeric [A-Z,a-z,0-9] as per the JSON RFC 7159 specification.
In camel case.

Example request body

Here's an example request body:

{ 
"firstTimeOrder": true, 
"storeLocation": "London", 
"totalUnits": 8, 
"totalDiscount": "20%"
}

This creates four key-value pairs for the order.

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

dataExtensionNamestringrequired

The data extension name. You must set this to ext.

Example:ext

Bodyapplication/json

{exampleKey1}string or boolean or integer or number

A key-value pair of your choice. Supported data types for the values: string, boolean, integer, floating-point number. Example: "firstTimeOrder": true

Example:"{exampleValue1}"

{exampleKey2}string or boolean or integer or number

A key-value pair of your choice. Supported data types for the values: string, boolean, integer, floating-point number. Example:"storeLocation": "London"

Example:"{exampleValue2}"

curl -i -X POST \
  -u '<username>:<password>' \
  https://api-engage-ap.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d/extensions/ext \
  -H 'Content-Type: application/json' \
  -d '{
    "{exampleKey1}": "{exampleValue1}",
    "{exampleKey2}": "{exampleValue2}"
  }'

Responses

Resource successfully created

Bodyapplication/json

namestring

The name of the data extension.

Example:"ext"

hrefstring

The URL of the order extension.

Example:"https://api-engage-eu.sitecorecloud.io/v2.1/orders/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/extensions/ext"

refstring

The order extension reference.

Example:"6a5cb3c2-1a4a-56d8-8a01-1ede232b9db2"

keystring

The value "default".

Example:"default"

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 last updated in Sitecore CDP.