跳转到内容
/
按购物车ID在购物车里添加商品

Catalog 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

Catalog API提供端点，用于管理您的游戏内商店目录并处理购买。使用这些端点配置虚拟物品、虚拟货币、游戏密钥、捆绑包、购物车和支付流程、物品属性，以及从外部来源导入物品。

下载 OpenAPI 描述
index.json
index.yaml
语言
服务器
Mock server
https://xsolla.redocly.app/_mock/zh/api/catalog/
https://store.xsolla.com/api/

管理

操作

目录

操作

虚拟支付

操作

目录

操作

权利

操作

管理

操作

管理

操作

目录

操作

购物车（客户端侧）

操作

购物车（服务器侧）

操作

在购物车里添加商品Server-side

请求

在当前购物车里添加商品。如果购物车中已有具有相同SKU的商品，则现有商品将被传入的值替换。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
查询
localestring

响应语言。按照ISO 639-1规定使用两个小写字母的语言代码。

默认值 "en"
标头
x-user-forstring

可以使用艾克索拉登录管理器用户JWT或支付中心访问令牌传输用户标识符。

示例: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

使用购物车销售游戏时可以使用您自己的用户ID。

示例: UNIQUE_ID
正文application/json
countrystring= 2 characters

ISO 3166-1 alpha-2标准下的两个大写字母的国家/地区代码。 请查看文档详细了解艾克索拉支持的国家/地区。
示例：country=US

示例: "US"
currencystring= 3 characters

购物车中显示的商品价格货币。每ISO 4217。请查看文档以获取有关Xsolla 支持的货币。

示例: "USD"
itemsArray of objectsnon-empty必需
items[].​quantitynumber>= 1必需

商品的数量。

示例: 2
items[].​skustringnon-empty必需

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

示例: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/catalog/v2/admin/project/44056/cart/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

响应

已成功返回含商品的购物车。

正文application/json
cart_idstring

购物车ID。将其传入购买页面或支付API端点的查询。

示例: "cart_id"
is_freeboolean(value-cart_is_free)

如果为true，则购物车为免费。

默认值 false
示例: false
itemsArray of objects
priceobject or null

购物车价格。

promotionsArray of objects(Catalog_cart_promotions)

应用于整个购物车的促销活动。仅在以下情况下返回该数组：

  • 促销活动影响购物车总金额，例如使用了对购买项提供折扣设置的促销码。

  • 促销活动为购物车添加了赠品。

如果未应用任何订单级促销，则返回空数组。

warningsArray of objects
响应
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … },
    { … },
    { … }
  ],
  "price": {
    "amount": "15.97",
    "amount_without_discount": "22.96",
    "currency": "USD"
  },
  "promotions": [
    { … }
  ],
  "warnings": [
    { … }
  ]
}

按购物车ID在购物车里添加商品Server-side

请求

通过购物车ID在购物车里添加商品。如果购物车中已有具有相同SKU的商品，则现有商品将被传入的值替换。

安全
basicAuth
路径
project_idinteger必需

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

示例: 44056
cart_idstring必需

购物车ID。

示例: custom_id
查询
localestring

响应语言。按照ISO 639-1规定使用两个小写字母的语言代码。

默认值 "en"
标头
x-user-forstring

可以使用艾克索拉登录管理器用户JWT或支付中心访问令牌传输用户标识符。

示例: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

使用购物车销售游戏时可以使用您自己的用户ID。

示例: UNIQUE_ID
正文application/json
countrystring= 2 characters

ISO 3166-1 alpha-2标准下的两个大写字母的国家/地区代码。 请查看文档详细了解艾克索拉支持的国家/地区。
示例：country=US

示例: "US"
currencystring= 3 characters

购物车中显示的商品价格货币。每ISO 4217。请查看文档以获取有关Xsolla 支持的货币。

示例: "USD"
itemsArray of objectsnon-empty必需
items[].​quantitynumber>= 1必需

商品的数量。

示例: 2
items[].​skustringnon-empty必需

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

示例: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/zh/api/catalog/v2/admin/project/44056/cart/custom_id/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

响应

已成功返回含商品的购物车。

正文application/json
cart_idstring

购物车ID。将其传入购买页面或支付API端点的查询。

示例: "cart_id"
is_freeboolean(value-cart_is_free)

如果为true，则购物车为免费。

默认值 false
示例: false
itemsArray of objects
priceobject or null

购物车价格。

promotionsArray of objects(Catalog_cart_promotions)

应用于整个购物车的促销活动。仅在以下情况下返回该数组：

  • 促销活动影响购物车总金额，例如使用了对购买项提供折扣设置的促销码。

  • 促销活动为购物车添加了赠品。

如果未应用任何订单级促销，则返回空数组。

warningsArray of objects
响应
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … },
    { … },
    { … }
  ],
  "price": {
    "amount": "15.97",
    "amount_without_discount": "22.96",
    "currency": "USD"
  },
  "promotions": [
    { … }
  ],
  "warnings": [
    { … }
  ]
}

支付（客户端）

操作

支付（服务器端）

操作

订单

操作

免费商品

操作

管理

操作

管理

操作

Webhook

操作

预订

操作

商户

操作

目录

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

操作

通用区域

操作

管理

操作