🎓
Boomerangme knowledge base
  • Getting started
    • 🚀Introduction
    • ✅Getting started - Quick wins!
      • 🔁 Quick Win #1: Regular loyalty card setup
      • 🎫 Quick Win #2 Creating a coupon card to attract new customers
      • ✅ Quick Win #3: Importing existing customers and issuing loyalty cards
      • 🪃 Quick Win #4: Loyalty Cards Delivery by SMS and Email
      • 📲 Quick Win #5: How to Promote Your Loyalty Card with QR Code
      • 👨‍💼 Quick Win #6: Creating manager seats for salespeople in local stores
      • 👯‍♀️ Quick Win #7: Setting up a referral program
    • 🔑Login and registration
      • 🧑‍💻How to Register on Boomerangme?
      • 📱How to Login with Phone?
      • 📧How to Login with Email?
      • 🔁How to Recover your Account Password?
    • 📖Product presentation
    • 💰Affiliate program
  • Inspiration & Ideas
    • 💡Inspiration
    • 💎Use cases
      • 🔵Boomerangme + Facebook Ads
      • 🔵Boomerangme + Google Ads
    • 💼Case studies
    • 💲Loyalty ROI calculator
    • 💰Agency margin profit calculator
  • Cards creation
    • ✴️Stamp
    • 🎟️Multipass
    • 💰Cashback
    • 🎁Gift
    • 🎫Coupon
    • ❤️Membership
    • 💲Discount
    • 🎁Reward
  • How to install the card
    • 🍏iPhone (iOS)
    • 🤖Android
      • PWA cards on Android
      • Google Pay on Android
    • 🔁How to restore the card
  • Customers (CRM)
    • 👨Customer profile
    • 🔃Import / export
    • 🗃️Customer filters
    • 📊RFM analysis
  • Scanner app
    • 👀How it works
    • ⬇️Installation
    • ⚡Login in the scanner app
    • 📸Scan and make transactions
      • ✴️Scanner app – Stamp
      • 🎟️Scanner app – Multipass
      • 💰Scanner app – Cashback
      • 💳Scanner app – Certificate
      • 🎫Scanner app – Coupon
      • ❤️Scanner app – Membership card
      • 💲Scanner app – Discount
      • 🎁Scanner app – Reward
  • Managers
    • 🔃Manager (team member) seats Add / edit / delete
    • 👨‍💼Manager (team member) profile
  • Card distribution
    • 🏪Offline
      • 📸QR code
      • 📄Table tent
      • ⚪Stickers
    • 🌐Online
      • 🔗Link for sharing
      • 💬SMS delivery
      • 📧Email delivery
  • Push notifications
    • 👀How it works
      • 🍏iPhone (iOS)
      • 🤖Android
      • ⏳How long does it take for push messages to be received by our customers?
      • 📫Why aren't my customers receiving push messages?
    • 💬Push section
      • Marketing push
        • Sending messages to all customers
        • Sending messages to a segment of customers
        • Sending message to an individual customer
      • Transactional push
      • Geo-push
      • Push automation
        • Feedback collection
        • Next visit reminder
        • Birthday congratulation
      • Triggered auto-push
  • Mailings
    • 📧How to create and send a mailing
    • 🟢Ноw to connect WhatsApp Bot
    • 🔵How to create a facebook messenger bot on the facebook side
    • 🔵How to Create a Telegram Bot
  • Dashboard
    • 📈Dashboard
      • 🗺️How to Access the Dashboard?
      • 🎛️What does the Boomerangme Dashboard Include?
  • Feedback collection
    • ⭐Feedback collection
  • Referral program
    • 👯Referral program
  • Geolocations
    • 📍Geolocations
      • 🗺️How to Access Locations Section?
      • 📌How to Add a Location?
  • Settings
    • ⚙️Settings
      • 💳Plan
      • 🛠️Personal Settings
      • 🔗Integrations
      • 🪝Webhooks
  • ⭐Promo codes
  • White label
    • ⚪White label
    • 🌎Domain name
    • 📧Mailgun
    • 📧SMTP
    • 💬Twilio
    • 🔗Google tag manager
    • 💲Stripe
      • 🖊️Manage subscription
    • 💲PayPal
  • ⚙️Settings
  • Agency account
    • 💲Agencies
    • ⚡Sub-accounts
    • 💰Payments
    • 💱Plans
    • 🪧Agency Lаnding
  • 📖Presentation for Agencies
  • PROSPECTING
    • 🚀Richie, your AI Sales Copilot
    • 👨‍💼Prospecting
    • 📚Snapshots
    • 📧Setting up Mailgun Account
  • Franchise account
    • 🌎Franchise chains
  • MARKETPLACE
    • 🚀Create an Application
    • 🟢Shopify POS
    • ♦️Lightspeed POS
    • ⚫Square
    • 🍕GloriaFood
  • Integrations
    • 🟠Toast POS
    • 🟢HighLevel
      • Connect "Boomerangme" with GoHighLevel
      • How to install the Boomerangme plugin
    • 🔵ActiveCampaign
    • 🔵Manychat
    • 🔵UChat
    • ⚫Square
    • 🟢Shopify
  • 🔵Wordpress Woocommerce
  • API
    • 🔗API docs
    • 🪝Webhooks
    • 🟠Zapier
    • 🟢Pabbly
    • 🟠Integrately
    • 🔵KonnectzIT
    • 🟠Albato
    • 🟣Make.com
  • Tutorials
    • 📺Video tutorials
  • Support
    • 🆘Intercom chat
    • ❓FAQ
    • 🍀AppSumo
    • 🗺️Roadmap
    • ✨Community
