Jump to Content
Capillary Documentation
HomeUser DocumentationDeveloper DocumentationReleases
Log InCapillary Documentation
Developer Documentation
Log In
HomeUser DocumentationDeveloper DocumentationReleases

api documentation

  • Getting Started
    • Overview
    • API reference index
    • Authentication
      • OAuth
      • Basic authentication
      • Auth for consumer or end-customer apps
    • Authorisation
    • Rate limits
    • API status codes
    • Timezone Management
    • Make your first API request
  • Customer (V1)
    • Change identifier on Auth enginepost
    • Add Customerpost
    • Update customer detailsput
    • Update Customer Identifierpost
    • Search Customersget
    • Get customer detailsget
    • Get Customer Transactionsget
    • Get Customer Redemptionsget
    • Add/Update Customer Notespost
    • Get Customer Notesget
    • Get Customer Interactionsget
    • Add Ticketpost
    • Get Ticket Detailsget
    • Get Referral Detailsget
    • Add/Update Customer Preferencespost
    • Get Customer Preferencesget
    • Update Subscription Detailspost
    • Get Subscription Detailsget
  • Customer (V2)
    • Add Customerpost
    • Update Identifier/Issue Cardpost
    • Upsert customerpost
    • Associate Customerpost
    • Get Customer Detailsget
    • Get customer hierarchy in a user groupget
    • Update Customer Detailsput
    • Update association detailsput
    • Search Customersget
    • Update Subscription Detailspost
    • Get Subscription Detailsget
    • Get Customer Tracker Detailsget
    • Get Points Expiry Scheduleget
    • Get Points Expiry Schedule (Light API)get
    • Get Loyalty Eventsget
    • Get Loyalty Detailsget
    • Get Points Transfer Summaryget
    • Get Points Balanceget
    • Get Customer Tierget
    • Get Points Conversion Scheduleget
    • Get Detailed Customer Coupon Dataget
    • Get Retro Requestsget
    • Get Identifier Change Requestsget
    • Get Goodwill Requestsget
    • Request Goodwill points (Group)post
    • Add Customer Imagepost
    • Delete Customer Imagedelete
    • Link/Delink Cardpost
    • Get Customer Status Logget
    • Get Customer Subscription Logget
    • Get Customer Imageget
    • Get user group customer tracker detailsget
    • Get customer transactionsget
    • Get Customer Interactionsget
    • Status codes
    • Manual Tier Adjustmentpost
  • Customer (V2 Lookup)
    • Update Customer Detailsput
    • Get Customer Detailsget
    • Get Customer IDget
    • Update Customer Statusput
    • Get Subscription Detailsget
    • Get Customer Loyalty Detailsget
    • Get Retro Requestsget
    • Add Customer Imagepost
    • Get Referrals (Lookup)get
    • Get Customer Recommendationsget
    • Get Points Balanceget
    • Get Customer Tierget
    • Get Points Conversion Scheduleget
  • Customer Labels
    • Add Labelspost
    • Get Org Labelsget
    • Tag Customers (to Labels)post
    • Get Customer Labelsget
    • Search Customers by Labelget
  • Transaction
    • Transaction (V1)
      • Add Transactionpost
      • Add Transaction with Local Currencypost
      • Update Transaction Detailspost
      • Cancel Transaction Lineitempost
      • Get Transaction Detailsget
      • Return Transactionpost
      • Retro Transactionpost
    • Transaction (V2)
      • Add/Return transaction (single)post
      • Add/Return Transaction(bulk)post
      • Update Transactionput
      • Update Transactions in Bulkput
      • Get Transaction Detailsget
      • Get transaction details using bill numberget
      • Simulation transaction addpost
      • Expose Evaluation log for an eventpost
      • Status codes
    • Transaction rejection
      • getRejectedTransactionsget
      • getReTriggerStatusget
      • markFailedput
      • retriggerTransactionAddpost
  • Coupon
    • Coupon (V1.1 APIs)
      • Issue Couponpost
      • Resend Couponget
      • Redeem Couponpost
      • Get Coupon detailsget
      • Get Customer Couponsget
      • Is Coupon Redeemableget
      • Get Coupon series detailsget
    • Coupon (V2 APIs)
      • Create coupon seriespost
      • Update coupon seriesput
      • Get coupon series detailsget
      • Issue single couponpost
      • Issue bulk couponspost
      • Issue multiple coupons to a customer from a seriespost
      • Redeem single couponpost
      • Redeem bulk couponspost
      • Check if coupon is Redeemableget
      • Reactivate redeemed couponpost
      • Get coupon detailsget
      • Get All Customer Couponsget
      • Update coupon redeem fieldput
      • Update coupon code expiry dateput
      • Revoke couponpost
    • Coupon Upload (V1 APIs)
      • Upload Coupons (Batch)post
      • Upload Redeemed Couponspost
      • Get Uploaded Coupons' Statusget
      • Get Status of Redeemed Couponsget
  • Points
    • Points (v2)
      • Check if Points Transferablepost
      • Transfer Customer Pointspost
      • Get Points Transfer Detailsget
      • Reverse Redeemed Pointspost
      • Group Points Transferrablepost
      • Transfer Group Pointspost
      • Convert Promised Pointspost
      • Update redeem pointsput
      • Deduct points and alternate currencies from userpost
      • Deduct points and alternate currencies from user using userIdpost
    • Points (v1.1)
      • Check If Points Redeemableget
      • Issue Validation Code (to redeem points)get
      • Redeem Pointspost
    • Points Ledger
      • Get Customer Ledger Balanceget
      • Get Points Ledger Informationget
      • Get Points Ledger Explode infoget
    • Connected Org APIs
      • Get Points Ledger Information in Connected Orgsget
      • Get Points Ledger Explode Info in Connected Orgsget
  • Cards
    • Generate Cardspost
    • Get Card Generation Logget
    • Add Card (Single)post
    • Update Card Details (Single)put
    • Update Card Details (Bulk)put
    • Get Card Detailsget
    • Get Status Logget
    • Limit Active Cards per Customerpost
    • Add Card Number to a Card Seriespost
    • Add External Reference ID to Cardput
  • Search APIs
    • Create search criteriapost
    • Retrieve search criteria detailsget
    • Enable search index of older datapost
    • Perform searchpost
    • Deactivate search criteriadelete
    • Create Data Fieldpost
    • Update Data Fieldput
    • Get Data Field Detailget
    • Perform Search (Cortex API)post
    • Event Transformation using Neo
      • Use Case
      • Quick Start
      • Enable or Update Custom Event Tranformationpost
      • Retrieve Custom Event Config Details for an Entityget
      • Retrieve Custom Event Config Details of Orgget
      • FAQs
      • Best Practices
  • Badges
    • Create badgespost
      • Fixed Window Restriction in Badges
    • Update badgesput
    • Get badge by IDget
    • Get all badgesget
    • Get fixed window detailsget
    • Claim badgepost
    • Unclaim badgepost
    • Update activation status of badgeput
    • Enrol customers for badgespost
    • Issue badge (earn)post
      • Multiple Badge Issuances
    • Issue badge to multiple customerspost
    • Import earned (issued) badges of customerpost
    • Revoke enrolled badgespost
    • Revoke issued badgepost
    • Get badges for customerget
    • Get all customer badgesget
    • Get individual badge details of a customerget
    • Create badges grouppost
    • Update badges groupput
    • Get group by IDget
    • Get all groupsget
    • Create custom field for badgespost
    • Update badge custom fieldput
    • Get badge custom field by IDget
    • Get all badge custom fieldsget
  • Rewards Catalog
    • Create rewardpost
      • Adding revenue metadata against a reward
    • Update Rewardput
    • Create Reward Categorypost
    • Update Reward Categoryput
    • Get Reward Categoryget
    • Create Rich Text Content Metadata for Rewardspost
    • Update Rich Text Content Metadata for Rewardsput
    • Get all Rich Text Content Metadata for specific brandget
    • Adding Rich Text Content field for Rewardpost
    • Claim Rewardpost
    • Issue single rewardpost
      • Reward Issuance with Quantity and Redemption Value Details
    • Issue bulk rewardpost
      • Idempotency Check for Issuing Reward
    • Get rewards for userget
    • Get all brand rewards using Brand IDget
    • Get reward details by IDget
    • Get brand rewardsget
    • Get purchased rewards for user (New API)get
    • Get available reward details for user by idget
    • Get all reward transactions for a userget
    • Get Reward Transaction Details using Reward Transaction IDget
    • Create catalog promotionpost
    • Update catalog promotionput
    • Get catalog promotion detailsget
    • Get list of promotionsget
    • Disable promotionput
    • Get available brand rewardsget
    • Create custom field for rewardpost
    • Update reward custom fieldput
    • Get all custom fieldsget
    • Create reward grouppost
    • Update rewards groupput
    • Get rewards groupget
    • Get rewards group by IDget
    • Create points restrictionpost
    • Update points restrictionput
    • Get points constraintsget
    • Organisation Level Configuration for Rewards Catalogpost
    • Get Organisation Level Configurationget
    • Create a Vendorpost
    • Enable or Disable a Vendorput
    • Create Vendor Redemptionpost
    • Get all vendor redemptionsget
    • Get Vendor list for specific brandget
    • Get Vendor Detailsget
    • Upload images to file servicepost
    • Create fulfillment statuspost
    • Update fulfillment statusput
    • Get fulfillment statusget
    • Update fulfilment status and transaction custom fields for issued rewardsput
    • Create Reward Expiry Reminderpost
    • Update Reward Expiry Reminderput
    • Get Reward Expiry Reminderget
    • Connected Org APIs
      • Get all available rewards for user in connected orgsget
      • Get reward details by ID in connected orgsget
      • Issue Reward in connected orgspost
      • Get purchased rewards for user in connected orgsget
      • Get all reward transactions for a user in connected orgsget
      • Get transaction details by reward transaction ID in connected orgsget
    • Merge User Rewardspost
    • Get User Reward Merge Detailsget
    • Update Vendor Redemptionput
  • Target/Milestone
    • Milestone & Streaks APIs
      • Create target groupspost
      • Update target groupput
      • Get target groups based on IDget
      • Get associated target groups of a userget
      • Get Promotion Dataget
      • Get active targetsget
      • Get all target groupsget
      • Get target periodsget
      • Get targets detailsget
      • Get target communication templateget
      • Upsert target communicationpost
      • Get target channelsget
      • Delete target groupdelete
      • Create target periodpost
      • Update target periodput
      • Create targets (milestone)post
      • Modify targetsput
      • Deactivate targetdelete
      • Create unified target grouppost
      • Update unified targetput
      • Create streakspost
      • Edit streakput
      • Create target based on Behavioural eventpost
      • Create target based on EMF eventpost
      • Create target group based on alternate currenciespost
      • Get all milestones (target)get
      • Enrol/Re-enrol a customer to a milestone/streakpost
      • Unenrol users from a milestone and streakpost
      • Check the Validity of Milestone / Target Namepost
      • Get target eventsget
    • User-Created Challenges
    • Connected Org APIs
      • Enroll/Re-Enroll a Customer to a Milestone or Streakpost
      • Unenroll a Customer to from Milestone or Streakpost
      • Get Associated Target Groups of a Userget
      • Data Scopes
    • Leaderboards
      • Get top ranked usersget
      • Get user rank across target groupsget
  • Loyalty Promotion
    • Introduction
    • Enrol and Issue Promotionpost
    • Revoke Enrolled and Issued Promotionspost
    • Connected Org APIs
      • Get Promotion Data of a Customerget
    • User Created Challenge
      • Create Promotion for UCCpost
    • Get promotion by IDget
    • Get details of all promotionsget
    • Get Promotion Data of a Specific Customerget
    • Get Promotion Benefits for Customerget
  • Cart Promotions
    • Get Cart Promotion Settingsget
    • Get Cart Promotion Redemptionsget
    • Get Cart Promotions code APIget
    • Get Cart Promotions for a particular tillget
    • Get Lock unlock -Pending carts (Cart Promotion)get
    • Get Cart Promotions Config APIget
    • Create Cart Promotionpost
    • Set Cart Promotion Settingspost
    • Earn Cart Promotionpost
    • Deactivate Cart Promotionpost
    • Activate Cart Promotionpost
    • Post Revoke Earned Cart Promotionpost
    • Post Earn Cart Promotions in Bulkpost
    • Post Evaluate Cart Promotionspost
    • Cancel Cart Evaluation - Cart Promotionput
    • Post Cart Promotions Code link APIpost
    • Get Cart Promotions for a Customerget
    • Issue Cart Promotionpost
  • User Group
    • Add Grouppost
    • Update User Groupput
    • Search user groups by name, ID, and mobile numberget
    • Delete User Groupdelete
    • Join Member to Grouppost
    • Remove group memberdelete
    • Transfer Group Memberpost
    • Get group transactionsget
    • Retrieve user group members listget
    • Retrieve user group members list with cards & status detailsget
    • Retrieve Primary & Secondary Member Detailsget
    • Retrieve group slab/tier log historyget
    • Retrieve points expiry schedule of a groupget
    • Retrieve points conversion scheduleget
    • Status codes
    • Update permissionsput
    • Search for groups using the extended fieldspost
  • Organization
    • Organization (V1)
      • Get Org Detailsget
      • Get Org Entitiesget
      • Get Org Configurationsget
      • Get Org Statisticsget
      • Get Top Selling Itemsget
      • Get Org Custom Fieldsget
      • Retrieve Brand IDpost
      • Get Org Payment Modesget
    • Organization (V2)
      • Add Tillpost
      • Update Till with Custom Fieldsput
      • Get Custom Fieldsget
      • Get Config Key Valuesget
      • Get org till detailsget
      • Get Active Tillsget
      • Get Loyalty Programsget
      • Add Storepost
      • Retrieve org hierarchy detailsget
      • Add Store in bulkpost
  • Communications (v2)
    • Send communication messagepost
    • Error code
  • Communications (v1)
    • Send communication messagepost
    • Error code
  • Custom Fields
    • Create a Custom Fieldpost
    • Get Custom Fieldsget
    • Tag Custom Field to an Entitypost
  • Audit logs
    • Get audit logs of entitiesget
    • Get Audit Logs by event nameget
  • PII deletion
    • Add a PII deletion requestpost
    • Update PII deletion statusput
    • Retrieve request status of PII deletionget
    • Retrieve PII deletion request detailsget
    • Error codes
  • Leads
    • Add Leadpatch
    • Add Lead Substatuspost
    • Update Lead Statusput
    • Update Lead Followupspost
    • Update Leadput
    • Configure lead reasonspost
    • Get Lead Status Logget
    • Get Lead follow-upsget
    • Get Lead Reasonsget
    • Get Lead Detailsget
    • Get Lead Substatusget
    • Assign Leadget
    • Search leadget
  • Staff
    • Add Staff Accountpost
    • Get Access Tokenpost
    • Edit Staff Detailspost
    • Get Staff Detailsget
    • Change Account Passwordpost
    • Send OTPpost
    • Validate OTPpost
    • Change Identifier (Send OTP)post
    • Change Identifier (Validate OTP)post
    • Transfer Staff Userpost
    • Get Staff of Store/Zoneget
    • Logout Staff Accountget
    • Remove Staff Accountpost
  • Behavioral Events
    • Create Event (Custom)post
    • Update Event (Custom)put
    • Get Org Eventsget
    • Get Running Events Statusget
    • Get Customer Eventsget
    • Disable Eventput
    • Add Webhookpost
    • Get Events Logsget
    • Get Events Metaget
    • Get event data using request IDget
    • Search eventsget
    • Post Eventpost
  • Event notification logs
    • Get Event Log (by Request ID)get
    • Get Event Log (by Reference ID)get
    • Get Event Log (by Event ID)get
    • Response code
  • Company
    • Add Companypost
    • Update Companyput
    • Get Company Detailsget
    • Remove Companydelete
    • Get Org Companiesget
    • Get Companies by Extended Field Valuesget
  • Request (V1)
    • Add Requestpost
    • Approve Requestspost
    • Reject Requestspost
    • Get Request Detailsget
    • Get Request Logsget
  • Requests (V2)
    • Add Requestpost
    • Update Requestput
    • Retrieve Request Status using IDget
    • Retrieve Request Details using Type and Subtypeget
    • Status event notification
    • Error codes
  • (New) Request workflow
    • Create a request
      • Change customer status requestpost
      • Points redemption requestpost
      • Issue goodwill points requestpost
      • Issue/Earn badge requestpost
      • Enrol customers for badgespost
      • Retro transaction - Claim transactionpost
    • Approve or reject a requestput
    • Get details of all requestsget
    • Get details of a particular requestget
    • Error codes
  • Partner Program
    • Link Customer to Partner Programpost
    • Update Customerpost
    • Delink Customerpost
    • Get Customer Activityget
    • Get customer activity historyget
  • User Authentication
    • Register Userpost
    • Authorize Userpost
    • Update Passwordput
  • OTP
    • Generate OTPpost
      • OTP template guidelines
    • Validate OTPpost
    • Get OTPget
    • Success and error codes
  • Product
    • Add Productpost
    • Get Product Detailsget
    • Search Productsget
    • Add Product Attributespost
    • Get Product Attributesget
    • Get Product Categoriesget
    • Get Product Brandsget
    • Get Product Colorsget
    • Get Product Sizesget
    • Get Product Meta Sizesget
    • Response codes
  • Store
    • Get Store Detailsget
    • Get Store Staff Detailsget
    • Get Store Tasksget
    • Verify Store Login Credentialsget
    • Upload Store Logspost
    • Upload Store Reportspost
    • Get Store Reportsget
    • Get Store Configurationsget
    • Verify Login Credentialsget
  • Task
    • Add Taskspost
    • Update Taskspost
    • Get Tasks Metadataget
    • Get Task Logsget
    • Update Status Mappingspost
    • Get Status Mappingsget
    • Get Task Remindersget
    • Create/Update Task Reminderspost
    • Retrieve Individual Task Detailsget
  • Customer Authentication (Web/Mobile)
    • First factor authentication
      • Generate Authentication Tokenpost
      • Generate OTPpost
      • Validate OTPpost
      • Validate Passwordpost
      • Regenerate Authentication Tokenpost
      • Change Passwordpost
      • Forget Passwordpost
      • Status codes
    • Multi-factor authentication
      • Generate MFA tokenpost
      • Generate MFA OTPpost
      • Validate MFA OTPpost
      • MFA password flow
        • Validate passwordpost
        • Change passwordpost
        • Forgot passwordpost
      • Regenerate tokenpost
      • Delete tokendelete
    • Authentication configurations
  • Referral
    • Refer Customerpost
    • Get Referral Codeget
    • Validate Referral Codeget
  • DIY Template APIs
    • Create DIY Templatepost
    • Retrieve Workspacesget
    • Retrieve Blocks Supported by the Templateget
  • Other APIs
    • Get Transaction Earningget
    • Trigger Walk-in Notifications on InStoreget
    • Update Currency Ratiopost
    • Generate Card/customer External IDget
    • Configure Org Extended Fieldpost
    • Get Org Extended Fieldsget
    • Create Store Associatespost
    • Feed (Scan Event)post
    • Get Configured Card Limit per Customerget
    • Get Org Sourcesget
    • Get org configsget
    • Retrieve extended field config detailsget

Plugins

  • Shopify plugin
  • Magento plugin
Powered by 

Magento plugin

You can integrate Capillary with Magento and activate a loyalty program for your website.

Navigate to Capillary Magento integration to integrate Capillary plugin into Magento.

For information on how to integrate Capillary plugin into Magento, see Capillary Magento integration user guide.