コンテンツへスキップ

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

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

操作

カート(サーバー側)

操作

決済(クライアント側)

操作

決済(サーバー側)

操作
操作

無料アイテム

操作
操作
操作

ウェブフック

操作
操作

アイテムの先行予約制限の数量を設定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/catalog/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/catalog/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1/all

レスポンス

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

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

アイテムの先行予約制限をトグルServer-sideAdmin

リクエスト

アイテムの先行予約制限を有効/無効にします。

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

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

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

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
ボディapplication/json
is_pre_order_limit_enabledboolean必須
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1/toggle \
  -H 'Content-Type: application/json' \
  -d '{
    "is_pre_order_limit_enabled": true
  }'

レスポンス

制限が無効/有効になりました。

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

マーチャント

操作

カタログ

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

操作
操作
操作