Offers Consumer Listing
Gets a paginated list of all offers available for the current consumer: generic offers + offers where this consumer is targeted.
For all your logged consumers, you must actually use this route to retrieve the best set of offers dedicated to each consumer.
This list can be filtered by offer types, start date, end date, universe, highlight level…
The list contains all the active offers (status = ACTIVE) and offers to come (status = PUBLISHED).
This list is sorted by default using the conversion probability computed by our internal smart ranking engine.
Pagination of 20 items by default.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The id you used to create the given consumer
Query Parameters
Offer availability: ONLINE if the offer is online only. OFFLINE if the offer is offline only. BOTH if the offer is online and offline
ONLINE, OFFLINE, BOTH Filter by brand__name
Name of the brand
Filter by brand_id
Filter by cashback_rate
Rate of reward used to calculate cashback amount
Filter by created_at
Filtering on date of creation between -- after -- before --
Filter by default_cashback_rate
Filter by end_date
Filtering on end date between -- after -- before --
Enum in: HIGHEST, HIGH, NORMAL. For a contextual display (banner, carousel etc...), this value is set by the program manager on each offer
HIGHEST, HIGH, NORMAL Filter by is_boosted
Filter by is_consumed
Has the consumer already consumed the coupon of the current offer? If true, yes. If false, no.
Filter by is_favorite
TRUE if the offer is liked by consumer, FALSE if not
Filter by loyalty_counter
Purchases made by the Consumer.
Filters all loyalty_counter higher than those provided in loyalty_counter__gt.
Filters all offers depending on whether they are a loyalty_offer or not. If "true", retrieves all the Offers that are not of loyalty type. If "false", retrieves all the Offers of loyalty type.
Filter by loyalty_frequency
Number of purchases before the customer gets a reward.
Filters all loyalty_frequency higher than those provided in loyalty_frequency__gt.
Filters all offers depending on whether they are a loyalty_offer or not. If "true", retrieves all the Offers that are not of loyalty type. If "false", retrieves all the Offers of loyalty type.
Filter by name
Name of the object
the page number
x >= 1the number of elements per page
1 <= x <= 100Filter by publication_date
Filtering on publication date between -- after -- before --
Filter by reference
Unique reference of the offer. Human readable, made out from the concatenation of the brand name + creation date + increment.
Sort by given attribute
created_at, start_date, end_date, publication_date, name, reference, type, application_channel, brand__name, brand_id, highlight_level, status, source_transaction, cashback_rate, default_cashback_rate, universe, loyalty_frequency, loyalty_counter, is_favorite, is_consumed, -created_at, -start_date, -end_date, -publication_date, -name, -reference, -type, -application_channel, -brand__name, -brand_id, -highlight_level, -status, -source_transaction, -cashback_rate, -default_cashback_rate, -universe, -loyalty_frequency, -loyalty_counter, -is_favorite, -is_consumed Filter by source_transaction
If this flag is true, the transaction must come from the default bank of the program to generate a reward
Filter by start_date
Filtering on start date between -- after -- before --
Filter by status
Filter by type
CASHBACK, UNIQUE_COUPON, GENERIC_COUPON, VOUCHER, AFFILIATION, LBS_CASHBACK Filter by universe
Universe of the brand