Sending orders
Managing orders in real-time
Use the Stream API to collect and send order data in real-time to Sitecore CDP, including when an order is created. There are several order-related events you can send as a guest interacts with your site, for example, when a guest adds a product to their shopping cart, makes a purchase, or empties their shopping cart.
All order and order item information is captured and is visible in the guest profile.
To ensure that the order is created, you must send the required events, in the correct order, and model the event object based on one of the following integration options:
-
If your organization is using the Engage SDK to integrate, see sending orders for details on the events that are required to create an order. This is the preferred method for sending orders to Sitecore CDP.
-
If your organization is not using the Engage SDK to integrate, see sending orders for details on the events that are required to create an order.
You cannot update or delete an order using Stream API. To do this, use the Batch API or REST API.
Managing orders synchronously
Use the REST API to synchronously create and update orders and order items in Sitecore CDP.
To ensure the order data is available in the UI, you must follow the guidelines for the order data model and order item data model for REST API.
Offline order submission
Use the Batch API to create, update and delete offline orders. You can use offline order submission with the Batch API to do any of the following:
-
Submit a large amount of historical orders from a data lake or data warehouse as a once-off, when your organization first integrates with Sitecore CDP.
-
Submit offline orders from a third-party system, such as a call center.
-
Submit orders for guests who block cookies or who use an anonymous browser.
-
Submit complete orders if your organization submits partial orders using Stream API.
-
Update orders submitted with Stream API on a daily basis.
You can use an order data extension to send additional order data to Sitecore CDP that isn't part of the order data model. An order data extension is an array that enables you to specify whatever name/value pairs (attributes) your organization wants. This lets your organization capture additional information about the order, view it in their guest profile, and use that data in batch segmentation, just like you can with other order data.
You can also use an order item data extension to send additional order item data to Sitecore CDP that isn't part of the order item data model. An order item data extension has the same traits as an order data extension.
To ensure the order data is available in the UI, you must follow the guidelines for the order data model, order extension data model, order item data model, and order item extension data model for the Batch API.