Redeem Options Management
Retrieves all available reward points redemption options configured for customers to use.
Note: This public API endpoint is accessible to all customers.
Tenant name.
GET /reward-points/{tenant}/redeemOptions HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "5f905280df6b3b0013b6c541",
"type": "coupon",
"name": "10 Euro Gutschein",
"description": "Für 90 Punkte können Sie sich einen Gutschein über 10 Euro generieren lassen. Diesen Gutschein können Sie auch an Freunde und Bekannte weitergeben.",
"points": 90,
"coupon": {
"name": "Gutschein über 10 Euro (eingelöste Bonuspunkte)",
"description": "Gutschein über 10 Euro aus 1000 Bonuspunkte",
"discountType": "ABSOLUTE",
"discountAbsolute": {
"amount": 10,
"currency": "EUR"
},
"allowAnonymous": true,
"maxRedemptions": 1,
"status": "VALID"
},
"metadata": {
"version": 1,
"createdAt": "2023-07-25T13:28:25.960Z",
"modifiedAt": "2023-07-25T13:28:25.960Z"
}
}
]Sets up a reward points redemption option that contains instructions for transforming these points into a coupon. Customers are required to choose this option to convert the reward points and create a coupon based on the pre-established rules.
Note: Only employees have the authority to configure the redemption options.
Required scopes
rewardspoints.rewardpoints_manage
Tenant name.
ID of the redemption option to be used at reward points exchange
Option type, typically 'coupon'.
Name of the redeem option that can be presented to customer
Description of the redeem option that can be presented to customer
Points to deduct from customer's account at coupon creation
POST /reward-points/{tenant}/redeemOptions HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 489
{
"type": "coupon",
"name": "10 Euro Gutschein",
"description": "Für 90 Punkte können Sie sich einen Gutschein über 10 Euro generieren lassen. Diesen Gutschein können Sie auch an Freunde und Bekannte weitergeben.",
"points": 90,
"coupon": {
"name": "Gutschein über 10 Euro (eingelöste Bonuspunkte)",
"description": "Gutschein über 10 Euro aus 1000 Bonuspunkte",
"discountType": "ABSOLUTE",
"discountAbsolute": {
"amount": 10,
"currency": "EUR"
},
"allowAnonymous": true,
"maxRedemptions": 1,
"status": "VALID"
}
}[
{
"points": 30,
"type": "coupon",
"name": "persönlicher 20 Euro Gutschein",
"description": "Ein persönlicher Gutschein zum einlösen auf Lieferladen.de (nur gültig im Lieferladen.de Stuttgart Shop)"
}
]Updates a reward points redemption option for a given tenant.
Note: Only employees have the authority to update the redemption options.
Required scopes
rewardspoints.rewardpoints_manage
Unique identifier of a redeem option.
Tenant name.
ID of the redemption option to be used at reward points exchange
Option type, typically 'coupon'.
Name of the redeem option that can be presented to customer
Description of the redeem option that can be presented to customer
Points to deduct from customer's account at coupon creation
PUT /reward-points/{tenant}/redeemOptions/{redeemOptionId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 514
{
"type": "coupon",
"name": "10 Euro Gutschein",
"description": "Für 90 Punkte können Sie sich einen Gutschein über 10 Euro generieren lassen. Diesen Gutschein können Sie auch an Freunde und Bekannte weitergeben.",
"points": 90,
"coupon": {
"name": "Gutschein über 10 Euro (eingelöste Bonuspunkte)",
"description": "Gutschein über 10 Euro aus 1000 Bonuspunkte",
"discountType": "ABSOLUTE",
"discountAbsolute": {
"amount": 10,
"currency": "EUR"
},
"allowAnonymous": true,
"maxRedemptions": 1,
"status": "VALID"
},
"metadata": {
"version": 1
}
}No content
Deletes a reward points redemption option for a given tenant.
Note: Only employees have the authority to delete the redemption options.
Required scopes
rewardspoints.rewardpoints_manage
Unique identifier of a redeem option.
Tenant name.
DELETE /reward-points/{tenant}/redeemOptions/{redeemOptionId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Was this helpful?