Skip to main content
Orders represent e-commerce purchase transactions. The Order API tracks purchases, automatically triggers loyalty campaigns, calculates cashback, and awards points in a single unified operation.

​
Order Structure

​
Core Fields

FieldTypeDescription
customerIdStringUnique customer identifier
orderIdStringYour unique order/transaction ID
orderDateString (ISO 8601)When the order was placed
totalPaidNumberFinal amount customer paid
totalPriceNumberOrder total before discounts
totalDiscountNumberTotal discount applied
totalShippingNumberShipping cost

​
Line Items

Array of purchased items:
FieldTypeDescription
productIdStringUnique product identifier
skuStringStock keeping unit
titleStringProduct name
priceNumberItem price
quantityNumberQuantity purchased
categoryArrayProduct categories
collectionArrayProduct collections
vendorStringBrand or supplier
weightNumberItem weight
tagArrayProduct tags

​
Example Order

{
  "customerId": "customer_123",
  "orderId": "ORD12345",
  "orderDate": "2024-10-16T08:13:29.290Z",
  "totalPaid": 500.00,
  "totalPrice": 500.00,
  "totalShipping": 10.00,
  "lineItems": [
    {
      "productId": "PROD98765",
      "sku": "SKU98765",
      "title": "Black Sneakers",
      "price": 500.00,
      "quantity": 1,
      "category": ["Shoes"],
      "collection": ["Summer2024"]
    }
  ]
}

​
Orders vs Events vs Payments

  • Orders: E-commerce with products/SKUs
  • Events: Custom user actions
  • Payments: Non-commerce transactions (bills, subscriptions)

​
Redemption During Orders

​
Redeem Points

{
  "redemption": {
    "pointsHoldReference": "hold_ref_123"
  }
}

​
Apply Coupons

{
  "redemption": {
    "couponsLockReference": "lock_ref_456"
  }
}

​
Order Features

FeatureAPIPurpose
Order TrackingPOST /api/v4.0/integrations/ordersSubmit orders and award points
Calculate CashbackPOST /api/v4.0/integrations/orders/calculatePreview points before checkout
Order TransactionsGET /api/v4.0/integrations/orders/{orderId}/transactionsRetrieve order history

Submit Orders Tutorial

Complete implementation guide

Order Tracking API

API endpoint documentation