跳转到内容
/
设置指定用户可购的商品数量

Catalog API (2.0.0)

概述

  • 版本： 2.0.0
  • 服务器：https://store.xsolla.com/api
  • 通过邮件联系我们
  • 联系URL: https://xsolla.com/
  • 必需的TLS版本： 1.2

商品目录API支持在艾克索拉侧配置游戏内商品目录，并在您的商店中向用户展示目录内容。

通过该API可管理以下目录实体：

  • 虚拟物品 — 游戏内物品，例如武器、皮肤、增益道具。
  • 虚拟货币 — 用于购买虚拟商品的虚拟货币。
  • 虚拟货币套餐 — 预定义的虚拟货币捆绑包。
  • 捆绑包 — 虚拟物品、货币或游戏激活码的组合套餐，以单个SKU形式出售。
  • 游戏密钥 — 适用于Steam等平台或其他DRM提供商分发的游戏和DLC激活码。
  • 组 — 用于在目录中组织和排序商品的逻辑分组。

API调用

API分为以下组别：

  • Admin — 用于创建、更新、删除和配置目录商品及分组的调用。通过基本认证方式验证身份，需使用您的商户或项目凭据。不适用于商店前端调用。
  • Catalog — 用于检索商品并构建面向最终用户的自定义商店前端。专为高负载场景设计。支持可选的用户JWT授权，可返回个性化数据，例如用户特定限制和当前进行中的促销活动。
下载 OpenAPI 描述
index.json
index.yaml
语言
服务器
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/zh/api/catalog/

管理

操作

目录

操作

虚拟支付

操作

目录

操作

权利

操作

管理

操作

管理

操作

目录

操作

购物车（客户端侧）

操作

购物车（服务器侧）

操作

支付（客户端）

操作

支付（服务器端）

操作

订单

操作

免费商品

操作

管理

操作

增加指定用户可购的商品数量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://store.xsolla.com/api/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://store.xsolla.com/api/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://store.xsolla.com/api/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"
    }
  }'

响应

已成功刷新限制。

响应
无内容

管理

操作

Webhook

操作

预订

操作

商户

操作

目录

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

操作

通用区域

操作

管理

操作