コンテンツへスキップ
/
指定されたユーザーが利用できるアイテムの数を設定す...

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

管理者

操作

カタログ

操作

仮想決済

操作

カタログ

操作

資格

操作

管理者

操作

管理者

操作

カタログ

操作

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

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

管理

操作

指定したユーザーが使用できるアイテムの数を増やすServer-sideAdmin

リクエスト

適用される制限内で、指定されたユーザーが使用できるアイテムの残りの数を増やします。

User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します：

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

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
ボディapplication/json
availableinteger(User-limit_available)>= 1必須

適用された制限内でユーザーが利用できる残りのアイテム数またはプロモーション利用回数。

userobject(User-limit_user)必須
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$必須

ユーザーexternal ID。

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

レスポンス

ユーザーの購入制限が正常に受信されました。

ボディapplication/json
per_userobject
レスポンス
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

指定されたユーザーが利用できるアイテムの数を設定するServer-sideAdmin

リクエスト

指定されたユーザーが、増減後に適用された制限の範囲内で購入できる数量を設定します。

User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテムタイプモジュールの 管理セクションに移動します：

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

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
ボディapplication/json
availableinteger(User-limit_available_flexible)>= 0必須

適用された制限内でユーザーが利用できる残りのアイテム数またはプロモーション利用回数。

userobject(User-limit_user)必須
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$必須

ユーザーexternal ID。

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 0,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

レスポンス

ユーザーの購入制限が正常に受信されました。

ボディapplication/json
per_userobject
レスポンス
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

購入制限を更新するServer-sideAdmin

リクエスト

ユーザーが再び購入できるように、アイテムの購入制限を更新します。userパラメータがnullである場合、このコールはすべてのユーザーに対してこの制限を更新します。

User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します：

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

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

例: 44056
item_skustring必須

アイテムSKU。

例: booster_mega_1
ボディapplication/json
userobject or null(User-limit_user_flexible)必須
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$

ユーザーexternal ID。

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

レスポンス

制限は正常に更新されました。

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

管理者

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

管理者

操作