Authentication v1
- Identity APIs
- User
- Address
- Auth
User Self Service APIs
- Introduction
- User Self Service APIs
- Authentication APIs
Experiences v2 (XM v2)
- XM
- Pages
- Global Components
- Menu
Experiences v1 (XM v1)
- XM
- Pages
- Global Components
- Menu
Product Catalog
- Product Catalog
- Category
- Product
- Attributes
- Bulk Import
Orders v2 (OMS v2)
- Order Management System
- Order
- Order Attribute
- Developer Guide
- Order Return
- Payment Status
- Package Tracking
- Cross Border
- Order Cancellation
- Appeasement
- Allocation
- Configuration
- Fraud Configuration
- Target Configuration
- Location
- Location Attribute
- Inventory Network
- Inventory
- Inventory Counter
- Inventory Bulk Operation
- Inventory Attribute
- Inventory Upload Log
- Shipment
- Shipping Method
- Webhook
- Notification
- Export
- Invoice
- Fraud
- Backorder Preorder Reservation
- List
Orders v1 (OMS v1)
- Order Management System
- Cart
- Bill To
- Ship To
- Wishlist
- Cart Decoupled
- Warehouse
- Inventory
- Attributes
- List
- Tax/Address Validate
- Shipping
- Payments
- Order
Offers v2
- Offers
- Developer Guide
- Promotion
- Price Kind
- Dynamic Pricing Engine
- Segment
- Coupon
- Coupon Codes
- Product
- Price List
- Attributes
- Item
- Price Guard
- Global Exclusion
- Upload Price CSV
- Pricing
- Redemption
- Exports
Offers v1
- Offers
- Login API
- Promotions
- Pricing
Subscriptions (SMT API)
- Subscriptions API
- Cancellation Reasons
- Subscription Discounts
- Subscriptions
- Subscribers
- Orders
Loyalty (Member)
Dropship
- Dropship API
- Shipments
- Products
- Invoices
- Connections
- Inventory
- Developer Guide
- Returns
- Orders
Cart API
- Cart
- Order Draft
- Attribute
- Adjustments
- Shipping
- Cart
Checkout API
- Checkout
- Checkout
Customer
- Core Concepts
- Customer Service
- Organization
- User Party
- Organization Group Addresses
- User Internal Party
- Organization Contracts
- Party
- Party Contracts
- Contracts
- User
- Search
- User Trait
- Organization Users
- Address
- User Address
- Trait
- Party Address
- Party Trait
- Organization Group Users
- Internal Party
- Contract Pricelist
- Internal Parties Party
- Account
- Party Account
- Organization Addresses
- Organization Groups
- Individual Addresses
- Users Organization
- Individual
Get Member Points
Gets all active and pending (excluding expired) member points along with the points breakdown.
curl --request GET \
--url https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/{profileId}/member-points \
--header 'Authorization: Bearer <token>'{
"status": 200,
"message": "",
"errors": {},
"data": [
{
"totalPoints": 300,
"pointsByType": [
{
"pointType": "Base",
"points": 300,
"subType": null
}
],
"pointsBalance": {
"memberPointsEarned": 600,
"memberPointsDeducted": 100,
"memberPointsUsed": 100,
"memberPointsExpired": 100,
"memberPointsAvailable": 300,
"memberPointsLocked": 100
},
"breakdown": {
"totalPoints": 300,
"totalCurrencyValue": 150,
"unrestrictedPoints": {
"totalPoints": 200,
"totalCurrencyValue": 100,
"unrestrictedPointsItems": [
{
"points": 200,
"pointType": "Base"
}
]
},
"restrictedPoints": {
"totalPoints": 100,
"totalCurrencyValue": 50,
"restrictedPointsItems": [
{
"points": 100,
"pointType": "Base",
"restrictedLocation": "4321"
}
]
}
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Profile ID. It is generated in the response of the Enroll Member endpoint - POST /v1/members.
Response
Response of the Get Member Points endpoint
Status of the call
Message corresponding to the call
Error details, if applicable
Total number of active and pending points (excluding the expired points).
Point type. Categorized as: <br /> 1) Base points: Earned in any purchase transaction based on the core rule. <br /> 2) Bonus points: Earned as a bonus for example on a large purchase. <br /> 3) Promotional Points: Earned as part of promotional events. <br /> 4) Restricted Points: Points to be used only on specific entity or stores.
1Total number of points
Subtypes of the points (configurable, if required)
Total points earned by member
Total points deducted for member
Total points redeemed (burned) by member
Total points that have expired for the member
Total points available for use by the member
Restricted points that can be used only at a specific entity or store
Total number of available points
Monetary value of total points
Details of unrestricted available points.
Monetary value of the unrestricted points.
Total number of unrestricted points (Base + Bonus + Promotional).
Unrestricted points of this particular point-type
Type of points. Categorized as: <br /> 1) Base points - Earned in any purchase transaction, based on the core rule. <br /> 2) Bonus points - Earned as a bonus for example on a large purchase. <br /> 3) Promotional Points - Earned as part of promotional events.
1Details of restricted available points.
Total number of restricted points that can be used only at a specific entity or store.
Monetary value of restricted points
Restricted points that can be used at this location or store
Entity or store-specific (restricted) point type.
1ID of the entity or store where the restricted points can be redeemed
1Was this page helpful?
curl --request GET \
--url https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/{profileId}/member-points \
--header 'Authorization: Bearer <token>'{
"status": 200,
"message": "",
"errors": {},
"data": [
{
"totalPoints": 300,
"pointsByType": [
{
"pointType": "Base",
"points": 300,
"subType": null
}
],
"pointsBalance": {
"memberPointsEarned": 600,
"memberPointsDeducted": 100,
"memberPointsUsed": 100,
"memberPointsExpired": 100,
"memberPointsAvailable": 300,
"memberPointsLocked": 100
},
"breakdown": {
"totalPoints": 300,
"totalCurrencyValue": 150,
"unrestrictedPoints": {
"totalPoints": 200,
"totalCurrencyValue": 100,
"unrestrictedPointsItems": [
{
"points": 200,
"pointType": "Base"
}
]
},
"restrictedPoints": {
"totalPoints": 100,
"totalCurrencyValue": 50,
"restrictedPointsItems": [
{
"points": 100,
"pointType": "Base",
"restrictedLocation": "4321"
}
]
}
}
}
]
}