square loyalty api


Tango Card. Perhaps the loyalty account moves to another customer. A reward that applies X% off a qualifying item or list of items. For example, consider the following eCommerce checkout flow: Buyers can add items to the cart and apply available discounts to see the effect on purchase price. The AccumulateLoyaltyPoints endpoint can compute loyalty points for a given order ID and add the points to the loyalty account of the buyer. Stripe is a white-label, web-based solution aimed at e-commerce businesses looking for a payment-processing option, while its … View your customers’ monthly participation at any time by using the date range selector in the Visits tab of your Loyalty … If no matches are found, the Loyalty API returns an empty response: Buyers accrue points for the purchases they make. Our flexible API and SDK based approach makes it easy to seamlessly integrate loyalty into your existing systems and applications. With unlimited integrations into all key business systems, Punchh makes it easy to create a seamless customer experience across all touchpoints. After some concerns about that initial re-launch, Square Loyalty is … You can obtain a buyer's phone number from your application flow. In this case, you can add points to the buyer's account with minimal code. } Python 2 versions 2.7.9 and later 2. The object identifies the points taken from the buyer's account and the reward tier being redeemed. After the buyer chooses the reward, adjust the point balance accordingly. You should use the RetrieveCatalogObject endpoint to get discount details for a reward tier. A random string that serves as the ID for the simulated reward. }', '{ If the buyer chooses to redeem the reward, you call CreateLoyaltyReward. such as application_mode, max_applications_per_attachment, and application_method. You can use the following logic to track the available point balance on the client side: When you apply multiple rewards, the Square pricing engine places rewards on the order in ways that maximize the reward value in the buyer's favor. For example, "earn one point for each visit, with a $5 minimum purchase required.". Otherwise, the CreateLoyaltyAccount endpoint returns an INVALID_PHONE_NUMBER error code. The Square extension for Magento simplifies multiple aspects of running your business - with out-of-the-box fraud detection, PCI compliance, and simplified catalog and inventory management - so that you can focus on growing your business. that have been created and managed in Square’s in-person hardware products (Square Point of Sale and Square … Loyalty schemes are integrated into the software as well and can be associated with credit cards or phone numbers. Ideal for low-volume merchants 3. Set up a loyalty program in the Square Seller Dashboard. White Label Loyalty is a cloud-based loyalty platform that empowers businesses to increase their revenue by understanding, engaging and retaining their customers. About two years ago, they stopped offering a free add-on to the basic Square POS, creating a paid-for loyalty product instead. "Q8002FAM9V1EZ0ADB2T5609Xexample" $45. Analytics: Square gives you a bird’s eye view of how your loyalty program is helping your business, showing data on all your customers and how often they visit your shop. "MHXTR5VRKLXN767RCexample" While building the order, depending on the available point balance in the buyer's loyalty account, your application can offer the buyer the option to redeem points for a reward. Contact Developer Support, Customer loyalty programs help sellers increase repeat visits to their business. Layered reward system where customers will be able to unlock more rewards as they progress. The Square Terminal API … A loyalty account can be created using any of the following methods and they all publish this event: Published for any updates to a buyer's existing loyalty account. The following is an example SearchLoyaltyAccounts response: Your application should be able to handle loyalty accounts that have a negative point balance (balance is less than 0). Impressive feature set 5. ] Log in to the Loyalty section of your online Square Dashboard > Select Settings. "order_id": "cb9LSpDgOH3rITBaZ6eIexample" The buyer can use the points to get discounts on other purchases. You might choose not to use the Orders API for order processing. Webinar. Let’s take a look (software listed alphabetically): 3 best free and open-source customer-loyalty software 1. You do not need itemized orders. Currently, a seller account can contain only one loyalty program. You can use the CalculateLoyaltyPoints endpoint to compute loyalty points and then call AccumulateLoyaltyPoints to add the points to the loyalty account of the buyer. Reward tier 2: If a buyer has 15 points in the account, the buyer qualifies for 20% off the entire purchase. The ID of the reward tier from the loyalty program. With Square loyalty, customers pop up automatically with a card swipe/dip and the sign up is via cell phone number. In order to automatically create SSL certificates for loyalty program urls, you need to get the ServerPilot API keys. This is pre-release documentation for an API in public beta and is subject to change. Use the same object that you would send to the CreateOrder endpoint. Step 2: Get discount details for the reward tier. Integrate your application with the Loyalty API to create loyalty accounts for buyers, add points for purchases, and redeem points for rewards. For example, "earn one point for each pumpkin latte" or "earn one point for any drink," where drink is an item category. To search loyalty accounts by phone number, provide a mapping that specifies the phone number in E.164 format. With Square + WooCommerce, you can easily synchronize sales, inventory, and customer data, manage all your channels through one centralized platform and use one payment solution across all of them. The system chooses the item to apply the discount to, in a way that maximizes the total discount for the buyer. The seller-defined name for the reward tier. }, The following is an example ListLoyaltyPrograms response. Square point-of-sale (POS) devices and Square Online Store support a Square loyalty program to help increase customer visit frequency. Configure rewards tiers. mappings identifies the buyer by phone number, which must be specified in E.164 format. If the buyer chooses not to redeem the reward, you should call DeleteLoyaltyReward to delete the reward. Uses the phone number to determine whether a customer profile exists in the seller's Customer Directory (see Customers). "end_at": "2020-12-31T00:00:00Z" Stripe vs. Square: An overview. If the reward does not get redeemed (the reward state remains ISSUED), it remains in a dangling state, where the points are simply locked (not available for the buyer to use for any other rewards). "limit": 10 }', '{ "query": { For the proposed_rewards field, provide the following: reward_tier_id. 0 - 500. Searches for loyalty events. The following is an example SearchLoyaltyEvents request. This documentation focuses on using the Loyalty API. "LB43CCexample" A loyalty visit is any time you enroll a customer in your program or when the customer uses a loyalty point on a repeat visit. I feel like the square API would be useful. A seller can verify the subscription status in the Seller Dashboard by choosing Business under Accounts & Settings. Now you have permanently dangling reward objects. Buyers can also walk away from the cart. "type": "PHONE", The following Loyalty API endpoints can easily compute the points to earn using information in orders created using the Orders API. "loyalty_account": { Loyalty events are immutable, which means they are never updated or deleted. Order ID, if your application uses the Orders API to manage orders. A reward that applies X% off a qualifying category or list of categories. Buyers earn points based on items in their cart. "CREATE_REWARD" This web interface may be used by POS solutions or other third parties to emulate POS transactions, performing real-time Stored Value (gift card, award cards, and credit or debit accounts), Loyalty and Promotion transactions, which include coupon Note that the loyalty points are calculated based on pretax amounts. Sometimes your application might want to show the buyer the effect of applying a reward on a purchase, for preview, without actually creating a reward (and avoid locking points). Additionally, there is also now a Loyalty API that you can use to add points to your customer's account. You can search for a loyalty account by customer ID. If you add a reward first, your application should verify that the item in the reward is also added to the order. Percentage-based. ... Square has an e-commerce API that developers can use to integrate … "reward_tier_id": "b525f003-47ea-43aa-bb18-6d12Cexample" "points": 7 To use the Square API to manage the resources (such as payments, orders, customers, etc.) }', '{ ] Helps you create diverse loyalty systems, which will help you set up more than 15 methods for customers to earn points. "idempotency_key": "{UNIQUE_KEY}" Square Loyalty Pricing. When a seller updates the reward tier in the Seller Dashboard or Point of Sale application, a new pricing rule is created. If the buyer pays for the order, depending on whether an order ID was specified when creating the reward, the following happens: The order ID was specified when creating the reward. A reward tier defines the reward and the points that the buyer must redeem to get the reward. If order ID is not provided, it is your responsibility to apply the appropriate discount to the shopping cart. To get the discount details for a reward tier, call the RetrieveCatalogObject endpoint in the Catalog API. points. The Visits report uses the order data to show the number of first-time (and repeat) loyalty buyers and the average visits by loyalty (and non-loyalty) buyers for a given period. The endpoint does the following: If an order ID was specified when creating the reward, the endpoint updates the order by removing the discount and updating the order amount accordingly. } You can then offer a discount for items in the drink category. Call BatchRetrieveCatalogObjects in the Catalog API to get the CATEGORY and ITEM_VARIATION catalog objects that the discount applies to. name. When a buyer enrolls in a loyalty program at the Square Point of Sale, the buyer is shown the terms of service that must be accepted before Square can send any text messages. Loyalty accounts in the response are sorted by created_at date in ascending order. "base_price_money": { The discounts field is added to the order. "filter": { In a simple scenario, your application might choose to limit a buyer to redeem only one reward per order. The specific version of a PRICING_RULE catalog object that defines the discount details for the reward tier. Buyers earn points for every purchase, with an optional minimum spend requirement. If you first apply the free drink reward, it discounts the tea because it is more expensive. Read more about White Label Loyalty Platform We just launched loyalty for our retail shop through Square but want to offer online customers the same rewards tracking. "value": "+16295551234" Automated logistics integrations and tools that take the hassle out of high-volume food delivery. A reward that applies X% off the entire sale. After the buyer pays for the order, you call AccumulateLoyaltyPoints to add points to the buyer's account for the purchase. }', '{ This might occur if a seller makes a manual adjustment or as a result of a refund or exchange. Find these at Account > Settings > API. Returns a reward object of type LoyaltyReward. Square automatically keeps track of each location’s loyalty visits in the Loyalty section of your online Square Dashboard. Your application can also allow buyers to redeem multiple rewards for a given order (for example, Square Point of Sale allows it). I have settled on the fact that with a Shopify POS loyalty app, this will have to be via email address. Published when the loyalty program is updated from the Seller Dashboard. The Square loyalty program supports the following reward types: The following sections explain these reward types. The buyer can then redeem 10 points to get a $1 discount and pay only $9. Punchh empowers marketers to acquire, grow and nurture customers through a customized, digital loyalty solution that leverages AI-generated insights. For example, if you previously created a customer profile for the buyer using an email address (and not a phone number), then that customer profile is not found using a phone number and another customer profile is created. You can offer dollar-based or percentage-based discounts on an entire sale: Dollars-based. The default page size is 30. It is your responsibility to clean up any dangling rewards, for instance by deleting them on orders left open for too long. OAuth credentials and the LOYALTY_READ or LOYALTY_WRITE permission are required to perform any Loyalty API actions. The endpoint processes the filters as follows: Uses a logical AND to evaluate multiple filters (for example, loyalty_account_filter and date_time_filter). Appointment Scheduling Block adds online booking from Acuity or Squarespace Scheduling. Add Tiers to Your Loyalty Program. Contact Developer Support, For example, when a buyer redeems a reward and then returns it, a CREATE_REWARD event and a DELETE_REWARD event are published separately. For example, if the reward gives the buyer a free coffee, make sure the order includes coffee. "loyalty_account_id": "716cefbc-3d71-4d7c-bdc8-9c7f8example" }, Instead of offering a discount on the entire sale, you can limit the reward to specific items in the seller's catalog. "object_ids": [ The Orders API provides an added benefit when working with multiple discounts on an order. You can provide up to 30 mapping entries per query. The SDK supports the following versions of Python: 1. Call RetrieveLoyaltyAccount if you know the ID of the loyalty account. }, Sales report. For example, suppose a buyer pays $15 for an order. When redeeming multiple rewards on the same order, only one reward can apply to each line item. Square BrandVoice | Paid Program. "limit": 30 Zinrelo is a customer loyalty and referral software designed to help businesses manage various rewards such as gift cards, discount vouchers, and account credit. "loyalty_account_filter": { In such scenarios, the application can use the CalculateOrder endpoint (the Orders API) to create a copy of an order with the specific rewards applied. This step ensures that you retrieve all updates made since the catalog version specified in the previous request, such as changes to an item's price. Call ListLoyaltyProgram in the Loyalty API. Many of my customers are currently enrolled in Square's loyalty program, but any orders from WooCommerce do not give customers Square loyalty points even though my customers are synced between both platforms.