跳转到内容
/
删除区域

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允许获取任意类型的可售商品或指定商品。

操作

通用区域

操作

创建区域Server-sideAdmin

请求

创建区域。

可使用区域来管理区域限制。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
正文application/json
countriesArray of strings(Regions_countries)必需

要添加到区域的国家/地区列表。
ISO 3166-1 alpha-2标准下的两个大写字母的国家/地区代码。 请查看文档详细了解艾克索拉支持的国家/地区。
示例：["JP", "CN", "VN"]

nameobject(Regions_name)必需

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

默认值 {"de-DE":"Asien","en-US":"Asia"}
示例: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*string附加属性
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/region \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

响应

区域已成功创建。

正文application/json
region_idinteger(Regions_region_id)

区域ID。项目内的唯一区域标识符。

示例: 42
响应
application/json
{
  "region_id": 42
}

删除区域Server-sideAdmin

请求

删除特定区域。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
region_idinteger必需

区域ID。项目内的唯一区域标识符。

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

响应

区域已成功删除。

正文
响应
无内容

获取区域Server-sideAdmin

请求

获取特定区域。

可使用区域来管理区域限制。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
region_idinteger必需

区域ID。项目内的唯一区域标识符。

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

响应

指定区域已成功接收。

正文application/json
countriesArray of strings(Regions_countries)

要添加到区域的国家/地区列表。
ISO 3166-1 alpha-2标准下的两个大写字母的国家/地区代码。 请查看文档详细了解艾克索拉支持的国家/地区。
示例：["JP", "CN", "VN"]

idinteger(Regions_region_id)

区域ID。项目内的唯一区域标识符。

示例: 42
nameobject(Regions_name)

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

默认值 {"de-DE":"Asien","en-US":"Asia"}
示例: {"de-DE":"Asien","en-US":"Asia"}
响应
application/json
{
  "value": {
    "countries": [ … ],
    "id": 44,
    "name": { … }
  }
}

目录

操作

权利

操作

管理

操作

通用

操作

优惠券

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

操作

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

操作

管理

操作

目录

操作

虚拟支付

操作

管理

操作

管理

操作

客户端

操作

公会客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作