跳转到内容

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Catalog API提供端点,用于管理您的游戏内商店目录并处理购买。使用这些端点配置虚拟物品、虚拟货币、游戏密钥、捆绑包、购物车和支付流程、物品属性,以及从外部来源导入物品。

下载 OpenAPI 描述
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/catalog/
https://store.xsolla.com/api/
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作

获取商品预订限制的信息Server-sideAdmin

请求

获取商品的预订数量限制。

预订限制API允许限量销售商品。如要配置预订本身,请前往所需商品模块的管理部分:

此端点的别名:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
安全
basicAuth
路径
project_idinteger必需

项目ID。您可以在您的发布商帐户项目名称旁边找到。

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1

响应

已成功收到商品预订限制的信息。

正文application/json
availableinteger
示例: 431
is_pre_order_limit_enabledboolean
示例: true
item_idinteger
示例: 1
reservedinteger
示例: 13
skustring
示例: "com.xsolla.item_1"
soldinteger
示例: 556
响应
application/json
{ "available": 431, "is_pre_order_limit_enabled": true, "item_id": 1, "reserved": 13, "sku": "com.xsolla.item_1", "sold": 556 }

添加商品预订数量限制Server-sideAdmin

请求

添加商品的预订数量限制。

预订限制API允许限量销售商品。如要配置预订本身,请前往所需商品模块的管理部分:

此端点的别名:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
安全
basicAuth
路径
project_idinteger必需

项目ID。您可以在您的发布商帐户项目名称旁边找到。

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
正文application/json
quantityinteger必需

要添加的数量。

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

响应

已成功添加数量限制。

响应
无内容

设置商品预订数量限制Server-sideAdmin

请求

设置商品的预订数量限制。

预订限制API允许限量销售商品。如要配置预订本身,请前往所需商品模块的管理部分:

此端点的别名:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
安全
basicAuth
路径
project_idinteger必需

项目ID。您可以在您的发布商帐户项目名称旁边找到。

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
正文application/json
quantityinteger必需

要设置的数量。

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

响应

已成功设置数量限制。

响应
无内容
操作

目录

本API允许获取任意类型的可售商品或指定商品。

操作
操作
操作