Retrieve the URL for an order's data extension

Request

Retrieves the URL for the order's data extension. This lets you check if the data extension exists.

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

Query

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

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

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/2d7de9df-45a2-45ea-872c-30e45139007d/extensions?expand=true&offset=0&limit=40'

Responses

Successful operation

Bodyapplication/json

namestring

The name of the data extension.

Example:"ext"

offsetinteger, (int32)

The request's offset.

Example:0

limitinteger, (int32)

The request's limit.

Example:10

firstobject(OrderDataExtensionFirstLink)

The request's first list of order data extensions URL.

lastobject(OrderDataExtensionLastLink)

The request's last list of order data extensions URL.

nextobject(OrderDataExtensionNextLink)

The request's next list of order data extensions URL.

hrefstring

The request's URL.

Example:"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions/ext"

itemsArray of objects(OrderDataExtensionLink)

The request's data extension items.

orderobject(OrderHref)

Response

{
  "name": "ext",
  "offset": 0,
  "limit": 10,
  "first": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions"
  },
  "last": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions"
  },
  "next": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions"
  },
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions/ext",
  "items": [
    { … }
  ],
  "order": {
    "href": "https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51"
  }
}