If you connected your system to the Orders API, you will see new records every time your customers create a new order. The Orders tab helps you track your customers' orders and all transactional activities. You can manage orders by using the Dashboard or via API

In this article, we'll cover managing orders and using the orders entity in your promotions.


  1. Orders view
  2. Order detailed view
  3. Validation rules
  4. Customer segments
  5. Data export

Orders View

In the Orders dashboard section, you can find a list of all orders. Using the plus, you can manually add a new order record. 

By clicking order id, the app directs you to the detailed order view. 

Order detailed view

Each order stores the cart structure (products and SKUs), the total transaction amount, applied incentives and discounts, customer's data, metadata, and order status:

  • Order Created – order was created.
  • Order Paid – order was redeemed and finalized. 
  • Order Cancelled – order was canceled (you can use the Redemption Rollback feature, which will change the order status from Paid to Cancelled).
  • Order Fulfilled – Order was Created but not Paid. You can define it in a way that seems fit for your system logic as this is an open definition field. 

In the Activity tab, you can see the history of order changes updated in real-time. 

The Metadata tab stores custom attributes added to the order object. You can use order metadata to build custom validation rules and improve your tracking. Here is an example of an order metadata property:

"metadata": {
    "payment_method": "Visa",
    "locale": "pl-en",
    "channel": "mobile_app"

Validation Rules

Besides tracking, syncing orders is also used to execute order-specific validation rules, such as:

  • Introducing limits on cart structure.

  • Introducing limits on cart volume.

If you pass the order entity with validation and/or redemption request, you can execute order-specific validation rules that define the required cart structure and order volume. Validation rules may limit redemptions to specific order amounts or items in the cart. 

You can read more about order-related validation rules in this guide

Customer Segments

Storing orders enables you to divide customers into segments based on their buying activity. You can create a segment that gathers customers with a particular amount spent, number of orders, date of last purchase, and more. Segments can be later used to build validation rules to limit redemptions to a specific group of customers with matching purchase histories (e.g., $15 off for clients who made at least three orders in your online store). 

Read more about segments in this guide

Data export

You can download a CSV file with Orders data. Before you use the export tool, you can apply filters and browse data you're interested in or download the complete orders history. Go to our Data Export article to learn more.

Go to our Developer Guide to read the detailed Order object definition.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us