跳转到内容

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

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属性

操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作

目录

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

操作
操作
操作
操作
操作
操作

优惠券

此API让您可以管理优惠券。

操作

促销码

此API让您可以管理促销码。

操作

特别目录优惠

此API让您可以管理特别目录优惠活动。

操作

折扣

此API让您可以管理折扣促销活动。

操作

奖励

此API让您可以管理奖励促销活动。

操作
操作
操作
操作
操作

获取指定用户的促销活动限制Server-sideAdmin

请求

获取指定用户在应用的限制内可以使用促销活动的剩余次数。

用户限制API允许您限制用户可以使用促销活动的次数。要自行配置用户限制,请前往所需促销活动类型的“管理”部分:

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
promotion_idinteger必需

促销活动ID。项目内的唯一促销活动标识符。

示例: 111425
查询
user_external_idstring必需

用户外部ID

示例: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425?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
promotion_idinteger必需

促销活动ID。项目内的唯一促销活动标识符。

示例: 111425
正文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/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -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
promotion_idinteger必需

促销活动ID。项目内的唯一促销活动标识符。

示例: 111425
正文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/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -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 } }
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作