Get Coupons data
To obtain coupons that the Seller can use during a transaction (apply to a purchase), it is possible to use the following endpoints:- Get Customer Coupons (SearchUserCoupons) - Returns array of Customer coupons by search params (returns all coupons of the specified Customer).
- Get Active Coupons By Location - Returns array of all active coupons of the specified pos location.
Get Customer Coupons
POST /pos//coupon/couponCode/searchInput request
Copy
{
"code": "string",
"email": "string",
"phone": "string",
"posLocationId": "string"
}
Input parameters
| Field name | Description |
|---|---|
| code | Coupon code |
| Customer email | |
| phone | Customer phone |
| posLocationId | ID of the location where the transaction will be made |
Response
Copy
{
"data": [
{
"rewardProvider": "TwoReward",
"code": "string",
"name": "string",
"title": "string",
"pictureUrl": "string",
"availableUntil": "2025-07-23T15:30:55.308Z",
"status": "Issued",
"info": [
{
"title": "string",
"items": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
]
}
],
"page": {
"page": 0,
"pageSize": 0,
"total": 0
},
"posStatus": "Accepted"
}
Get Active Coupons By Location
GET /pos//coupon/active/locationId/Input request
Copy
{
"posSystemId": "string",
"posLocationId": "string"
}
Input parameters
| Field name | Description |
|---|---|
| posSystemId | POS System ID |
| posLocationId | ID of the location where the transaction will be made |
Response
Copy
{
"data": [
{
"id": "string",
"code": "string",
"url": "string",
"couponImage": "string",
"status": "example | active | archived | template | deleted",
"name": "string",
"title": "string",
"subtitle": "string",
"description": "string",
"couponCategoryId": "string",
"couponCategoryName": "string",
"banner1": "string",
"banner2": "string",
"banner3": "string",
"banner4": "string",
"banner5": "string",
"subaccount": "string",
"logoUrl": "string",
"couponTags": "string",
"expiryDate": "string",
"promotion": {
"value": 0,
"promotionType": 1
},
"isSelected": true
}
],
"page": {
"page": 0,
"pageSize": 0,
"total": 0
},
"posStatus": "Accepted"
}
Apply discount to order
In order to apply a discount to an order, we need to use these parameters:Copy
"promotion": {
"value": 50.0,
"promotionType": "Percentage"
}
Response Example
Copy
{
"posStatus": "Accepted",
"page": {
"page": 1,
"pageSize": 5,
"total": 5
},
"data": [
{
"id": "cam_1192028",
"code": "Cstpt",
"url": "[https://coupon.2reward.me/p/Cstpt](https://coupon.2reward.me/p/Cstpt) ",
"couponImage": "[https://www.hosting4images.com/upload/customimage/9177_logo_240725022923.jpg](https://www.hosting4images.com/upload/customimage/9177_logo_240725022923.jpg)",
"status": "active",
"name": "Restaurant 50% OFF",
"title": "Main Board Set",
"subtitle": "50% off",
"description": "<p style=\"text-align:center\">¡Solo 1 cupón por cliente por día!<br>¡No es válido los fines de semana!<br>Cupón de ejemplo</p>",
"couponCategoryId": "0",
"couponCategoryName": "Other",
"banner1": "[https://www.hosting4images.com/preview/Cstpt_120-600.jpg](https://www.hosting4images.com/preview/Cstpt_120-600.jpg)",
"banner2": "[https://www.hosting4images.com/preview/Cstpt_140-112_20240725163012.jpg](https://www.hosting4images.com/preview/Cstpt_140-112_20240725163012.jpg)",
"banner3": "[https://www.hosting4images.com/preview/Cstpt_180-270_20240725163012.jpg](https://www.hosting4images.com/preview/Cstpt_180-270_20240725163012.jpg)",
"banner4": "[https://www.hosting4images.com/preview/Cstpt_200-150.jpg](https://www.hosting4images.com/preview/Cstpt_200-150.jpg)",
"banner5": "[https://www.hosting4images.com/preview/Cstpt_200-600.jpg](https://www.hosting4images.com/preview/Cstpt_200-600.jpg)",
"subaccount": "sub_9871",
"logoUrl": "[https://www.hosting4images.com/upload/logo/9177_logo_240725022923.jpg](https://www.hosting4images.com/upload/logo/9177_logo_240725022923.jpg)",
"couponTags": "",
"expiryDate": "2month",
"promotion": {
"value": 50.0,
"promotionType": "Percentage"
},
"isSelected": null
},
{
"id": "cam_1192027",
"code": "UWzTt",
"url": "[https://coupon.2reward.me/p/UWzTt](https://coupon.2reward.me/p/UWzTt) ",
"couponImage": "[https://www.hosting4images.com/upload/customimage/9177_logo_240725022923.jpg](https://www.hosting4images.com/upload/customimage/9177_logo_240725022923.jpg)",
"status": "active",
"name": "Restaurant Special Menu 50% Off",
"title": "SPECIAL MENU",
"subtitle": "UP TO 50% OFF",
"description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>",
"couponCategoryId": "0",
"couponCategoryName": "Other",
"banner1": "[https://www.hosting4images.com/preview/UWzTt_120-600.jpg](https://www.hosting4images.com/preview/UWzTt_120-600.jpg)",
"banner2": "[https://www.hosting4images.com/preview/UWzTt_140-112_20240725163330.jpg](https://www.hosting4images.com/preview/UWzTt_140-112_20240725163330.jpg)",
"banner3": "[https://www.hosting4images.com/preview/UWzTt_180-270_20240725163330.jpg](https://www.hosting4images.com/preview/UWzTt_180-270_20240725163330.jpg)",
"banner4": "[https://www.hosting4images.com/preview/UWzTt_200-150.jpg](https://www.hosting4images.com/preview/UWzTt_200-150.jpg)",
"banner5": "[https://www.hosting4images.com/preview/UWzTt_200-600.jpg](https://www.hosting4images.com/preview/UWzTt_200-600.jpg)",
"subaccount": "sub_9871",
"logoUrl": "[https://www.hosting4images.com/upload/logo/9177_logo_240725022922.jpg](https://www.hosting4images.com/upload/logo/9177_logo_240725022922.jpg)",
"couponTags": "",
"expiryDate": "2month",
"promotion": {
"value": 50.0,
"promotionType": "Percentage"
},
"isSelected": null
},
{
"id": "cam_1192025",
"code": "d5kRQ",
"url": "[https://coupon.2reward.me/p/d5kRQ](https://coupon.2reward.me/p/d5kRQ) ",
"couponImage": "[https://www.hosting4images.com/upload/customimage/9177_logo_240725022921.jpg](https://www.hosting4images.com/upload/customimage/9177_logo_240725022921.jpg)",
"status": "active",
"name": "Ice Cream Buy 2 & Get 1 FREE",
"title": "BIG SUMMER SALE",
"subtitle": "All ice creams for $2!",
"description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>",
"couponCategoryId": "0",
"couponCategoryName": "Other",
"banner1": "[https://www.hosting4images.com/preview/d5kRQ_120-600.jpg](https://www.hosting4images.com/preview/d5kRQ_120-600.jpg)",
"banner2": "[https://www.hosting4images.com/preview/d5kRQ_140-112_20240725163219.jpg](https://www.hosting4images.com/preview/d5kRQ_140-112_20240725163219.jpg)",
"banner3": "[https://www.hosting4images.com/preview/d5kRQ_180-270_20240725163219.jpg](https://www.hosting4images.com/preview/d5kRQ_180-270_20240725163219.jpg)",
"banner4": "[https://www.hosting4images.com/preview/d5kRQ_200-150.jpg](https://www.hosting4images.com/preview/d5kRQ_200-150.jpg)",
"banner5": "[https://www.hosting4images.com/preview/d5kRQ_200-600.jpg](https://www.hosting4images.com/preview/d5kRQ_200-600.jpg)",
"subaccount": "sub_9871",
"logoUrl": "[https://www.hosting4images.com/upload/logo/9177_logo_240725022921.jpg](https://www.hosting4images.com/upload/logo/9177_logo_240725022921.jpg)",
"couponTags": "",
"expiryDate": "1week",
"promotion": {
"value": 2.0,
"promotionType": "Amount"
},
"isSelected": null
},
{
"id": "cam_1192024",
"code": "jYvM5",
"url": "[https://coupon.2reward.me/p/jYvM5](https://coupon.2reward.me/p/jYvM5) ",
"couponImage": "[https://www.hosting4images.com/upload/customimage/9177_logo_240725022920.jpg](https://www.hosting4images.com/upload/customimage/9177_logo_240725022920.jpg)",
"status": "active",
"name": "Candy Apples & Cotton Candy ",
"title": "Buy One Get $2 Off Item",
"subtitle": "Cotton Candy, Sno Cones, Candy Apples",
"description": "<p>This is a work of fiction. Names, businesses, places, events and incidents are either the products of the creator's imagination or used in a fictitious manner. Any resemblance to actual events is purely coincidental.</p><p>This is a demo coupon. You cannot redeem this coupon anywhere!</p>",
"couponCategoryId": "0",
"couponCategoryName": "Other",
"banner1": "[https://www.hosting4images.com/preview/jYvM5_120-600.jpg](https://www.hosting4images.com/preview/jYvM5_120-600.jpg)",
"banner2": "[https://www.hosting4images.com/preview/jYvM5_140-112_20240725163334.jpg](https://www.hosting4images.com/preview/jYvM5_140-112_20240725163334.jpg)",
"banner3": "[https://www.hosting4images.com/preview/jYvM5_180-270_20240725163334.jpg](https://www.hosting4images.com/preview/jYvM5_180-270_20240725163334.jpg)",
"banner4": "[https://www.hosting4images.com/preview/jYvM5_200-150.jpg](https://www.hosting4images.com/preview/jYvM5_200-150.jpg)",
"banner5": "[https://www.hosting4images.com/preview/jYvM5_200-600.jpg](https://www.hosting4images.com/preview/jYvM5_200-600.jpg)",
"subaccount": "sub_9871",
"logoUrl": "[https://www.hosting4images.com/upload/logo/9177_logo_240725022920.jpg](https://www.hosting4images.com/upload/logo/9177_logo_240725022920.jpg)",
"couponTags": "",
"expiryDate": "1week",
"promotion": {
"value": 2.0,
"promotionType": "Amount"
},
"isSelected": null
},
{
"id": "cam_1192023",
"code": "LpAhk",
"url": "[https://coupon.2reward.me/p/LpAhk](https://coupon.2reward.me/p/LpAhk) ",
"couponImage": "[https://www.hosting4images.com/upload/customimage/9177_logo_240725022920.jpg](https://www.hosting4images.com/upload/customimage/9177_logo_240725022920.jpg)",
"status": "active",
"name": "Sushi 25% Discount",
"title": "SUSHITO MENU",
"subtitle": "25% OFF",
"description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>",
"couponCategoryId": "0",
"couponCategoryName": "Other",
"banner1": "[https://www.hosting4images.com/preview/LpAhk_120-600.jpg](https://www.hosting4images.com/preview/LpAhk_120-600.jpg)",
"banner2": "[https://www.hosting4images.com/preview/LpAhk_140-112_20240725163152.jpg](https://www.hosting4images.com/preview/LpAhk_140-112_20240725163152.jpg)",
"banner3": "[https://www.hosting4images.com/preview/LpAhk_180-270_20240725163152.jpg](https://www.hosting4images.com/preview/LpAhk_180-270_20240725163152.jpg)",
"banner4": "[https://www.hosting4images.com/preview/LpAhk_200-150.jpg](https://www.hosting4images.com/preview/LpAhk_200-150.jpg)",
"banner5": "[https://www.hosting4images.com/preview/LpAhk_200-600.jpg](https://www.hosting4images.com/preview/LpAhk_200-600.jpg)",
"subaccount": "sub_9871",
"logoUrl": "[https://www.hosting4images.com/upload/logo/9177_logo_240725022919.jpg](https://www.hosting4images.com/upload/logo/9177_logo_240725022919.jpg)",
"couponTags": "",
"expiryDate": "1month",
"promotion": {
"value": 25.0,
"promotionType": "Percentage"
},
"isSelected": null
}
]
}