Powered by GitBook
On this page
  • API 2.0 methods
  • How to find your Api Key

Was this helpful?

  1. API

API docs

Make your own integration with 3rd party software

PreviousWordpress WoocommerceNextWebhooks

Last updated 6 days ago

Was this helpful?

If you need any help please feel free to reach out to us via the support chat anytime.

Please use API v2.0 to make your integrations.

API 2.0 methods

Types of cards (notation):

Stamp - ID 0 Cashback - ID 1 Multipass - ID 2 Coupon - ID 3 Discount - ID 4 Gift - ID 5 Membership - ID 6 Reward - ID 7

Add amount to card Applicable to Cashback card (card ID 1)

Add point to card Applies to Discount, Cashback, Certificate cards (card IDs 4, 1, 5)

Add reward to card Applicable to Stamp card (card ID 0)

Add scores to card Applies to Reward cards with the mechanics type “Points”, Multipass (card ID 7, 2)

Add stamp to card Applies to Stamp card (card ID 0)

Add visit to card Applies to Multipass card (card ID 2), membership card WITHOUT LIMITS (card ID 6), stamp card (card ID 0) with visit mechanics, rewards card (card ID 7) with visit mechanics.

Add purchase to card (add amount to card) Applies to stamp card (card ID 0) with spend mechanics, reward card (card ID 7) with spend mechanics.

Receive reward (receive reward by client) Applicable to Reward card (card ID 7)

Redeem coupon Applies to Coupon card (card ID 3)

Subtract amount from card Applies to Cashback card (card ID 1)

Subtract point from card Applies to Discount, Cashback, Certificate cards (card IDs 4, 1, 5)

Subtract reward from card Applicable to Stamp card (card ID 0)

Subtract scores from card (Subtract points from card) Applies to Reward cards, Multipass cards (card IDs 7, 2)

Subtract stamp from card Applies to Stamp card (card ID 0)

Subtract visit to card (add visits to card) Applies to Multipass card (card ID 2), Membership card WITH LIMITS (card ID 6)

List of cards - Get list of cards Create card for customer - Issue card for customer Get card - Get information on a certain card by its number. Delete card - Deleting a card by its number GET companies - Get list of company's sub-accounts GET companies/{id} - Get information about a specific sub-account by its ID.

POST Create company - Create a company POST companies/{id}/change-tariff - Change a company's tariff PATCH companies/{id} - Change company information List of customers - Get list of customers GET customers/{id} - Get information about one customer by its ID Create customer - Create a customizer

PATCH customers/{id} - Change the data of a customer DELETE customers/{id} - Delete a customer by its ID List of operations - Get list of operations Get push - Get push by its ID List of pushes - Get list of pushes Send push - Send Push Get tariff - Get information about a reseller's tariff by its ID List of tariffs - Get a list of reseller's tariffs Get template - Get information about the card template by its ID List of templates - Get a list of company card templates

How to find your Api Key

To find your Api key, click on the settings icon. Note for agencies, you need to click on the user icon before clicking on settings

Next click on integrations at the top.

Then copy your Api key.

For subaccounts, you need to click on the settings icon, select integrations at the top, scroll down and copy your Api key.

🔗
ReDoc
API v2.0 docs (follow the link to open the documentation of the open API)
Logo