This API allows to you to manage coupons.
- Activate coupon promotion
Redeem coupon code
Get coupon rewards
Create coupon promotion
Get list of coupon promotions
Update coupon promotion
Get coupon promotion
Delete coupon promotion
Deactivate coupon promotion
Create coupon code
Get coupon codes
Generate coupon codes
Get coupon limit for specified user
Get unique coupon code limits
Activate coupon promotion
LiveOps API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
LiveOps API provides endpoints to drive ongoing player engagement with dynamic promotions and personalized experiences. Use the endpoints to manage coupons, promo codes, discounts, bonuses, unique catalog offers, reward chains, daily chains, offer chains, and upsell.
Download OpenAPI description
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/liveops/
https://store.xsolla.com/api/
Request
Deletes coupon promotion. The deleted promotion:
- Disappears from the list of promotions set up in your project.
- Is no longer applied to the item catalog. User can’t get bonus items with this promotion.
After deletion, the promotion can’t be restored. Coupon codes from the deleted promotion can be added to existing promotions.
Security
basicAuth
Path
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/api/liveops/v3/project/{project_id}/admin/coupon/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/liveops/v3/project/44056/admin/coupon/coupon_44056_1Path
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/api/liveops/v2/project/{project_id}/admin/coupon/{external_id}/activate
- https://store.xsolla.com/api/v2/project/{project_id}/admin/coupon/{external_id}/activate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/liveops/v2/project/44056/admin/coupon/coupon_44056_1/activatePath
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/api/liveops/v2/project/{project_id}/admin/coupon/{external_id}/deactivate
- https://store.xsolla.com/api/v2/project/{project_id}/admin/coupon/{external_id}/deactivate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/liveops/v2/project/44056/admin/coupon/coupon_44056_1/deactivatePersonalized catalog
This API allows to specify rules for user attributes. If the user meets all conditions for a concrete rule, personalized items will be shown.
For personalized promotions see Promotions section.
To pass attributes before a purchase, you can use Xsolla Login API or pass them into user.attributes property while generating token using Pay Station API.
Operations