v1

latestOpenAPI 3.0.02026-07-26868170.3 KB
Points

Point list by universe endpoint

Point list by universe endpoint

get/loyalty/points

Query parameters

limitstring

Number max of results returned.

beforestring

Cursor hash returned on your last call.

afterstring

Cursor hash returned on your last call.

order'asc' | 'desc'

Order of return point list (asc or desc).

sort'ValueDate' | 'EventDate' | 'ID'

Sort by ID and/or EventDate.

card_codestring

Search on card_code. Format: {"operator":"equals","value":"my_card_code"}. Operators: equals, not equals, contains, begins, ends

tier_namestring

Search on tier_name. Format: {"operator":"equals","value":"my_tier"}. Operators: equals, not equals, contains, begins, ends, is empty, is not empty

id_programstring

Search on id_program. Format: {"operator":"equals","value":"123"}. Operators: equals, not equals, gt, gte, lt, lte

id_individualstring

Search on id_individual. Format: {"operator":"equals","value":"my_id"}. Operators: equals, not equals, contains, begins, ends

rule_namestring

Search on rule_name. Format: {"operator":"equals","value":"my_rule"}. Operators: equals, not equals, contains, begins, ends, is empty, is not empty

program_namestring

Search on program_name. Format: {"operator":"equals","value":"my_program"}. Operators: equals, not equals, contains, begins, ends

points_creditedstring

Search on points_credited. Format: {"operator":"gte","value":"100"}. Operators: equals, not equals, gt, gte, lt, lte

points_earnedstring

Search on points_earned. Format: {"operator":"gte","value":"100"}. Operators: equals, not equals, gt, gte, lt, lte

points_remainingstring

Search on points_remaining. Format: {"operator":"gte","value":"50"}. Operators: equals, not equals, gt, gte, lt, lte

event_datestring

Search on event_date. Format: {"operator":"gte","value":"2024-01-01"}. Operators: equals, not equals, gt, gte, lt, lte, on date

value_datestring

Search on value_date. Format: {"operator":"gte","value":"2024-01-01"}. Operators: equals, not equals, gt, gte, lt, lte, on date

points_typestring

Search on points_type. Format: {"operator":"equals","value":"my_type"}. Operators: equals, not equals, contains, begins, ends

validity_startstring

Search on validity_start. Format: {"operator":"gte","value":"2024-01-01"}. Operators: equals, not equals, gt, gte, lt, lte, on date

validity_endstring

Search on validity_end. Format: {"operator":"gte","value":"2024-12-31"}. Operators: equals, not equals, gt, gte, lt, lte, on date

statusstring

Search on status. Format: {"operator":"equals","value":"active"}. Operators: equals, not equals, contains, begins, ends

event_type'abandoned_cart' | 'birthday' | 'credit_points' | 'email_clicked' | 'email_opened' | 'order' | 'reward_attribution' | 'reward_burn' | 'subscribe_change' | 'subscription' | 'tier_change' | 'tier_downgrade' | 'tier_upgrade' | 'unsubscription'

Search on event_type. Format: {"operator":"equals","value":"my_event"}. Operators: equals, not equals, contains, begins, ends

Response

Point list returned.