コンテンツへスキップ

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記述をダウンロード
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/shop-builder/
https://store.xsolla.com/api/
操作

個人用カタログ

ユーザー属性に応じたルールを指定することができるAPIです。 ユーザーが具体的なルールの条件をすべて満たした場合、パーソナライズされたアイテムが表示されます。

パーソナライズされたプロモーションについては、プロモーションセクションを参照してください。

購入前に属性を渡すには、Xsolla Login APIを使うか、Pay Station APIを使ってトークンを生成する際にそれをuser.attributesプロパティに渡します。

操作
操作
操作

カート(クライアント側)

操作

現在のカートからアイテムを削除Client-side

リクエスト

カートからアイテムを削除します。

セキュリティ
AuthForCart
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
item_skustring必須

アイテムSKU。

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

レスポンス

カートのアイテムは正常に削除されました。

レスポンス
コンテンツなし

現在のカートからカートのアイテムを更新Client-side

リクエスト

既存のカートアイテムを更新するか、カート内のアイテムを作成します。

セキュリティ
AuthForCart
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
ボディapplication/json
quantitynumber

アイテム数量。

デフォルト 123
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/cart/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 123
  }'

レスポンス

カートは正常に更新されました。

レスポンス
コンテンツなし

カートIDによりカートを取得Client-side

リクエスト

カートIDによりユーザーのカートを返します。

セキュリティ
AuthForCart
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
cart_idstring必須

カートID。

例: custom_id
クエリ
currencystring

カートに表示される商品価格の通貨。ISO4217 規格詳細については、ドキュメントを参照してください。エクソーラでサポートされている通貨

デフォルト "USD"
localestring

応答言語。ISO 639-1に基づく小文字の2文字言語コード。

デフォルト "en"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/cart/custom_id?currency=USD&locale=en' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

レスポンス

アイテムの入ったカートは正常に返送されました。

ボディ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)

カート全体に適用されたプロモーション。この配列は、次の場合に返されます:

  • プロモーションがカート合計金額に影響する場合。例えば、購入割引設定が適用されたプロモーションコード。

  • プロモーションがボーナスアイテムをカートに追加する場合。

注文レベルに適用されるプロモーションがない場合は、空の配列が返されます。

レスポンス
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {} ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ] }

カート(サーバー側)

操作

決済(クライアント側)

操作

決済(サーバー側)

操作
操作

無料アイテム

操作

ウェブフック

操作
操作

マーチャント

操作

カタログ

このAPIは販売可能なアイテムや特定のアイテムを取得することができます。

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

クーポン

このAPIを使用すると、クーポンを管理できます。

操作

プロモーションコード

このAPI を使用すると、プロモーションコードを管理できます。

操作

ユニークなカタログオファー

このAPIを使用すると、ユニークなカタログオファーを管理することができます。

操作

ディスカウント

このAPIを使用すると、割引キャンペーンを管理することができます。

操作

ボーナス

このAPIを使用すると、ボーナスプロモーションを管理できます。

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

クライアント

操作

クランクライアント

操作
操作

クライアント

操作
操作

クライアント

操作
操作

クライアント

操作
操作