This API allows getting any kind of sellable items or specific item.
- Delete coupon promotion
Redeem coupon code
Get coupon rewards
Create coupon promotion
Get list of coupon promotions
Update coupon promotion
Get coupon promotion
Activate 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
Delete coupon promotion
Shop Builder 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
Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.
Download OpenAPI description
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/shop-builder/
https://store.xsolla.com/api/
Personalized 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
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/shop-builder/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 GET \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v3/project/44056/admin/coupon/coupon_44056_1Coupon was successfully received.
Unique promotion ID. The external_id may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.
Default "coupon_external_id"
Example: "coupon_external_id"
Promotion validity periods. If multiple periods are specified, both date_from and date_until are required.
Name of promotion. Should contain key/value pairs where key is a locale with "^[a-z]{2}-[A-Z]{2}$" format, value is string.
Default {"en-US":"Coupon title","de-DE":"Gutscheintitel"}
Example: {"en-US":"Coupon title","de-DE":"Gutscheintitel"}
Limits total numbers of coupons.
Default 10
Example: 10
Limits total numbers of coupons redeemed by single user.
Default 10
Example: 10
Number of redemptions per code.
Default 10
Example: 10
Limits for each unique coupon code.
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items
Conditions for validating user attributes. Determine promotion availability based on whether user attributes match all specified conditions.
Response
application/json
{ "external_id": "summer20221", "promotion_periods": [ { … }, { … } ], "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "is_enabled": true, "bonus": [ { … } ], "redeem_user_limit": null, "redeem_total_limit": 100, "redeem_code_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } }
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/shop-builder/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/shop-builder/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/shop-builder/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/shop-builder/v2/project/44056/admin/coupon/coupon_44056_1/activate