Skip to content
Annex Cloud
/
Multi-Point Bucket
/
Tiers
/
Get tier information for a loyalty member

Multi-Point Bucket V3 APIs (3.0.1)

Welcome to the Multi Point Bucket (MPB) API documentation for Annex Cloud, the Multi Point Bucket feature is a powerful tool available in various API’s such as Tiers, Orders, Rewards, Points, Products, and Cart.

The MPB feature allows for the creation of multiple buckets for points, each representing a different type or purpose. This enables users to track and manage points more effectively, ensuring that they are allocated correctly according to the defined rules and criteria.

Using the MPB feature with the GET, POST and PATCH methods, users can define criteria based on products and orders to determine eligibility for earning or redeeming points and rewards. For example, users can set rules that specify which products or categories of products are eligible for earning points towards the additional point buckets or establish thresholds for the minimum purchase amount required to earn points.

Overall, the Multi Point Bucket feature enhances the functionality of various API’s by providing a flexible and customizable solution for configuring eligibility criteria for members associated with points, rewards, tiers, products, and orders. This allows businesses to create loyalty programs and rewards systems that are tailored to meet the unique needs of their customers and drive engagement and loyalty.

Download OpenAPI description
mpb.json
mpb.yaml
Languages
Servers

https://s15.socialannex.net/api/3.0/

Tiers

Welcome to Annex Cloud’s Tier API documentation for Multi Point Bucket. Designed to enhance your loyalty journey, this API allows you to discover a member’s current tier, the next achievable tier, along with the points needed to reach it. The multi bucket data provides insight into available tier points, coins, and perks. You can retrieve information for the points and coins required for member’s to advance to the next tier in the loyalty program.

Operations

Get tier information for a loyalty member

Request

This method retrieves tier details for a specific member using their member ID.

Path
memberIdstringrequired

Enter the unique ID of the member.

Example: johan19.sa@gmail.com
curl -i -X GET \
  'https://s15.socialannex.net/api/3.0/users/{johan19.sa@gmail.com}/tiers'

Responses

successful operation

Body
siteIdstring

Displays Annex Cloud’s site ID for the loyalty program.

Example: 33986340
currentTierstring

Displays the loyalty member's current tier name. For example, Bronze, Silver, Gold.

Example: "Silver"
previousTierstring

Displays the previous tier that was assigned to the member.

Example: "Bronze"
tierAchievedDatestring

Displays the current tier achievement date in yyyy-MM-dd'T'HH:mm:ssZ format.

Example: "2022-04-01T00:00:00-0700"
tierExpirationDatestring

Displays the tier expiration date in yyyy-MM-dd'T'HH:mm:ssZ format. When the tier expiration date is reached, the current tier is no longer valid. The additional points in the bucket are deducted, and the tier sequence restarts from the base tier.

Example: "2023-04-01T00:00:00-0700"
nextTierstring

Displays the name of the next tier which is awarded to the member once the required milestones are achieved.

Example: "Gold"
pointsToNextTierinteger

Displays the number of points required to achieve the next tier. This depends on the point threshold required to reach the next tier and the number of points the member currently has in their account.

Example: 210
purchaseRatiointeger

Displays the purchase ratio established for the loyalty program, which will be applied to the member’s purchases. For example, if the purchase ratio is 2 and purchase amount is 400, then after completing the purchase, 800 points is awarded to the member.

Example: 2
currentTierPurchaseRatiostring

Displays the purchase ratio that is applied to the member for this tier while earning points for purchase.

Example: 0.5
spendAmountToNextTierinteger

Displays the amount the member must spend to achieve the next tier.

Example: 200
currentTierRewardsobject

Displays the details of the current tier rewards.

Response
{
  "siteId": 33986340,
  "currentTier": "Silver",
  "previousTier": "Bronze",
  "tierAchievedDate": "2022-04-01T00:00:00-0700",
  "tierExpirationDate": "2023-04-01T00:00:00-0700",
  "nextTier": "Gold",
  "pointsToNextTier": 210,
  "purchaseRatio": 2,
  "currentTierPurchaseRatio": 0.5,
  "spendAmountToNextTier": 200,
  "currentTierRewards": {
    "rewardId": 1234,
    "rewardName": "Reward First",
    "tierEligible": true,
    "rewardLimit": 2,
    "limitPeriod": "Day",
    "redeemCount": 0,
    "remainingCount": 1,
    "multiBucketsData": { … }
  }
}

Orders

Welcome to Annex Cloud’s Order API documentation for Multi Point Bucket. Seamlessly manage orders, input and update order details, apply coupon codes, and track rewards whether customers are shopping instore, through your website or via mobile app. By using the multi point bucket parameters provided in the methods below you can allow members to earn points towards multiple point buckets for an order and update the points within the additional point buckets once an order’s status has been updated.

Operations

Rewards

Welcome to Annex Cloud’s Rewards API documentation for Multi Point Bucket, designed to elevate your loyalty program experience. Using the GET method listed below, you can retrieve the list of rewards against a member’s User ID. You can easily see what rewards they are eligible for and what rewards require points in additional point buckets to be redeemed.

Operations

Points

Welcome to Annex Cloud’s Points API documentation for Multi Point Bucket. Using the multi point bucket parameters provided in the documentation below, you can easily update points for members in your loyalty program within all point buckets. Additionally, you can use the GET method to retrieve all of the point information for a member, including the status of their points within the additional point buckets in your program.

Operations

Product

Welcome to Annex Cloud’s Product API documentation for Multi Point Bucket. Using the method below you can calculate how many points a member will earn for purchasing products, including details on points that can be earned towards additional point buckets established in your loyalty program.

Operations

Cart

Welcome to Annex Cloud’s Cart API documentation for Multi Point Bucket. Using the POST method below you can calculate the points members can earn for the products in their cart. This includes points that can be earned towards the additional point buckets established in your loyalty program.

Operations