Skip to main content
Users
CloudPortalLogin
  • Powered byPowered by
Developing with Sitecore CDP
Data privacy
Before you start sending data
Integrating with Sitecore CDP
Stream API
Batch API
REST APIs
Data lake export service
  • Sitecore CDP for developers
  • REST APIs
  • Legacy REST APIs
  • Order REST API v2 (legacy)
  • Differences between v2 and v2.1 of the Order REST APIs

Differences between v2 and v2.1 of the Order REST APIs

If your instance of Sitecore CDP is using the 2.1 data model, we recommend that you upgrade to REST APIs version 2.1 of the Order REST APIs. The APIs include:

  • Order REST API

  • Order item REST API

  • Order contact REST API

  • Order consumer REST API

  • Order data extension REST API

  • Order item data extension REST API

Here's an overview of the main differences between version 2 and version 2.1:

v2

v2.1

URI paths

URI paths contain /v2/.

URI paths contain /v2.1/.

Endpoints for partial operations

  • Partial updates and partial deletions are not available.

  • Updates and deletions affect the entire resource.

  • New PATCH endpoints let you partially update resources. For example, you can update certain key-value pairs in an order item data extension without affecting others.

  • New DELETE endpoints let you delete certain key-value pairs from an order data extension or an order item data extension without affecting others.

Endpoints for order item data extensions

This version of the REST APIs does not have endpoints for order item data extensions.

Working with order item data extensions is only available using the Batch API.

New endpoints let you work with order item data extensions.

See examples of order items with data extensions you can create.

Data extension key-value pairs

You must manually include "key":"default" in the request body when you work with data extensions.

The key attribute is automatically set.

Order item types

The type of the order item must be one of a list of allowed values.

The type of the order item can be any value except for the following:

  • "FLIGHT"

  • "HOTEL"

  • "MORTGAGE"

  • "MORTGAGE_APPLICATION"

  • "LOAN_APPLICATION"

  • "PERSONAL_LOAN"

  • "RAIL"

See examples of order items you can create.

Do you have some feedback for us?

If you have suggestions for improving this article,

Privacy policySitecore Trust CenterCopyright © 1999-2026 Sitecore