v20250905 – Added

Loyalty

Estimate how many loyalty points your customers will receive with a new endpoint: POST /v1/loyalties/{campaignId}/qualifications.

See the sample request and response:

{  
    "customer": {  
        "source_id": "customerSourceID",  
        "metadata": {  
            "reason": "loyaltyQualifications"  
        }  
    },  
    "order": {  
        "id": "ord_113628fa0685537f99",  
        "metadata": {  
            "source": "qualifyPoints"  
        }  
    }

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

🚧

Point estimation

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.