跳转到内容
/
部分更新商品的奖励积分

Shop Builder API (2.0.0)

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 描述
index.json
index.yaml
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/shop-builder/
https://store.xsolla.com/api/

管理

操作

个性化目录

此API可让您针对用户属性指定规则。如果用户满足具体规则的所有条件，则会显示个性化商品。

有关个性化促销活动的信息，请参阅促销活动部分。

要在购买前传递属性，您可以使用艾克索拉Login API或在使Pay Station API生成令牌时将它们传入user.attributes属性。

操作

管理

操作

目录

操作

购物车（客户端侧）

操作

购物车（服务器侧）

操作

支付（客户端）

操作

支付（服务器端）

操作

订单

操作

免费商品

操作

Webhook

操作

预订

操作

商户

操作

目录

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

操作

通用区域

操作

目录

操作

权利

操作

管理

操作

通用

操作

优惠券

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

操作

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

操作

管理

操作

目录

操作

虚拟支付

操作

管理

操作

管理

操作

获取有奖励积分的商品列表Server-sideAdmin

请求

获取项目内有奖励积分的商品列表以用于管理。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
value_point_skustring必需

奖励积分SKU。

示例: value_point_3
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards

响应

成功收到具有奖励积分的商品列表。

正文application/json
itemsArray of objects(admin-item-value-point-reward)
响应
application/json
{
  "items": [
    { … },
    { … }
  ]
}

部分更新商品的奖励积分Server-sideAdmin

请求

按照商品SKU来部分更新一个或多个商品的奖励积分数量。用户在购买指定商品后可获得这些奖励积分。

更新奖励积分的原则：

  • 如果某个商品尚无奖励积分，则在amount字段中发送非零值将创建奖励积分。
  • 如果某个商品已有奖励积分，则在amount字段中发送非零值将更新原有值。
  • 如果amount设置为0，则会删除该商品的现有奖励积分。

与PUT方法（设置商品的奖励积分）不同，此PATCH方法不会覆盖项目中所有商品的现有奖励积分，它只会更新指定的商品。

单个请求最多可以更新100个商品。同一请求中不能包含重复的商品SKU。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
value_point_skustring必需

奖励积分SKU。

示例: value_point_3
正文application/jsonArray [
amountinteger>= 0必需

奖励积分的数量。

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$必需

唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。

示例: "booster_mega_1"
]
curl -i -X PATCH \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "booster_1"
    },
    {
      "amount": 0,
      "sku": "booster_mega"
    }
  ]'

响应

已成功更新商品的奖励积分。

正文
响应
无内容

设置商品的奖励积分Server-sideAdmin

请求

按SKU将奖励积分分配给一件或多件商品。用户购买这些商品后将获得奖励积分。

请注意，此PUT请求将覆盖项目中商品所有先前设置的奖励积分。

为了避免无意中删除奖励积分，请在每个PUT请求中包含所有商品及其各自的奖励积分。

如果只想更新特定商品的奖励积分，同时保留其他商品的奖励积分，则应使用GET请求检索当前的奖励积分集，修改所需商品的奖励积分，然后返回包含特定商品更新后奖励积分的奖励积分集。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
value_point_skustring必需

奖励积分SKU。

示例: value_point_3
正文application/jsonArray [
amountinteger必需

奖励积分的数量。

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$必需

唯一商品ID。 SKU只能包含大小写英文字母和数字字符、句点、破折号和下划线。

示例: "booster_mega_1"
]
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "com.xsolla.booster_1"
    },
    {
      "amount": 200,
      "sku": "com.xsolla.booster_mega"
    }
  ]'

响应

已成功更新商品的奖励积分。

正文
响应
无内容

客户端

操作

公会客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作