This API allows getting any kind of sellable items or specific item.
- Generate coupon codes
Redeem coupon code
Get coupon rewards
Create coupon promotion
Get list of coupon promotions
Update coupon promotion
Get coupon promotion
Delete coupon promotion
Activate coupon promotion
Deactivate coupon promotion
Create coupon code
Get coupon codes
Get coupon limit for specified user
Get unique coupon code limits
Generate coupon codes
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/v2/project/{project_id}/admin/coupon/{external_id}/code
- https://store.xsolla.com/api/v2/project/{project_id}/admin/coupon/{external_id}/code
- 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/v2/project/44056/admin/coupon/coupon_44056_1/code?limit=50&offset=0'Response
application/json
{ "codes": [ { … }, { … }, { … }, { … }, { … } ], "total_count": 5 }
Path
Bodyapplication/jsonProject 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}/code/generate
- https://store.xsolla.com/api/v2/project/{project_id}/admin/coupon/{external_id}/code/generate
- 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/code/generate \
-H 'Content-Type: application/json' \
-d '{
"count": 10
}'Response
application/json
{ "count": 10 }
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/v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/coupon/external_id/{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/v2/project/44056/admin/user/limit/coupon/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'Response
application/json
{ "per_user": { "total": 10, "available": 9 } }