跳转到内容

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

个性化目录

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

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

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

操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作

目录

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

操作
操作
操作
操作
操作
操作

优惠券

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

操作

促销码

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

操作

特别目录优惠

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

操作

折扣

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

操作

奖励

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

操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作

获取项目中追加销售的信息Server-sideAdmin

请求

检索项目中追加销售的信息:是否启用、追加销售的类型以及属于此追加销售的商品SKU列表。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
curl -i -X GET \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

响应

用于项目中追加销售的配置详细信息和商品列表。

正文application/jsonArray [
is_enabledboolean

项目是否启用了追加销售。

示例: true
itemsArray of objects

项目中追加销售包含的商品SKU列表。

示例: [{"item_id":1,"name":{"de":"Name des Artikels","en":"Item's name"},"sku":"com.xsolla.booster_mega_1","type":"virtual_good"}]
typestring

追加销售的类型。

枚举"fixed_list""most_sellable""only_promotions"
示例: "fixed_list"
]
响应
application/json
[ { "is_enabled": true, "items": [], "type": "fixed_list" } ]

创建追加销售Server-sideAdmin

请求

为项目创建追加销售。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
正文application/json
One of:

追加销售类型。

is_enabledboolean(is_enabled)必需
示例: true
itemsArray of strings必需

商品SKU数组。

默认值 null
示例: ["game_sku"]
typestring必需
"fixed_list"
示例: true
curl -i -X POST \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

响应

已为该项目创建了追加销售。

响应
无内容

更新追加销售Server-sideAdmin

请求

更新项目的追加销售。

安全
XsollaLoginUserJWT
路径
project_idinteger必需

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

示例: 44056
正文application/json
One of:

追加销售类型。

is_enabledboolean(is_enabled)必需
示例: true
itemsArray of strings必需

商品SKU数组。

默认值 null
示例: ["game_sku"]
typestring必需
"fixed_list"
示例: true
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/zh/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

响应

该项目的追加销售已更新。

响应
无内容
操作
操作