Delete key-value pairs from an order data extension

Request

Deletes the key-value pairs you provide in the name query parameter from a data extension for an order.

For example, if your data extension contains the firstTimeOrder and storeLocation keys, you can delete both keys and their values by making the following request:

{baseURL}/v2.1/orders/{orderRef}/extensions/{dataExtensionName}/fields?name=firstTimeOrder|storeLocation

If you don't provide the query parameter, this operation will empty the data extension: the data extension itself will not be deleted, but all the key-value pairs in it will.

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 name of the data extension. Set this to ext.

Example:ext

Query

nameArray of strings

The fields in the data extension object that you want to delete.

Example:name=withWarranty|color

curl -i -X DELETE \
  -u '<username>:<password>' \
  'https://api-engage-ap.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d/extensions/ext/fields?name=withWarranty%7Ccolor'

Responses

Successful operation

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.

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

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

orderobject(OrderLinkFirst)

The request's first list of orders URL.

Response

{
  "name": "ext",
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/extensions/ext",
  "ref": "6a5cb3c2-1a4a-56d8-8a01-1ede232b9db2",
  "key": "default",
  "createdAt": "2024-01-01T16:17:16Z",
  "modifiedAt": "2024-01-01T16:17:16Z",
  "{exampleKey1}": "{exampleValue1}",
  "{exampleKey2}": "{exampleValue2}",
  "order": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"
  }
}