User external ID.
Catalog 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
The Catalog API allows you to configure a catalog of in-game items on the Xsolla side and display the catalog to users in your store.
The API allows you to manage the following catalog entities:
- Virtual items — in-game items such as weapons, skins, boosters.
- Virtual currency — virtual money used to purchase virtual goods.
- Virtual currency packages — predefined bundles of virtual currency.
- Bundles — combined packages of virtual items, currency, or game keys sold as a single SKU.
- Game keys — keys for games and DLCs distributed via platforms like Steam or other DRM providers.
- Groups — logical groupings for organizing and sorting items within the catalog.
The API is divided into the following groups:
Admin — calls for creating, updating, deleting, and configuring catalog items and groups. Authenticated via basic access authentication with your merchant or project credentials. Not intended for storefront use.Catalog — calls for retrieving items and building custom storefronts for end users. Designed to handle high-load scenarios. Support optional user JWT authorization to return personalized data such as user-specific limits and active promotions.
Download OpenAPI description
Languages
Servers
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/api/catalog/
Path
Bodyapplication/jsonProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/item/all
- Mock serverhttps://xsolla.redocly.app/_mock/api/catalog/v2/project/{project_id}/admin/user/limit/item/all
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/all \
-H 'Content-Type: application/json' \
-d '{
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}'Request
Refreshes the purchase limit for an item so a user can buy it again. If the user parameter is null, this call refreshes this limit for all users.
User limit API allows you to sell an item in a limited quantity. To configure the purchase limits, go to the Admin section of the desired item type module:
Security
basicAuth
Path
Bodyapplication/jsonProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all
- Mock serverhttps://xsolla.redocly.app/_mock/api/catalog/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/sku/booster_mega_1/all \
-H 'Content-Type: application/json' \
-d '{
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}'Path
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}
- Mock serverhttps://xsolla.redocly.app/_mock/api/catalog/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/sku/booster_mega_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'Response
application/json
{ "per_user": { "total": 10, "available": 9 } }