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.
下载 OpenAPI 描述
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/shop-builder/
https://store.xsolla.com/api/
个性化目录
此API可让您针对用户属性指定规则。如果用户满足具体规则的所有条件，则会显示个性化商品。
有关个性化促销活动的信息，请参阅促销活动部分。
要在购买前传递属性，您可以使用艾克索拉Login API或在使Pay Station API生成令牌时将它们传入user.attributes属性。
操作
- Mock serverhttps://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/{project_id}/items/id/{item_id}
- https://store.xsolla.com/api/v2/project/{project_id}/items/id/{item_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/59080/items/id/259774?promo_code=WINTER2021&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'已成功接收可售商品。
与商品对应的属性及其值的列表。可用于目录筛选。
默认值 []
示例: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
商品所属分组。
默认值 []
示例: [{"external_id":"exclusive","name":"Exclusive"}]
图像URL。
示例: "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png"
应用于购物车中指定商品的促销活动。仅在以下情况下返回该数组：
为某商品配置了折扣促销活动。
应用了对所选商品提供折扣设置的促销码。
如果未应用任何商品级促销活动，则返回空数组。
商品类型：virtual_good/virtual_currency/bundle/game_key/physical_good。
枚举"virtual_good""virtual_currency""bundle""game_key""physical_good"
示例: "virtual_good"
虚拟物品的类型。
| 枚举 值 | 描述 |
|---|---|
| consumable | 使用后从物品库中消失的物品（例如弹药）。 |
| non_consumable | 无限期地留在物品库中的物品。 |
| non_renewing_subscription | 时效性商品，代表在有限时间内对服务或内容的访问权限。 |
示例: "non-consumable"
响应
application/json
{ "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Electric shield", "groups": [ { … } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "limits": { "per_user": { … } }, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { … } ], "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { … }, { … }, { … } ], "vp_rewards": [ { … }, { … } ] }
- Mock serverhttps://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/{project_id}/items/sku/{sku}
- https://store.xsolla.com/api/v2/project/{project_id}/items/sku/{sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/59080/items/sku/electric_shield?promo_code=WINTER2021&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'已成功接收可售商品。
与商品对应的属性及其值的列表。可用于目录筛选。
默认值 []
示例: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
商品所属分组。
默认值 []
示例: [{"external_id":"exclusive","name":"Exclusive"}]
图像URL。
示例: "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png"
应用于购物车中指定商品的促销活动。仅在以下情况下返回该数组：
为某商品配置了折扣促销活动。
应用了对所选商品提供折扣设置的促销码。
如果未应用任何商品级促销活动，则返回空数组。
商品类型：virtual_good/virtual_currency/bundle/game_key/physical_good。
枚举"virtual_good""virtual_currency""bundle""game_key""physical_good"
示例: "virtual_good"
虚拟物品的类型。
| 枚举 值 | 描述 |
|---|---|
| consumable | 使用后从物品库中消失的物品（例如弹药）。 |
| non_consumable | 无限期地留在物品库中的物品。 |
| non_renewing_subscription | 时效性商品，代表在有限时间内对服务或内容的访问权限。 |
示例: "non-consumable"
响应
application/json
{ "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Electric shield", "groups": [ { … } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "limits": { "per_user": { … } }, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { … } ], "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { … }, { … }, { … } ], "vp_rewards": [ { … }, { … } ] }