コンテンツへスキップ

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記述をダウンロード
index.json
index.yaml
言語
サーバー
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プロパティに渡します。

操作

管理者

操作

カタログ

操作

カート（クライアント側）

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

カタログ

操作

資格

操作

管理者

操作

通常

操作

クーポン

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

操作

プロモーションコード

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

操作

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

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

操作

ディスカウント

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

操作

ボーナス

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

操作

管理者

操作

カタログ

操作

仮想決済

操作

管理

操作

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作

アイテムのインポート状況を取得するServer-sideAdmin

リクエスト

プロジェクトへのアイテムのインポートの進行状況に関する情報を取得します。このAPIコールでは、APIまたはPublisher Account APIを通じて最後に実行されたインポートに関するデータを取得します。

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

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

例: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v1/admin/projects/44056/connectors/import_items/import/status

レスポンス

インポート状況が正常に取得されました。

ボディapplication/json
date_completedstring

GMT+3タイムゾーンでのインポート操作完了のタイムスタンプ。エラーによりインポートが中断され、アイテムがインポートされなかった場合は、空の文字列が返されます。

例: "2024-11-19T15:27:31+03:00"
date_createdstring

GMT+3タイムゾーンでのインポート作成操作のタイムスタンプ。

例: "2024-11-19T14:27:31+03:00"
date_updatedstring

GMT+3タイムゾーンのエラーによりインポートが中断されたときのタイムスタンプ。

例: "2024-11-19T15:27:31+03:00"
errorstring

一般的なインポートエラーの説明。

error_codestring

一般的なインポートエラーのコード。

progressinteger

インポート実行の進捗状況を表するパーセント。

例: 100
resultobject

特定のアイテムSKUのインポート結果とインポートエラーに関するデータを含むオブジェクト。

例: {"errors_by_sku":[{"error_code":4055,"error_message":"[0401-4055]: Item default price not set","sku":"com.xsolla.sword_1","type":"virtual_items"},{"error_code":1817,"error_message":"[0410-1817]: SKU can't be empty","sku":"","type":null}],"errors_count":2,"total_entities_count":10}
statusstring

インポート状況。

列挙型 値説明
done

正常にインポートしました。

error

エラーにより、インポート中にエラーが発生し、一部のデータしか取り込めませんでした。

initialized

インポートが開始されました。

process

インポート中です。

例: "error"
レスポンス
application/json
{
  "date_completed": "2024-11-19T15:27:31+03:00",
  "date_created": "2024-11-19T14:27:31+03:00",
  "date_updated": "2024-11-19T15:27:31+03:00",
  "error": null,
  "error_code": null,
  "progress": 100,
  "result": {
    "errors_by_sku": [ … ],
    "errors_count": 2,
    "total_entities_count": 10
  },
  "status": "error"
}

JSONファイル経由でアイテムをインポートするServer-sideAdmin

リクエスト

指定したURLを介してJSONファイルからストアにアイテムをインポートします。JSONファイルからのインポートの詳細については、ドキュメントを参照してください。

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

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

例: 44056
ボディapplication/json
connector_external_idstring必須

アイテムをインポートするための操作のタイプを指定する固定値。

値"import_items"
file_urlstring必須

JSON形式のデータを含むファイルのURL。ファイルは、一般に公開されているストレージサービスにホストされている必要があります。ファイルテンプレートは、パブリッシャーアカウントでのストア > 仮想アイテム > カタログ管理 > アイテムをインポート（JSON）セクションからダウンロードできます。

例: "https://my-bucket.s3.amazonaws.com/items.json"
modestring

アクションをインポートする：

デフォルト "create_and_update"
列挙型 値説明
create

新しいアイテムを追加する。

create_and_update

新しいアイテムの追加と既存のアイテムの更新。

sync

新しいアイテムの追加、既存のアイテムの更新、および欠落アイテムの無効化。

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v1/projects/44056/import/from_external_file \
  -H 'Content-Type: application/json' \
  -d '{
    "connector_external_id": "import_items",
    "file_url": "https://my-bucket.s3.amazonaws.com/items.json",
    "mode": "create"
  }'

レスポンス

ファイルは正常にインポートされ、現在処理中です。

ボディapplication/json
import_idstring

操作IDをインポートします。JSONファイルのインポートに問題が発生した場合は、このIDをカスタマーサクセスマネージャーに報告するか、csm@xsolla.comまでメールを送信してください。

例: "af9f3638a16e11ef880da2cd677d2d24"
レスポンス
application/json
{
  "import_id": "af9f3638a16e11ef880da2cd677d2d24"
}