Fills the current cart with items. If the cart already has an item with the same SKU, the existing item will be replaced by the passed value.
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
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
Headers
Bodyapplication/jsonUser identifier can be transferred by using the Xsolla Login User JWT or the Pay Station access token.
Example: ACCESS_TOKEN/LOGIN_JWT
Two-letter uppercase country code per ISO 3166-1 alpha-2. Check the documentation for detailed information about countries supported by Xsolla.
Example: country=US
Example: "US"
The item price currency displayed in the cart. Three-letter code per ISO 4217. Check the documentation for detailed information about currencies supported by Xsolla.
Example: "USD"
- https://store.xsolla.com/api/v2/admin/project/{project_id}/cart/fill
- Mock serverhttps://xsolla.redocly.app/_mock/api/catalog/v2/admin/project/{project_id}/cart/fill
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://store.xsolla.com/api/v2/admin/project/44056/cart/fill?locale=en' \
-H 'Content-Type: application/json' \
-H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
-H 'x-user-id: UNIQUE_ID' \
-d '{
"currency": "USD",
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
}'The cart with items was successfully returned.
Applied promotions for the entire cart. The array is returned in the following cases:
A promotion affects the total cart amount, such as a promo code with the Discount on purchase setting.
A promotion adds bonus items to the cart.
If no order-level promotions are applied, an empty array is returned.
Response
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ { … }, { … }, { … } ], "warnings": [ { … } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { … } ] }
Path
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
Headers
Bodyapplication/jsonUser identifier can be transferred by using the Xsolla Login User JWT or the Pay Station access token.
Example: ACCESS_TOKEN/LOGIN_JWT
Two-letter uppercase country code per ISO 3166-1 alpha-2. Check the documentation for detailed information about countries supported by Xsolla.
Example: country=US
Example: "US"
The item price currency displayed in the cart. Three-letter code per ISO 4217. Check the documentation for detailed information about currencies supported by Xsolla.
Example: "USD"
- https://store.xsolla.com/api/v2/admin/project/{project_id}/cart/{cart_id}/fill
- Mock serverhttps://xsolla.redocly.app/_mock/api/catalog/v2/admin/project/{project_id}/cart/{cart_id}/fill
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://store.xsolla.com/api/v2/admin/project/44056/cart/custom_id/fill?locale=en' \
-H 'Content-Type: application/json' \
-H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
-H 'x-user-id: UNIQUE_ID' \
-d '{
"currency": "USD",
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
}'The cart with items was successfully returned.
Applied promotions for the entire cart. The array is returned in the following cases:
A promotion affects the total cart amount, such as a promo code with the Discount on purchase setting.
A promotion adds bonus items to the cart.
If no order-level promotions are applied, an empty array is returned.
Response
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ { … }, { … }, { … } ], "warnings": [ { … } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { … } ] }