This API allows getting any kind of sellable items or specific item.
- Activate promo code promotion
Redeem promo code
Remove promo code from cart
Get promo code rewards
Create promo code promotion
Get list of promo code promotions
Update promo code promotion
Get promo code promotion
Delete promo code promotion
Deactivate promo code promotion
Create code for promo code promotion
Get codes of promo code promotion
Generate codes for promo code promotion
Get promo code limit for specified user
Get promo code limit for codes
Activate promo code promo...
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
Request
Deletes promo code promotion. The deleted promotion:
- Disappears from the list of promotions set up in your project.
- Is no longer applied to the item catalog and the cart. User can’t get bonus items or purchase items using this promotion.
After deletion, the promotion can’t be restored. Promo 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/promocode/{external_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{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/promocode/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/promocode/{external_id}/activate
- https://store.xsolla.com/api/v2/project/{project_id}/admin/promocode/{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/promocode/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/shop-builder/v2/project/{project_id}/admin/promocode/{external_id}/deactivate
- https://store.xsolla.com/api/v2/project/{project_id}/admin/promocode/{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/shop-builder/v2/project/44056/admin/promocode/coupon_44056_1/deactivate