Estimate loyalty points

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/qualifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "customer": {
    "source_id": "customerSourceID",
    "metadata": {
      "reason": "loyaltyQualifications"
    }
  },
  "order": {
    "source_id": "ord_113628fa0685537f99",
    "metadata": {
      "source": "qualifyPoints"
    }
  }
}
'

{
  "campaign": {
    "id": "camp_6hAtKbSF3iMj8wN8HjlvPuQG",
    "name": "Loyalty-campaign",
    "object": "campaign"
  },
  "points_estimation": 51
}

Estimate loyalty points

Estimates the number of points a customer will receive for a given order in the loyalty campaign under its earning rules.

This endpoint returns only an estimation, not a precise point value.

Also, this estimation works only for the Order paid earning rules. If a campaign includes tiers, mappings, and multiple earning rules, the calculation becomes more complex. During final calculation, a customer may change tiers and earn more or fewer points depending on other factors.

POST

loyalties

{campaignId}

qualifications

Estimate loyalty points

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/qualifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "customer": {
    "source_id": "customerSourceID",
    "metadata": {
      "reason": "loyaltyQualifications"
    }
  },
  "order": {
    "source_id": "ord_113628fa0685537f99",
    "metadata": {
      "source": "qualifyPoints"
    }
  }
}
'

{
  "campaign": {
    "id": "camp_6hAtKbSF3iMj8wN8HjlvPuQG",
    "name": "Loyalty-campaign",
    "object": "campaign"
  },
  "points_estimation": 51
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

campaignId

string

required

Unique campaign ID of the loyalty program.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

Body

application/json

Provide customer source_id and order source_id.

Request body schema for estimating loyalty points for an order with POST /loyalties/{campaignId}/qualifications.

customer

Customer · object

required

Show child attributes

customer.id

string

The ID of an existing customer.

customer.source_id

string

A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored.

customer.name

string

Customer's first and last name.

customer.description

string

An arbitrary string that you can attach to a customer object.

customer.email

string

Customer's email address.

customer.phone

string

Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.

customer.birthday

string<date>

Deprecated. ~~Customer's birthdate; format YYYY-MM-DD~~.

customer.birthdate

string<date>

Customer's birthdate; format YYYY-MM-DD.

customer.address

object

Customer's address.

Show child attributes

customer.address.city

string

City

customer.address.state

string

State

customer.address.line_1

string

First line of address.

customer.address.line_2

string

Second line of address.

customer.address.country

string

Country.

customer.address.postal_code

string

Postal code.

customer.metadata

object

A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.

order

object

required

Details regarding the order being processed.

Show child attributes

order.source_id

string

The unique ID assigned by Voucherify of an existing order that will be linked to the loyalty point estimation (qualification). This property can be also sent as id instead.

order.metadata

object

A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.

order.amount

integer

A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. Use if the related order doesn't have an amount value calculated.

Response

Returns campaign details and estimated number of points.

Response body schema for estimating loyalty points for an order with POST /loyalties/{campaignId}/qualifications.

campaign

object

required

Details about the campaign associated with the estimation.

Show child attributes

campaign.id

string

required

The unique identifier for the campaign, assigned by Voucherify.

campaign.name

string

required

The human-readable name of the campaign.

campaign.object

enum<string>

required

The type of the object represented by JSON.

Available options:

campaign

points_estimation

integer

required

The calculated estimation of points based on the order data and loyalty campaign's earning rules.

Last modified on December 15, 2025

Redeem Reward with campaign ID List Reward Assignments with campaign ID

⌘I

Introduction

Endpoints

Events

Estimate loyalty points

Authorizations

Path Parameters

Body

Response