Calculate Expected Loyalty Points

Estimates how many points a member (or anonymous guest) would earn for a given purchase, before the transaction is submitted. This is a read-only preview endpoint — it does not create transactions or credit wallets.

Supports two modes:

  • Single-item mode — send amount and optionally sku. Used for product detail page point previews.
  • Checkout mode — send a non-empty items array. Used for full cart or checkout point previews.

The calculation respects vendor wallet configuration (exchange rate, rounding, gross vs net-of-fees base), member tier multipliers when member_id is provided, ignored SKU rules, and active product points multiplier promotions.

When wallets are disabled for the vendor or member, returns { "points": 0, "base_points": 0, "bonus": [] }.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for the Points Calculator endpoint. Supports two modes:

  • Single-item mode — provide amount and optionally sku. Do not send items. Used for product detail page previews.
  • Checkout mode — provide a non-empty items array. amount is optional and will be derived from line items plus fees if omitted. Used for full cart/checkout previews.

If neither items nor amount is provided, the request returns a 400 error.

uuid

Member UUID. When provided, tier-based point multipliers are applied. Omit for anonymous or guest previews.

integer

Total purchase amount in cents (e.g. $49.99 = 4999). Required in single-item mode. In checkout mode, if omitted, computed as the sum of line item totals plus shipping_fee and payment_fee.

integer
Defaults to 0

Shipping fee in cents. Subtracted from the base amount when the wallet is configured for net-of-fees calculation.

integer
Defaults to 0

Payment processing fee in cents. Subtracted from the base amount when the wallet is configured for net-of-fees calculation.

string

Product SKU. Single-item mode only. Used to evaluate product points multiplier promotions and ignored-SKU rules. Ignored when items is provided.

items
array of objects

Line items for checkout mode. When this array is non-empty, checkout mode is used and the root-level sku field is ignored.

items
discounts
array of integers

Order-level discount amounts in cents. Distributed proportionally across line items when item-level discount_allocations are not provided. Checkout mode only.

discounts
Responses

401

Unauthorized — missing or invalid Bearer token.

403

Forbidden — API token lacks the required ROLE_WRITE_SEGMENT role.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json