Fetch Aggreegated Offers (Aggregated Redemption Rules)

get

https://platform.nector.io/api/v2/merchant/aggreegatedoffers

Fetches the aggregated redemption rules of your loyalty program, i.e. the offers against which a customer can redeem their coins (ex. every 100 coins = 10 off, free shipping, free product).

Only offers in published or listed status are returned
published: the offer is active and visible, the customer can avail (redeem) it via Offer Reward or Redeem APIs
listed: the offer is visible for display only, it cannot be availed. Use it to show upcoming or locked rewards
Offers in active status are redeemable but hidden, offers in draft status are inactive. Neither is returned by this API
Pass tier and/or membership of the logged in customer (from the leads object) to get the universal offers (no tier / membership restriction) plus the offers restricted to that tier / membership. Pass nothing (or null) for guest users to get only the universal offers
An unknown tier or membership is silently ignored
classification defaults to loyalty. Pass an integration classification (ex. integration_shopifypos) to fetch the offers configured for that integration
Up to 50 offers are returned, ordered by created_at ascending
Response is cached on our side for up to 10 minutes, so changes made on the dashboard can take up to 10 minutes to reflect
Use this API along with Fetch Aggreegated Details (program settings) and Fetch Triggers (earning rules) to render the complete loyalty program
Prefer cachefront.nector.io for this call

Response data contains

businessoffers: your own offers, { items: array of offers (_id, name, description, classification, tier, membership, rule_type, rule, expire_after_day, redirect_link, status, availed, used, view, meta), count }
brandoffers: cross selling offers from partner brands (publicoffers), { items: array of publicoffers, count }

How to use the offer ids

businessoffers items _id is the offer_id to pass to Reward Offer (POST /offerrewards) and Redeem Offer (POST /offerredeems)
brandoffers items _id is the publicoffer_id to pass to Reward Cross Selling Offer (POST /publicofferrewards) and Redeem Cross Selling Offer (POST /publicofferredeems)
For a closed loop loyalty program (customers redeem only against your own brand) read businessoffers only and skip brandoffers
brandoffers is relevant only for an open loop loyalty program where customers can also redeem coins against partner brand offers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

tier

string | null

(This needs to be leads tier value or null) (Pass the tier of the logged in customer to also get the offers restricted to that tier) (Ignored if the tier does not exist)

membership

string | null

(This needs to be leads membership value or null) (Pass the membership of the logged in customer to also get the offers restricted to that membership) (Ignored if the membership does not exist)

classification

string | null

(This can only be one of loyalty,shopifyfunction_automaticdiscount,integration_shopifypos,integration_logicerp,integration_zwingpos,integration_queuebusterpos,integration_fyndpos,integration_wondersoftpos,integration_custompos,integration_gokwik,integration_razorpay,integration_pragma,integration_fastrr,integration_juspay,integration_shopflo,integration_flexype,integration_cashfree,integration_customcheckout,action_checkoutcheckbox,action_checkoutpage,other) (Defaults to loyalty)

Headers

x-source

string

enum

required

(Required) (This can only be one of mobile,web) (web for browsers and servers, mobile for native apps)

Allowed:

x-apikey

string

required

(Required) (This needs to be your apikey) (Read only api key is sufficient)

x-workspaceid

string

required

(Required) (This needs to be your workspaceid)

Responses

200200

5XXUnexpected error on our side. Retry with backoff and share meta.request_id with [email protected] if it persists