Reward Points Management
Was this helpful?
Was this helpful?
Retrieves a detailed summary of added and redeemed reward points for all customers of a given tenant. The tenant name is selected based on the access token.
Note: Only employees are authorized to perform this action.
Required scopes
rewardspoints.rewardpoints_view
GET /reward-points/summaryBatch HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"customerId": "20242913",
"activePoints": 2000,
"summary": {
"addedPointsList": [
{
"id": "1c32ce73-8765-42a7-92af-ff370a0a59d6",
"reference-id": "<string>",
"description": "<string>",
"points": 2000,
"createdAt": "2023-05-11T18:32:18.591+00:00",
"allPointsAfterCreation": 2000,
"usedPoints": 140,
"validUntil": "2023-11-11T12:00:50.406+00:00",
"usedWith": [
"d85c0570-1d51-4611-bf2f-c67452384626",
"b5085a36-a5f0-450d-a011-9f92902f3900"
]
},
{
"id": "b9919f33-3a0b-4fd7-acdb-217edd4fc110",
"reference-id": null,
"description": "Chargeback - redeemed voucher could not be created.",
"points": 50,
"createdAt": "2023-05-11T18:32:38.564+00:00",
"allPointsAfterCreation": 2000,
"usedPoints": 0,
"validUntil": "2026-05-11T18:32:38.564+00:00",
"usedWith": []
},
{
"id": "42cd0799-9965-4983-8548-e7ad79160572",
"reference-id": null,
"description": "Chargeback - redeemed voucher could not be created.",
"points": 90,
"createdAt": "2023-05-11T18:32:50.981+00:00",
"allPointsAfterCreation": 2000,
"usedPoints": 0,
"validUntil": "2026-05-11T18:32:50.981+00:00",
"usedWith": []
}
],
"redeemedPointsList": [
{
"id": "d85c0570-1d51-4611-bf2f-c67452384626",
"description": "test desc",
"points": 50,
"createdAt": "2023-05-11T18:32:38.501+00:00",
"allPointsAfterCreation": 1950
},
{
"id": "b5085a36-a5f0-450d-a011-9f92902f3900",
"description": "For 90 points you can have a voucher for 10 euros generated. You can also pass this voucher on to friends and acquaintances.",
"points": 90,
"createdAt": "2023-05-11T18:32:50.946+00:00",
"allPointsAfterCreation": 1910
}
]
}
}
]Fetches the number of reward points for a particular customer of a given tenant. The tenant name is retrieved from the access token.
Note: Only employees are authorized to perform this action.
Required scopes
rewardspoints.rewardpoints_view
Unique identifier of a customer, generated when the customer is created through the Customer Service.
GET /reward-points/customer/{customerId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
2000Deletes a reward points entry of a specified customer for a given tenant. The tenant name is retrieved from the access token.
Required scopes
rewardspoints.rewardpoints_manage
Unique identifier of a customer, generated when the customer is created through the Customer Service.
DELETE /reward-points/customer/{customerId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Retrieves a detailed summary of added and redeemed reward points of a single specified customer for a given tenant. The tenant name is retrieved from the access token.
Note: Only employees are authorized to perform this action.
Required scopes
rewardspoints.rewardpoints_view
Unique identifier of a customer, generated when the customer is created through the Customer Service.
GET /reward-points/customer/{customerId}/summary HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"customerId": "123",
"activePoints": 1153,
"summary": {
"addedPointsList": [
{
"id": "zzpscd12uimlmybtthb",
"reference-id": "B7011746",
"description": "Bonuspunkte für Bestellung B7011746",
"points": 209,
"createdAt": "2020-09-03T09:45:02.248+00:00",
"allPointsAfterCreation": 209,
"usedPoints": 209,
"validUntil": "2023-09-02T22:00:00.000+00:00",
"usedWith": [
"e7522b99-2448-44b5-8f68-8bffcc207d18"
]
},
{
"id": "c9joe623gl4obochkrmy8i",
"reference-id": "B7011745",
"description": "Bonuspunkte für Bestellung B7011745",
"points": 209,
"createdAt": "2020-09-03T09:45:02.318+00:00",
"allPointsAfterCreation": 418,
"usedPoints": 209,
"validUntil": "2023-09-02T22:00:00.000+00:00",
"usedWith": [
"e7522b99-2448-44b5-8f68-8bffcc207d18"
]
}
],
"redeemedPointsList": [
{
"id": "e7522b99-2448-44b5-8f68-8bffcc207d18",
"description": "Für 600 Punkte können Sie sich einen Gutschein über 5 Euro generieren lassen. Diesen Gutschein können Sie auch an Freunde und Bekannte weitergeben.",
"points": 600,
"createdAt": "2020-09-03T12:44:22.747+00:00",
"allPointsAfterCreation": 2953
}
]
}
}Creates a new reward points entry for a particular customer of a given tenant. The tenant name is retrieved from the access token.
Required scopes
rewardspoints.rewardpoints_manage
Unique identifier of a customer, generated when the customer is created through the Customer Service.
Site code, defined when a site is created.
mainPOST /reward-points/customer/{customerId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 319
{
"customerId": "C4289081720",
"startPoints": {
"id": "12345fee-0b83-48aa-95dc-11e3dcf84aaa",
"reference-id": "123456",
"description": "points added",
"points": 20,
"createdAt": "2019-08-24T14:15:22Z",
"allPointsAfterCreation": 20,
"usedPoints": 5,
"validUntil": "2019-08-24T14:15:22Z",
"usedWith": [
"5237bcac-c548-4e49-8626-03dab65376d6"
]
}
}No content
Adds reward points to a specific customer's account for a given tenant. The tenant name is retrieved from the access token.
Note: Only employees are authorized to perform this action.
Required scopes
rewardspoints.rewardpoints_manage
Unique identifier of a customer, generated when the customer is created through the Customer Service.
Site code, defined when a site is created.
mainOrder Id for which the points were created
Auto-generated description
Number of points added in the operation
The date until when the points can be redeemed
Number of points after creation
Number of points already used
POST /reward-points/customer/{customerId}/addPoints HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 280
{
"id": "12345fee-0b83-48aa-95dc-11e3dcf84aaa",
"reference-id": "123456",
"description": "points added",
"points": 123,
"createdAt": "2023-10-24T14:15:22Z",
"allPointsAfterCreation": 56778,
"usedPoints": 5,
"validUntil": "2029-08-24T14:15:22Z",
"usedWith": [
"5237bcac-c548-4e49-8626-03dab65376d6"
]
}No content
Redeems reward points for a specified customer for a given tenant without generating a coupon. The tenant name is retrieved from the access token.
Note: Only employees are authorized to perform this action.
Required scopes
rewardspoints.rewardpoints_manage
Unique identifier of a customer
Identifier of the redeemed points
A comment for the redeem operation
The amount of the redeemed points
Timestamp when the points were redeemed
Number of points after creation
POST /reward-points/customer/{customerId}/redeemPoints HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"description": "points redeemed",
"points": 50
}No content