跳转到内容

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

按购物车ID删除所有购物车商品Client-side

请求

删除所有购物车商品。

安全
AuthForCart
路径
project_idinteger必需

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

示例: 44056
cart_idstring必需

购物车ID。

示例: custom_id
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/cart/custom_id/clear \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

响应

购物车已成功清空。

在指定购物车里添加商品Client-side

请求

在指定购物车里添加商品。如果购物车中已有具有相同SKU的商品,则现有商品位置将被传入的值替换。

安全
AuthForCart
路径
project_idinteger必需

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

示例: 44056
cart_idstring必需

购物车ID。

示例: custom_id
正文application/json
itemsArray of objects必需

商品清单。

示例: [{"quantity":123,"sku":"com.xsolla.booster_mega_1"}]
items[].​quantitynumber必需
默认值 123
items[].​skustring必需
默认值 "booster_mega_1"
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/cart/custom_id/fill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "quantity": 123,
        "sku": "com.xsolla.booster_mega_1"
      }
    ]
  }'

响应

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

正文application/json
cart_idstring

购物车ID。

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

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

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

购物车价格。

示例: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
promotionsArray of objects(Catalog_cart_promotions)

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

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

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

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

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

按购物车ID删除购物车商品Client-side

请求

从购物车中删除一个商品。

安全
AuthForCart
路径
project_idinteger必需

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

示例: 44056
cart_idstring必需

购物车ID。

示例: custom_id
item_skustring必需

商品SKU。

示例: booster_mega_1
curl -i -X DELETE \
  https://xsolla.redocly.app/_mock/zh/api/catalog/v2/project/44056/cart/custom_id/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

响应

购物车中的商品已成功删除。

响应
无内容
操作
操作
操作
操作
操作
操作
操作
操作
操作
操作

目录

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

操作
操作
操作