跳转到内容

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允许您限量销售商品。要配置购买限制,请前往所需商品类型模块的管理部分:

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
正文application/json
availableinteger(User-limit_available)>= 1必需

在应用的限制数内用户可购的剩余商品数或可用的促销活动次数。

userobject(User-limit_user)必需
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$必需

用户外部ID。

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

响应

已成功收到用户的购买限制。

正文application/json
per_userobject
响应
application/json
{ "per_user": { "available": 9, "total": 10 } }

设置指定用户可购的商品数量Server-sideAdmin

请求

在增加或减少次数后设置指定用户在应用的限制范围内可购的商品数量

用户限制API允许您限量销售商品。要配置购买限制,请前往所需商品类型模块的管理部分:

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
正文application/json
availableinteger(User-limit_available_flexible)>= 0必需

在应用的限制数内用户可购的剩余商品数或可用的促销活动次数。

userobject(User-limit_user)必需
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$必需

用户外部ID。

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 0,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

响应

已成功收到用户的购买限制。

正文application/json
per_userobject
响应
application/json
{ "per_user": { "available": 9, "total": 10 } }

刷新购买限制Server-sideAdmin

请求

刷新商品的购买限制,以便用户可以再次购买。如果user参数为null,此调用会为所有用户刷新此限制。

用户限制API允许您限量销售商品。要配置购买限制,请前往所需商品类型模块的管理部分:

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
item_skustring必需

商品SKU。

示例: booster_mega_1
正文application/json
userobject or null(User-limit_user_flexible)必需
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$

用户外部ID。

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

响应

已成功刷新限制。

响应
无内容
操作
操作
操作
操作

目录

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

操作
操作
操作