v1

latestOpenAPI 3.0.02026-07-26868170.3 KB
Reward

List rewards

Get the list of created rewards.

get/loyalty/v2/rewards

Query parameters

limitinteger

Number of items displayed.

orderstring

display result asc or desc

sortstring

display result sorting by a result field (nqp_value is the only allowed field)

beforestring

Display elements before cursor X.

afterstring

Display elements after cursor X.

namestring

allows search on name property. Operators: equals, not equals, contains, begins, ends

external_idstring

allows search on external_id property. Operators: equals, not equals, contains, begins, ends

monetarystring

allows search on monetary property. Operators: equals, not equals

monetary_typestring

allows search on monetary_type property. Operators: equals, not equals, contains, begins, ends

monetary_valuestring

allows search on monetary_value property. Operators: equals, not equals, gt, gte, lt, lte

nqp_valuestring

allows search on nqp_value property. Operators: equals, not equals, gt, gte, lt, lte

descriptionstring

allows search on description property. Operators: equals, not equals, contains, begins, ends

rich_descriptionstring

allows search on rich_description property. Operators: equals, not equals, contains, begins, ends

image_urlstring

allows search on image_url property. Operators: equals, not equals, contains, begins, ends

holding_daysstring

allows search on holding_days property. Operators: equals, not equals, gt, gte, lt, lte

validity_interval_typestring

allows search on validity_interval_type property. Operators: equals, not equals, contains, begins, ends

validity_interval_countstring

allows search on validity_interval_count property. Operators: equals, not equals, gt, gte, lt, lte

forced_validitystring

allows search on forced_validity property. Operators: equals, not equals

forced_validity_startstring

allows search on forced_validity_start property. Operators: equals, not equals, gt, gte, lt, lte

forced_validity_endstring

allows search on forced_validity_end property. Operators: equals, not equals, gt, gte, lt, lte

limitedstring

allows search on limited property. Operators: equals, not equals

auto_generatedstring

allows search on auto_generated property. Operators: equals, not equals

max_attribution_countstring

allows search on max_attribution_count property. Operators: equals, not equals, gt, gte, lt, lte

c0string

This is filter to apply to request. c0 is an exemple but how can use all custom field by name or id. Payload has give value and comparaison operator: c0={value: 12, operator: lte}. Operator depend on your filed type (text, number, date)

Response

Rewards retrieval is successful.