跳转到内容
/
删除每日奖励

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
正文application/json
One of:

用于calendar_hard类型的每日奖励。

date_startstring(date-time)(calendar_hard_date_start)必需

每日奖励开始日期。

示例: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

每日奖励是否循环。如果为true，每日奖励将在结束日期后自动重置。下个周期的start_date和end_date基于每日奖励步骤总数和首次start_date的时间设定自动计算。

默认值 false
示例: true
typestring必需

决定用户可领取奖励时间的每日奖励类型。

枚举 值描述
calendar_hard

每24小时解锁下一步骤奖励。下一步骤奖励可用后，之前未领取的奖励将永久失效。

rolling_skippable

基于date_start每24小时解锁下一步骤奖励。奖励按顺序解锁：必须领取当前奖励才能解锁下一个。用户跳过数天后可从上次进度继续；错过的天数不会累积多个奖励。

rolling_unskippable

基于date_start每24小时解锁下一步骤奖励。奖励按顺序解锁：必须领取当前奖励才能解锁下一个。若用户跳过一天，进度将重置，需从第一步重新开始。

description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

包含本地化商品描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，en）或五个字符的区域设置代码（例如，en-US）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：en和en-US），将存储最后提供的值。您可以在文档中找到支持语言的完整列表。

One of:

包含本地化商品描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，en）或五个字符的区域设置代码（例如，en-US）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：en和en-US），将存储最后提供的值。您可以在文档中找到支持语言的完整列表。

is_enabledboolean(is_enabled)必需
示例: true
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)必需

包含商品本地化名称的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，en）或五个字符的语言代码（例如，en-US）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：en和en-US），将存储最后提供的值。您可以在文档中找到支持语言的完整列表。

One of:

包含商品本地化名称的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，en）或五个字符的语言代码（例如，en-US）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：en和en-US），将存储最后提供的值。您可以在文档中找到支持语言的完整列表。

name.​arstring or null

阿拉伯语

name.​bgstring or null

保加利亚语

name.​cnstring or null

中文（简体）

name.​csstring or null

捷克语

name.​destring or null

德语

name.​enstring or null

英语

name.​esstring or null

西班牙语（西班牙）

name.​frstring or null

法语

name.​hestring or null

希伯来语

name.​idstring or null

印度尼西亚语

name.​itstring or null

意大利语

name.​jastring or null

日语

name.​kmstring or null

高棉语

name.​kostring or null

韩语

name.​lostring or null

老挝语

name.​mystring or null

缅甸语

name.​nestring or null

尼泊尔语

name.​phstring or null

菲律宾语

name.​plstring or null

波兰语

name.​ptstring or null

葡萄牙语

name.​rostring or null

罗马尼亚语

name.​rustring or null

俄语

name.​thstring or null

泰语

name.​trstring or null

土耳其语

name.​twstring or null

中文（繁体）

name.​vistring or null

越南语

orderinteger(order)

定义排列顺序。

示例: 1
stepsArray of objects(create-daily-chain-step-model)必需
steps[].​itemsArray of objects(modify-daily-chain-item-model)non-empty必需
steps[].​items[].​quantityinteger>= 1必需

此sku的每日奖励步骤数量

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

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

示例: "booster_mega_1"
steps[].​step_numberinteger(daily_chain_step_number)>= 1必需

步骤编号。

示例: 2
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/daily_chain \
  -H 'Content-Type: application/json' \
  -d '{
    "date_start": "2023-04-15T18:16:00+05:00",
    "description": {
      "en": "New daily reward short description"
    },
    "is_enabled": true,
    "name": {
      "en": "New daily reward",
      "ru": "Новая ежедневная награда"
    },
    "order": 4,
    "steps": [
      {
        "items": [
          {
            "quantity": 2,
            "sku": "vg_enabled_shown_in_store_1"
          }
        ],
        "step_number": 1
      },
      {
        "items": [
          {
            "quantity": 2,
            "sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
          }
        ],
        "step_number": 2
      },
      {
        "items": [
          {
            "quantity": 2,
            "sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
          }
        ],
        "step_number": 3
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_enabled_shown_in_store_1"
          }
        ],
        "step_number": 4
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
          }
        ],
        "step_number": 5
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
          }
        ],
        "step_number": 6
      }
    ],
    "type": "calendar_hard"
  }'

