This API allows getting any kind of sellable items or specific item.
- Revoke entitlement (admin)
Get list of games owned by user
Redeem game code by client
Grant entitlement (admin)
Revoke entitlement (admin...
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
Bodyapplication/jsonrequiredProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
Object with game properties.
Example: {"sku":"com.xsolla.game_1"}
Object with DRM properties.
Example: {"sku":"com.xsolla.key_1"}
What type of entitlements should be granted. If the parameter is set to sandbox, the entitlement will be granted to the user in the sandbox mode. If the parameter is set to default, the entitlement will be granted to the user in the live mode.
Enum"default""sandbox"
Example: "default"
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/project/{project_id}/admin/entitlement/grant
- https://store.xsolla.com/api/v2/project/{project_id}/admin/entitlement/grant
- 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/v2/project/44056/admin/entitlement/grant \
-H 'Content-Type: application/json' \
-d '{
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"code": "AAAA-BBBB-CCCC-DDDD",
"mode": "default",
"user_country": "US"
}'Path
Bodyapplication/jsonrequiredProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
Object with game properties.
Example: {"sku":"com.xsolla.game_1"}
Object with DRM properties.
Example: {"sku":"com.xsolla.key_1"}
What type of entitlements should be revoked. If the parameter is set to sandbox, the entitlement will be revoked from the user in the sandbox mode. If the parameter is set to default, the entitlement will be revoked from the user in the live mode.
Enum"default""sandbox"
Example: "default"
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/project/{project_id}/admin/entitlement/revoke
- https://store.xsolla.com/api/v2/project/{project_id}/admin/entitlement/revoke
- 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/v2/project/44056/admin/entitlement/revoke \
-H 'Content-Type: application/json' \
-d '{
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"mode": "default"
}'