Inquire
Get Points to be Expired
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
Inquire
Get Points to be Expired
Gets all points that will expire within a year starting at 30 days, 60 days, and up to one year.
GET
/
v1
/
inquire
/
points-expiry
curl --request GET \
--url https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/points-expiry \
--header 'Authorization: Bearer <token>'
{
"message": "Success",
"data": [
{
"expiryDuration": 30,
"unRestrictedTotalPoints": 100,
"restrictedTotalPoints": 12,
"totalPoints": 112,
"pointValue": 112,
"restrictedPoints": [
{
"points": 12,
"restrictedLocation": "demo_store"
}
],
"expiryDate": "2020-03-20T01:30:08.180856"
}
],
"status": 200,
"errors": {}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Profile ID. It is generated in the response of the Enroll Member
endpoint - POST /v1/members.
Response
200
application/json
OK
Message corresponding to the call.
Maximum length:
200
Expiry duration bracket, in number of days.
Total number of unrestricted points (base + promotional + bonus).
Total number of restricted points
Total number of points
Total monetary value of all points
Timestamp of points expiration (UTC format)
Status of the call
Error details, if any
Was this page helpful?
curl --request GET \
--url https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/points-expiry \
--header 'Authorization: Bearer <token>'
{
"message": "Success",
"data": [
{
"expiryDuration": 30,
"unRestrictedTotalPoints": 100,
"restrictedTotalPoints": 12,
"totalPoints": 112,
"pointValue": 112,
"restrictedPoints": [
{
"points": 12,
"restrictedLocation": "demo_store"
}
],
"expiryDate": "2020-03-20T01:30:08.180856"
}
],
"status": 200,
"errors": {}
}