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 is a toolkit for driving ongoing player engagement through promotions and personalized offers.
Use the API to manage the following features:
- Promotions — create and manage coupons, promo codes, discounts, and bonus campaigns.
- Personalization — specify the conditions for displaying the item catalog and applying promotions only for certain authorized users.
- Promotion limits — set a limit on how many times a promotion can be used by a user and configure scheduled resets for these limits.
- Reward chains & Value points — configure reward progressions tied to value point accumulation.
- Daily chains — set up recurring daily rewards to motivate regular logins.
- Offer chains — build sequential purchase offers with per-step pricing and free reward options.
- Upsell — a sales method in which the user is offered to buy an item with additional value.
The API is divided into the following groups:
Admin — calls for creating, updating, activating, and deleting campaigns and chain configurations. Authenticated via basic access authentication with your merchant or project credentials.Client — calls for retrieving available promotions, getting active chains, redeeming codes, and claiming rewards on behalf of authenticated end users. Authenticated via user JWT.
Download OpenAPI description
Languages
Servers
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/api/liveops/
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
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/api/liveops/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://store.xsolla.com/api/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
- https://store.xsolla.com/api/v2/project/{project_id}/admin/coupon/{external_id}/activate
- Mock serverhttps://xsolla.redocly.app/_mock/api/liveops/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://store.xsolla.com/api/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
- https://store.xsolla.com/api/v2/project/{project_id}/admin/coupon/{external_id}/deactivate
- Mock serverhttps://xsolla.redocly.app/_mock/api/liveops/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://store.xsolla.com/api/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