Main docs page
Auth API
Ordering API
Menu API
Venue API
Inventory API
Payment API
Loyalty API
Wallet API
Main docs page
Auth API
Ordering API
Menu API
Venue API
Inventory API
Payment API
Loyalty API
Wallet API
Get reward by id.
ROLE_SUROLE_REWARDS) | reward required | string <uuid> |
| x-tenant | string <uuid> |
Update reward by id.
ROLE_SUROLE_REWARDS) | reward required | string <uuid> |
| x-tenant | string <uuid> |
| code | string [ 1 .. 32 ] characters |
| name required | string [ 3 .. 128 ] characters [\p{L}\p{N}_. -]+ |
| visible | boolean Visible in catalog and allowed to exchange for points by users themselves |
object (Details) | |
| availableFrom | string <date-time> |
| availableTo | string <date-time> |
| points required | number > 0 |
| maxCount | integer <int32> >= 1 |
| priority | integer <int32> >= 0 |
| product required | string |
| productConfig | object |
| tags | Array of strings |
object |
Delete reward by id.
ROLE_SUROLE_REWARDS) | reward required | string <uuid> |
| x-tenant | string <uuid> |
Insert reward by id.
ROLE_SUROLE_REWARDS) | x-tenant | string <uuid> |
| code | string [ 1 .. 32 ] characters |
| name required | string [ 3 .. 128 ] characters [\p{L}\p{N}_. -]+ |
| visible | boolean Visible in catalog and allowed to exchange for points by users themselves |
object (Details) | |
| availableFrom | string <date-time> |
| availableTo | string <date-time> |
| points required | number > 0 |
| maxCount | integer <int32> >= 1 |
| priority | integer <int32> >= 0 |
| product required | string |
| productConfig | object |
| tags | Array of strings |
object |
Get aggregated report. This endpoint is compatible with React AdminOnRest framework to provide DataSource.
ROLE_SUROLE_WALLET) required | object (AggregateFilter) |
Expired paid batches in period.
ROLE_SUROLE_WALLET) | from required | string <date-time> |
| to required | string <date-time> |
| x-tenant | string <uuid> |
Points expiring in near future.
ROLE_SUROLE_WALLET) | to required | string <date-time> |
| x-tenant | string <uuid> |
Wallets report.
ROLE_SUROLE_WALLET) | x-tenant | string <uuid> |
Vouchers in period.
ROLE_SUROLE_WALLET) | from required | string <date-time> |
| to required | string <date-time> |
| x-tenant | string <uuid> |
Create and add new batch of points. Batch can have expiration date and price for which points were bought..
ROLE_SUROLE_WALLETROLE_WALLET_BATCH) | wallet required | string <uuid> |
| x-tenant | string <uuid> |
| amount required | number > 0 |
| price | number > 0 |
| expires | string <date-time> |
| order | string [ 0 .. 64 ] characters |
object |
Expired paid batches in period.
ROLE_SUROLE_WALLET) | from required | string <date-time> |
| to required | string <date-time> |
| x-tenant | string <uuid> |
Points expiring in near future.
ROLE_SUROLE_WALLET) | to required | string <date-time> |
| x-tenant | string <uuid> |
New operation (usage of collected points)
ROLE_SUROLE_WALLETROLE_WALLET_OP) | wallet required | string <uuid> |
| x-tenant | string <uuid> |
| amount required | number > 0 |
| order | string [ 0 .. 64 ] characters |
object |
Operation rollback (points are returned to batches they were collected from).
ROLE_SUROLE_WALLETROLE_WALLET_OP) | wallet required | string <uuid> |
| x-tenant | string <uuid> |
Wallets report.
ROLE_SUROLE_WALLET) | x-tenant | string <uuid> |
Get wallet for specific user. If it is not created - get 404.
ROLE_SUROLE_WALLET) | wallet required | string <uuid> |
| x-tenant | string <uuid> |
Update wallet for logged user. If wallet was not there - it is created.
ROLE_SUROLE_WALLET) | wallet required | string <uuid> |
| x-tenant | string <uuid> |
| property name* | string |
Create wallet for specific user. If wallet is already there - attributes are overwritten if they are provided and not empty.
ROLE_SUROLE_WALLET) | wallet required | string <uuid> |
| x-tenant | string <uuid> |
| property name* | string |
Vouchers in period.
ROLE_SUROLE_WALLET) | from required | string <date-time> |
| to required | string <date-time> |
| x-tenant | string <uuid> |
Create new voucher. Expiration date for voucher can be provided (it also applies to batch of points from that voucher). Additionaly points can last for specified number of days after voucher usage.
ROLE_SUROLE_WALLETROLE_WALLET_VOUCHER) | x-tenant | string <uuid> |
| amount required | number > 0 |
| price | number > 0 |
| expires | string <date-time> |
| pointsExpireInDays | integer <int32> >= 1 |
| forWallet | string <uuid> |
object |
Get voucher details.
ROLE_SUROLE_WALLETROLE_WALLET_VOUCHER) | voucher required | string <uuid> |
| x-tenant | string <uuid> |
Use voucher on specific wallet
ROLE_SUROLE_WALLETROLE_WALLET_VOUCHER) | wallet required | string <uuid> |
| x-tenant | string <uuid> |
| voucher required | string <uuid> |