コンテンツへスキップ

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プロパティに渡します。

操作
操作
操作

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

操作

カート(サーバー側)

操作

決済(クライアント側)

操作

決済(サーバー側)

操作
操作

無料アイテム

操作

ウェブフック

操作
操作

アイテム先行予約制限に数量を追加Server-sideAdmin

リクエスト

アイテムの先行予約数に数量を追加します。

Pre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います:

このエンドポイントの別名:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
ボディapplication/json
quantityinteger必須

追加する数量。

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

レスポンス

制限する数量が正常に追加されました。

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

アイテムの先行予約制限の数量を設定Server-sideAdmin

リクエスト

アイテムの先行予約制限の数量を設定します。

Pre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います:

このエンドポイントの別名:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
ボディapplication/json
quantityinteger必須

設定する数量。

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

レスポンス

制限する数量が正常に設定されました。

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

アイテムの先行予約制限の数量をすべて削除Server-sideAdmin

リクエスト

アイテムの先行予約制限のすべての数量を削除します。

Pre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います:

このエンドポイントの別名:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1/all

レスポンス

制限の削除に成功しました。

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

マーチャント

操作

カタログ

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

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

クーポン

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

操作

プロモーションコード

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

操作

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

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

操作

ディスカウント

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

操作

ボーナス

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

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

クライアント

操作

クランクライアント

操作
操作

クライアント

操作
操作

クライアント

操作
操作

クライアント

操作
操作