响应

每日奖励创建成功。

正文application/json
daily_chain_idinteger
示例: 10
响应
application/json
{
  "daily_chain_id": 10
}

删除每日奖励Server-sideAdmin

请求

删除指定每日奖励。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
daily_chain_idinteger必需

每日奖励ID。

示例: 101
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/daily_chain/id/101

响应

每日奖励删除成功。

正文
响应
无内容

获取每日奖励Server-sideAdmin

请求

获取指定每日奖励以用于管理。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
daily_chain_idinteger必需

每日奖励ID。

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

响应

每日奖励数据检索成功。

正文application/json
date_startstring(date-time)(calendar_hard_date_start)

每日奖励开始日期。

示例: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

每日奖励是否循环。如果为true，每日奖励将在结束日期后自动重置。下个周期的start_date和end_date基于每日奖励步骤总数和首次start_date的时间设定自动计算。

默认值 false
示例: true
typestring

决定用户可领取奖励时间的每日奖励类型。

枚举 值描述
calendar_hard

每24小时解锁下一步骤奖励。下一步骤奖励可用后，之前未领取的奖励将永久失效。

rolling_skippable

基于date_start每24小时解锁下一步骤奖励。奖励按顺序解锁：必须领取当前奖励才能解锁下一个。用户跳过数天后可从上次进度继续；错过的天数不会累积多个奖励。

rolling_unskippable

基于date_start每24小时解锁下一步骤奖励。奖励按顺序解锁：必须领取当前奖励才能解锁下一个。若用户跳过一天，进度将重置，需从第一步重新开始。

鉴别器
date_endstring or null(date-time)(daily_chain_date_end)

每日奖励结束日期。可以为null。类型设置为calendar_hard时将根据添加的步骤数量自动设置此日期，因此可以将其保留为null。

示例: "2020-04-15T18:16:00+05:00"
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

包含本地化商品描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，en）或五个字符的区域设置代码（例如，en-US）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：en和en-US），将存储最后提供的值。您可以在文档中找到支持语言的完整列表。

One of:

包含本地化商品描述的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，en）或五个字符的区域设置代码（例如，en-US）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：en和en-US），将存储最后提供的值。您可以在文档中找到支持语言的完整列表。

idinteger(daily_chain_id)

唯一每日奖励ID。

示例: 9
is_enabledboolean(is_enabled)
示例: true
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)

包含商品本地化名称的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，en）或五个字符的语言代码（例如，en-US）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：en和en-US），将存储最后提供的值。您可以在文档中找到支持语言的完整列表。

One of:

包含商品本地化名称的对象。值接受以下两种格式之一：两个小写字母的语言代码（例如，en）或五个字符的语言代码（例如，en-US）。虽然两种格式都可作为输入接受，但响应会返回两个小写字母的语言代码。当为同一种语言提供了两种输入时（例如：en和en-US），将存储最后提供的值。您可以在文档中找到支持语言的完整列表。

number_of_stepsinteger(daily_chain_number_of_step)

每日奖励中配置的步骤数量。这里的每个步骤代表每日奖励中的一天。

示例: 3
orderinteger(order)

定义排列顺序。

示例: 1
stepsArray of objects(admin-daily-chain-step-model)
响应
application/json
{
  "date_end": "2025-04-25T18:16:00+05:00",
  "date_start": "2023-04-15T18:16:00+05:00",
  "description": {
    "en": "Daily reward short description"
  },
  "id": 3,
  "is_enabled": true,
  "is_recurrent": false,
  "name": {
    "en": "Daily reward",
    "ru": "Ежедневная награда"
  },
  "number_of_steps": 3,
  "order": 1,
  "steps": [
    { … },
    { … },
    { … }
  ],
  "type": "calendar_hard"
}

客户端

操作

管理

操作

客户端

操作

管理

操作