get
https://platform.nector.io/api/v2/merchant/aggreegateddetails
Fetches the complete configuration of your loyalty program in a single call. Call this once when your app or website loads and cache the result on the client.
- Pass tier and/or membership of the logged in customer (from the leads object) to get the rules applicable to that tier / membership. Pass nothing (or null) for guest users to get the base rules
- An unknown tier or membership is silently ignored and the base rules are returned
- 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 Triggers (earning rules) and Fetch Aggreegated Offers (redemption rules) to render the complete loyalty program
- Prefer cachefront.nector.io for this call
Response data contains
- businessinfos: your business entity (_id, workspace_id, integration_identifier, name, business_uri, program_name, coin_name, category, country, currency_code, language, quickdeploy_meta, is_freezed, is_running)
- websdkinfos: storefront widget and page configs (appconfigs) used by the nector web sdk
- planfeatureinfos: plan limits and the features enabled on your plan
- featuresettinginfos: same as planfeatureinfos (kept for backward compatibility)
- actioninfos: action rules of the program keyed by action, ex. loyalty_action (coin earning and spending ratio), tier_action, membership_action, referral_action, review_action, birthday_action, anniversary_action, gender_action, visitor_action, coinexpiry_action, creditexpiry_action, checkoutcheckbox_action, checkoutpage_action, orderrewardrevert_action, orderspentrevert_action, orderspentcreditrevert_action
- integrationinfos: per integration reward rules (identifier, classification, rule_type, rule, status, tier, membership)
- tooltrackinfos: third party tools detected on your storefront (counts of *_track stats for the current day)
- miscinfos: currencyexchangerate of your business currency against usd
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
