- Overview
- Introduction
- Hosts
- Global Headers
- Common HTTP Error Codes
- API Permits
- Authorization
- API Contexts
- Common Concepts
- Common Models
- Reference
- API Structure
- Public API
- Introduction
- Loyalty Club
- Member
- Offers
- Rewards
- Games
- CMS Content
- Management API
- Introduction
- Core
- Applications
- Branding
- Privacy Policy
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- SMS Sender Identities
- Member Authentication Configuration
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Messages
- Stores
- Offers
- Rewards
- Triggerer
- CMS
- Introduction
- Venue Info
- Pages
- Website
- Landing Pages
- Articles
- Events
- Job Postings
- Press Releases
- Tags
- Attachments
- Service Messages
- Mixed Content
- Redirections
- Events
- Games
- Scraper
- Files
- Receipts
- Users API
- Operations API
- Introduction
- Manager API
- Tenant API
- Messaging API
- Data API
- ML API
- Introduction
- Predict Sending KPI v1
- Explain Sending KPI Prediction v1
- Predict Sending KPI In Date Range v1
- Predict Sending Popularity v2
- Predict Sending Text Popularity v2
- Predict Sending Time Series Popularity v2
- Explain Sending Popularity Prediction v2
- Explain Sending Text Popularity Prediction v2
- Explain Sending Time Series Popularity Prediction v2
- Recommend sending time v2
- Detect Receipt Fraud
- Generate Image
- Generate Text
- Generate Sending Text
- Predict Sending KPI v1 Copy
- (Draft) Reporting API
- Other
Use Reward
Pending
POST
https://api.mpc.dev.placewise.com/v3/{loyalty_club_slug}/members/me/rewards-program/rewards/{id}/use
API Permit:Rewards:Api:OAuth:Rewards:Use
API Context:Loyalty Club
Authorizations:TokenMember
Response Body#
| Key | Type | Description |
|---|---|---|
| usage | Object | See Reward Usage |
Error Responses#
| Status | Response body | Description |
|---|---|---|
404 | {"error": "Reward#10000951 not found"} | - |
422 | {"error": "Already active"} | The reward has been just used |
422 | {"error": "Not granted"} | The reward has not been purchased by member |
422 | {"error": "User limit exceeded"} | There are no more rewards available to purchase for the member |
467 | {"error": "Member is banned!", "banned_until": "2137-10-28T17:24:06.207Z"} | Member is banned |
Example#
{
"usage": {
"left": 3,
"usable": false,
"active_until": "2019-01-31T11:24:15.278Z"
}
}Request
Path Params
loyalty_club_slug
stringÂ
required
Example:
infinity-mall
id
integerÂ
required
Example:
1
Header Params
X-Loyalty-Club-Slug
stringÂ
required
Default:
{{LOYALTY_CLUB_SLUG}}
X-Client-Authorization
stringÂ
optional
Default:
{{API_TOKEN}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.mpc.dev.placewise.com/v3/infinity-mall/members/me/rewards-program/rewards/1/use' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: 'Responses
🟢200Success
application/json
Body
object {0}
Example
{}Modified at 2024-05-07 15:47:57