latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-101025471.3 MB

69be73b5cff0

Examine

Examine earning rules

Estimates earning opportunities for a customer without triggering any actual earning for loyalty v2 earning rules. The trigger selects whether all trigger events or one specific event is examined. When a specific event is selected, exactly one matching context object is required: customer_order_paid for customer.order.paid, customer_segment_entered for customer.segment.entered, and customer_custom_event for customer.custom_event. The other context objects must not be present.

This endpoint can examine earning rules for all loyalty programs the customer belongs to by using customer_identification with customer_id or customer_source_id. To examine earning rules only for one program, use member_id in customer_identification, as member_id is loyalty program-specific.

post/v2/loyalties/examine/earning-rules

Request body

Response

Earning rules examination result

eventstring nullable

Examined trigger event (e.g. customer.order.paid, customer.segment.entered, customer.custom_event). null when trigger.type is ALL.

object'earnings_examine_result'

Object type marker. Always earnings_examine_result.