Item SKU.
/
Add quantity to item pre-...
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
Request
Get pre-order limit of the item.
Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the Admin section of the desired item module:
Aliases for this endpoint:
- /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
Security
basicAuth
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/pre_order/limit/item/sku/{item_sku}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/pre_order/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://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1Response
application/json
{ "item_id": 1, "sku": "com.xsolla.item_1", "is_pre_order_limit_enabled": true, "available": 431, "reserved": 13, "sold": 556 }
Request
Add quantity to pre-order limit of the item.
Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the Admin section of the desired item module:
Aliases for this endpoint:
- /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
Security
basicAuth
Path
Bodyapplication/jsonProject 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/pre_order/limit/item/sku/{item_sku}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}
- 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/items/pre_order/limit/item/sku/booster_mega_1 \
-H 'Content-Type: application/json' \
-d '{
"quantity": 100000
}'Request
Set quantity of pre-order limit of the item.
Pre-Order limit API allows you to sell an item in a limited quantity. For configuring the pre-order itself, go to the Admin section of the desired item module:
Aliases for this endpoint:
- /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
Security
basicAuth
Path
Bodyapplication/jsonProject 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/pre_order/limit/item/sku/{item_sku}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}
- 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/pre_order/limit/item/sku/booster_mega_1 \
-H 'Content-Type: application/json' \
-d '{
"quantity": 100000
}'