This API allows getting any kind of sellable items or specific item.
- Set value points for items
Get list of value points
Create value point
Get value point
Update value point
Delete value points
Get list of items with value points
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
Toggle reward chain
Reset reward chain
Set value points for item...
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/items/{value_point_sku}/value_points/rewards
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- 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/items/value_point_3/value_points/rewardsResponse
application/json
{ "items": [ { … }, { … } ] }
Request
Assigns value points to one or several items by an SKU. Users receive value points after they purchase these items.
Note that this PUT request overwrites all previously set value points for items in the project.
To avoid unintentional deletion of value points, include all items and their respective value points in each PUT request.
If you only want to update the value points for a specific item while preserving the value points of other items, you should retrieve the current set of value points using a GET request, modify the desired item's value points, and then send the modified set of value points back with the updated value points for the specific item.
Security
basicAuth
Path
Bodyapplication/jsonArray [Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
Unique item ID. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.
Example: "booster_mega_1"
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- 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/items/value_point_3/value_points/rewards \
-H 'Content-Type: application/json' \
-d '[
{
"sku": "com.xsolla.booster_1",
"amount": 100
},
{
"sku": "com.xsolla.booster_mega",
"amount": 200
}
]'Request
Partially updates the number of value points for one or more items by the item’s SKU. Users receive these value points after purchasing the specified items.
Principles of updating value points:
- If an item does not yet have value points, sending a non-zero value in the
amountfield creates them. - If an item already has value points, sending a non-zero value in the
amountfield updates them. - If
amountis set to 0, the existing value points for that item are deleted.
Unlike the PUT method (Set value points for items), this PATCH method does not overwrite all existing value points for items in the project, it only updates the specified items.
A single request can update up to 100 items. Duplicate item SKUs cannot be included in the same request.
Security
basicAuth
Path
Bodyapplication/jsonArray [Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
Unique item ID. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.
Example: "booster_mega_1"
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
-H 'Content-Type: application/json' \
-d '[
{
"sku": "booster_1",
"amount": 100
},
{
"sku": "booster_mega",
"amount": 0
}
]'