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.
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
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"
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/admin/project/{project_id}/cart/fill
- https://store.xsolla.com/api/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://xsolla.redocly.app/_mock/api/shop-builder/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.cup01",
"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"
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/admin/project/{project_id}/cart/{cart_id}/fill
- https://store.xsolla.com/api/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://xsolla.redocly.app/_mock/api/shop-builder/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.cup01",
"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": [ { … } ] }