跳转到内容
/
创建属性

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/

管理

操作

获取属性列表（管理）Server-sideAdmin

请求

从项目中获取用于管理的属性列表。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
查询
limitinteger>= 1

页面上元素数量的限制。

示例: limit=50
offsetinteger>= 0

元素编号，从该元素开始生成列表（从0开始数）。

示例: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/attribute?limit=50&offset=0'

响应

已成功接收属性列表。

正文application/json
attributesArray of objects(admin_attribute_response)
示例: [{"value":[{"external_id":"genre","name":{"de":"Genre","en":"Genre"}}]}]
total_countinteger
响应
application/json
{
  "attributes": [
    { … },
    { … }
  ],
  "total_count": 2
}

创建属性Server-sideAdmin

请求

创建一个属性。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
正文application/json
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$必需

唯一属性ID。 external_id只能包含大小写英文字母和数字字符、破折号和下划线。

示例: "attribute_1"
nameobject(admin-attribute-name)必需

包含本地化属性名称的对象。编码按照ISO 3166-1的规定。

默认值 {"de":"Genre","en":"Genre"}
示例: {"de":"Genre","en":"Genre"}
name.​property name*string附加属性
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/attribute \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "genre",
    "name": {
      "de": "Genre",
      "en": "Genre"
    }
  }'

响应

已成功创建属性。

正文application/json
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

唯一属性ID。 external_id只能包含大小写英文字母和数字字符、破折号和下划线。

示例: "attribute_1"
响应
application/json
{
  "external_id": "genre"
}

删除属性Server-sideAdmin

请求

删除属性。

注意

删除属性后，其所有数据及与商品的关联关系将被移除。
安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
external_idstring必需

属性外部ID。

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

响应

已成功删除属性。

响应
无内容

个性化目录

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

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

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

操作

管理

操作

目录

操作

购物车（客户端侧）

操作

购物车（服务器侧）

操作

支付（客户端）

操作

支付（服务器端）

操作

订单

操作

免费商品

操作

Webhook

操作

预订

操作

商户

操作

目录

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

操作

通用区域

操作

目录

操作

权利

操作

管理

操作

通用

操作

优惠券

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

操作

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

操作

管理

操作

目录

操作

虚拟支付

操作

管理

操作

管理

操作

客户端

操作

公会客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作

客户端

操作

管理

操作