EstimateAccrual1

Estimates how many loyalty points a customer would earn for a given order, with support for tier preview based on customer data.

This function allows you to predict how many points would be awarded for a specific order before it's actually placed or processed. This is useful for showing customers their potential point earnings during the checkout process.

The function uses the same Order2 format as the UpdateOrders4 call, making it easy to estimate points for an order before submitting it.

If customer identity is not provided or the customer doesn't exist, the function behaves as if invoked on an empty customer record.

EstimateAccrual1 can preview tier changes based on customer data provided in the order. If the order includes customer tags that would result in a different tier, the API calculates what tier the customer would be in based on the provided tags, and returns an accurate estimate based on the previewed tier, but does not persist the tier change beyond the scope of the call.

Input

• customer CustomerIdentity1 optional

  Identity of the customer placing the order (optional if included in the order object).

• order Order2 required

  The order to estimate points for, using the same format as UpdateOrders4.

  The order object can include customer data with tags, which will be used to preview tier changes for tag-based tier systems. The customer data in the order (including tags) affects the tier calculation but is not saved to the database.

  For tag-based tiers, include the customer's tags in order.customer.tags to get accurate point estimates based on the tier those tags would grant.

Output

• pts integer required

  The estimated number of points the customer would earn for this order.

• lines array of OrderLineDetails1 required

  Detailed breakdown of point calculations for each order line item.

  Each line item includes information about the subtotal, accrual amount, points, and any applicable multipliers or discounts.

• accrual_debug_info string required

  Debug information about how the points were calculated.

  This is intended for development and troubleshooting, not for displaying to end users.

{
  "order": {
    "amount_spent": "110.00",
    "amount_subtotal": "100.00",
    "id": "ORDER-123"
  }
}

{
  "accrual_debug_info": "Base earning: 100 points (1:1 ratio)",
  "lines": [
    {
      "accrual_amount": "100.00",
      "id": "ORDER-123",
      "multiplier": 1,
      "pts": 100,
      "subtotal": "100.00"
    }
  ],
  "pts": 100
}

{
  "order": {
    "amount_spent": "110.00",
    "amount_subtotal": "100.00",
    "customer": {
      "id": "CUST-789",
      "tags": [
        "VIP",
        "Premium"
      ]
    },
    "id": "ORDER-456"
  }
}

{
  "accrual_debug_info": "VIP tier multiplier applied: 2x points",
  "lines": [
    {
      "accrual_amount": "100.00",
      "id": "ORDER-456",
      "multiplier": 2,
      "pts": 200,
      "subtotal": "100.00",
      "tier_id": "TIER-VIP",
      "tier_name": "VIP Member"
    }
  ],
  "pts": 200
}

API-wide Errors

Global Errors