This API allows getting any kind of sellable items or specific item.
- Toggle reward chain
Get list of value points
Create value point
Get value point
Update value point
Delete value points
Get list of items with value points
Set value points for items
Partially update value points for items
Delete value points from items
Get list of reward chains
Create reward chain
Get reward chain
Update reward chain
Delete reward chain
Reset reward chain
Toggle reward chain
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/reward_chain/id/{reward_chain_id}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_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/reward_chain/id/101Path
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/reward_chain/id/{reward_chain_id}/toggle
- https://store.xsolla.com/api/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/toggle
- 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/v3/project/44056/admin/reward_chain/id/101/toggleRequest
Resets value points and progress of all users in the reward chain.
After the reset, you can update the validity period of the reward chain and the user can progress through it again.
Notice
You should not reset the reward chain during its validity period. In this case, users may lose earned value points before they claim their reward.
You should not reset the reward chain during its validity period. In this case, users may lose earned value points before they claim their reward.
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/reward_chain/id/{reward_chain_id}/reset
- https://store.xsolla.com/api/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/reset
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v3/project/44056/admin/reward_chain/id/101/reset