コンテンツへスキップ
/
バンドルを削除

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/

管理者

操作

カタログ

操作

仮想決済

操作

カタログ

操作

資格

操作

管理者

操作

管理者

操作

指定されたグループIDのバンドルリストを取得するServer-sideAdmin

リクエスト

管理用のグループ内のバンドルリストを取得します。

注

このエンドポイントは、ストアカタログの構築に使用しないでください。
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
group_idinteger必須

グループID。

例: 10
クエリ
limitinteger>= 1

ページでの要素数の制限。

例: limit=50
offsetinteger>= 0

リストが生成される要素番号（カウントは0から始まります）。

例: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/bundle/group/id/10?limit=50&offset=0'

レスポンス

バンドルのリストは正常に受信されました。

ボディapplication/json
itemsArray of objects(Bundles_admin_bundle_response)
レスポンス
application/json
{
  "items": [
    { … },
    { … }
  ]
}

バンドルを削除Server-sideAdmin

リクエスト

バンドルを削除します。

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

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

例: 44056
skustring必須

バンドルSKU。

例: kg_1
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/bundle/sku/kg_1

レスポンス

バンドルは正常に削除されました。

ボディ
レスポンス
コンテンツなし

バンドルを取得Server-sideAdmin

リクエスト

管理用プロジェクト内のバンドルを取得します。

注

このエンドポイントは、ストアカタログの構築に使用しないでください。
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
skustring必須

バンドルSKU。

例: kg_1
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/catalog/v2/project/44056/admin/items/bundle/sku/kg_1

レスポンス

指定されたバンドルは正常に受信されました。

ボディapplication/json
attributesArray of objects(Bundles_admin-attributes)

属性リスト。

例: [{"external_id":"attribute_external_id","name":{"de":"Attributname","en":"Attribute name"},"values":[{"external_id":"value_1","name":{"de":"wert 1","en":"value 1"}},{"external_id":"value_2","name":{"de":"wert 2","en":"value 2"}}]}]
bundle_typestring(bundle_type)

バンドルタイプ。アイテムタイプがバンドルの場合に返されます。

列挙型"standard""virtual_currency_package""partner_side_content"
contentArray of objects(Bundles_admin_content_response)
custom_attributesobject(json)(item-custom-attributes-response)

アイテムの属性と値を含むJSONオブジェクト。

description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

One of:

アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

groupsArray of objects(Bundles_groups_response)

アイテムが所属するグループ。

デフォルト []
例: [{"external_id":"horror","name":{"en":"Horror"}}]
image_urlstring or null(Bundles_image_url)

画像URL。

例: "https://image.example.com"
is_enabledboolean(Bundles_is_enabled)

無効の場合、アイテムを検索して購入することはできません。

デフォルト true
例: true
is_freeboolean(value-is_free)

trueの場合で、アイテムは無料です。

デフォルト false
例: false
is_show_in_storeboolean(Bundles_is_show_in_store)

アイテムは購入可能です。

デフォルト false
例: true
item_idinteger(Bundles_item_id)[ 1 .. 255 ] characters

内部の一意のアイテムID。

例: 1
limitsobject or null(admin-item-limit-response)

アイテム制限。

long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)

アイテムの長文説明のローカライズを含むオブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のバリアント（例：enとen-US）が提供された場合、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

Any of:

アイテムの長文説明のローカライズを含むオブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のバリアント（例：enとen-US）が提供された場合、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

media_listArray of objects or null

バンドルの追加アセット。

例: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)

アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字の言語コード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

One of:

アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字の言語コード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。

orderinteger(Bundles_order)

リスト内のバンドル順の優先順位。

デフォルト 1
例: 1
periodsArray of objects(item-periods-response)

アイテム販売期間。

pricesArray of objects(Bundles_prices)

実際通貨建ての価格。

regionsArray of objects(Bundles_admin-regions)
skustring(Bundles_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。

例: "bundle_1"
total_content_priceobject or null(Bundles_total_content_price)

バンドルコンテンツ価格の合計。

typestring(Bundles_type)

アイテムタイプ。

例: "bundle"
virtual_pricesArray of objects(Bundles_admin-response-virtual_price)
レスポンス
application/json
{
  "attributes": [],
  "bundle_type": "standard",
  "content": [
    { … },
    { … },
    { … }
  ],
  "custom_attributes": {
    "purchased": 0,
    "type": "lootbox"
  },
  "description": {
    "en": "Empire bundle with items"
  },
  "groups": [
    { … }
  ],
  "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
  "is_enabled": true,
  "is_free": false,
  "is_show_in_store": true,
  "item_id": 610316,
  "limits": {
    "per_item": null,
    "per_user": { … },
    "recurrent_schedule": null
  },
  "long_description": {
    "en": "Empire bundle with some goods"
  },
  "media_list": [],
  "name": {
    "en": "Empire bundle"
  },
  "order": 1,
  "periods": [
    { … }
  ],
  "prices": [],
  "regions": [],
  "sku": "com.xsolla.EmpireBundle_1",
  "type": "bundle",
  "virtual_prices": [
    { … }
  ]
}

カタログ

操作

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

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

管理

操作

管理者

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

管理者

操作