跳转到内容
/
删除特别目录优惠促销活动

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让您可以管理特别目录优惠活动。

操作

创建特别目录优惠促销活动Server-sideAdmin

请求

创建一个特别目录优惠促销活动。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
正文application/json
date_endstring or null(date-time)(Promotions_coupon_date_end)

促销活动结束日期。可以是null。如果date_end 为null，则促销活动无时间限制。

默认值 "2020-04-15T18:16:00+05:00"
date_startstring or null(date-time)(Promotions_coupon_date_start)

促销活动开始日期。

默认值 "2020-04-15T18:16:00+05:00"
external_idstring(Promotions_coupon-external_id)必需

唯一促销活动ID。 external_id只能包含大小写英文字母和数字字符、句点、破折号和下划线。

默认值 "coupon_external_id"
示例: "coupon_external_id"
itemsArray of strings(Promotions_unique_catalog_offer_items)

使用特别目录优惠后可用的商品SKU列表。

示例: ["booster_mega_1"]
nameobject(Promotions_coupon_name)必需

促销活动名称。应包含键/值对， 其中键是"^[a-z]{2}-[A-Z]{2}$"格式的区域设置，值是字符串。

默认值 {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
示例: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
name.​property name*string附加属性
redeem_code_limitinteger or null(Promotions_redeem_code_limit)

每个代码的兑换次数。

默认值 10
示例: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

限制优惠券的总数。

默认值 10
示例: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

限制单个用户兑换的优惠券总数。

默认值 10
示例: 10
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v3/project/44056/admin/unique_catalog_offer \
  -H 'Content-Type: application/json' \
  -d '{
    "date_end": "2020-04-25T18:16:00+05:00",
    "date_start": "2020-04-15T18:16:00+05:00",
    "external_id": "offer_external_id",
    "items": [
      "elven_sword",
      "elven_boots"
    ],
    "name": {
      "de-DE": "Neujahrsangebot",
      "en-US": "New Year Offer"
    },
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

响应

已成功创建特别目录优惠。

正文application/json
external_idstring(Promotions_coupon-external_id)

唯一促销活动ID。 external_id只能包含大小写英文字母和数字字符、句点、破折号和下划线。

默认值 "coupon_external_id"
示例: "coupon_external_id"
响应
application/json
{
  "external_id": "coupon_external_id"
}

删除特别目录优惠促销活动Server-sideAdmin

请求

删除特别目录优惠促销活动。删除的促销活动将：

  • 从您项目中设置的促销活动列表中消失。
  • 不再适用于商品目录和购物车。用户无法通过该促销活动购买商品。

删除后，该促销活动无法恢复。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
external_idinteger必需

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

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

响应

成功删除特别目录优惠。

响应
无内容

获取特别目录优惠促销活动Server-sideAdmin

请求

获取指定的特别目录优惠促销活动。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
external_idinteger必需

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

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

响应

已成功收到特别目录优惠。

正文application/json
external_idstring(Promotions_coupon-external_id)

唯一促销活动ID。 external_id只能包含大小写英文字母和数字字符、句点、破折号和下划线。

默认值 "coupon_external_id"
示例: "coupon_external_id"
is_enabledboolean(Promotions_coupon-is_enabled)
默认值 true
itemsArray of strings(Promotions_unique_catalog_offer_items)

使用特别目录优惠后可用的商品SKU列表。

示例: ["booster_mega_1"]
nameobject(Promotions_coupon_name)

促销活动名称。应包含键/值对， 其中键是"^[a-z]{2}-[A-Z]{2}$"格式的区域设置，值是字符串。

默认值 {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
示例: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
promotion_periodsArray of objects(promotion_periods)

促销活动有效期。若指定了多个时间段，则date_from和date_until均为必需。

redeem_code_limitinteger or null(Promotions_redeem_code_limit)

每个代码的兑换次数。

默认值 10
示例: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

限制优惠券的总数。

默认值 10
示例: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

限制单个用户兑换的优惠券总数。

默认值 10
示例: 10
total_limit_stateobject or null(Promotions_coupon_total_limit_state)

每个唯一优惠券码的限制。

响应
application/json
{
  "external_id": "secret_shop",
  "is_enabled": true,
  "items": [
    "helmet",
    "sword",
    "shield"
  ],
  "name": {
    "en-US": "Secret shop",
    "ru-RU": "Секретный магазин"
  },
  "promotion_periods": [
    { … },
    { … }
  ],
  "redeem_code_limit": 1,
  "redeem_total_limit": 100,
  "redeem_user_limit": 1,
  "total_limit_state": {
    "available": 50,
    "reserved": 10,
    "used": 40
  }
}

折扣

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

操作

奖励

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

操作

管理

操作

目录

操作

虚拟支付

操作

管理

操作

管理

操作

客户端

操作

公会客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作