# Catalog API # Overview - **Version:** 2.0.0 - **Servers:** `https://store.xsolla.com/api` - [Contact Us by Email](mailto:integration@xsolla.com) - **Contact URL:** https://xsolla.com/ - **Required TLS version:** 1.2 The Catalog API allows you to configure a catalog of in-game items on the Xsolla side and display the catalog to users in your store. The API allows you to manage the following catalog entities: * **Virtual items** — in-game items such as weapons, skins, boosters. * **Virtual currency** — virtual money used to purchase virtual goods. * **Virtual currency packages** — predefined bundles of virtual currency. * **Bundles** — combined packages of virtual items, currency, or game keys sold as a single SKU. * **Game keys** — keys for games and DLCs distributed via platforms like Steam or other DRM providers. * **Groups** — logical groupings for organizing and sorting items within the catalog. ## API calls The API is divided into the following groups: * **Admin** — calls for creating, updating, deleting, and configuring catalog items and groups. Authenticated via [basic access authentication](https://developers.xsolla.com/ja/payment-ui-and-flow/payment-ui/how-to-get-payment-token/#payments_solution_get_user_auth_token_basic_auth) with your merchant or project credentials. Not intended for storefront use. * **Catalog** — calls for retrieving items and building custom storefronts for end users. Designed to handle high-load scenarios. Support optional user JWT authorization to return personalized data such as user-specific limits and active promotions. # Authentication API calls require authentication either on behalf of a user or on behalf of a project. The authentication scheme used is specified in the **Security** section in the description of each call. ## Authentication using user's JWT User's JWT authentication is used when a request is sent from a browser, mobile application, or game. By default, the `XsollaLoginUserJWT` scheme is applied. For details on how to create a token, see the [Xsolla Login API documentation](/ja/api/login/authentication-schemes#getting-user-token). The token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token: ``` eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI ``` Alternatively, you can use a [token for opening the payment UI](/ja/api/pay-station/token/create-token). ## Basic HTTP authentication Basic HTTP authentication is used for server-to-server interactions, when an API call is sent directly from your server rather than from a user's browser or mobile application. HTTP Basic authentication with an [API key](/ja/api/getting-started/#api_keys_overview) is typically used.
Note

The API key is confidential and must not be stored or used in client applications.
With basic server-side authentication, all API requests must include the following header: - for `basicAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `project_id:api_key` pair encoded in Base64 - for `basicMerchantAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `merchant_id:api_key` pair encoded in Base64 You can find the parameter values in [Publisher Account](https://publisher.xsolla.com/): - `merchant_id` is displayed: - In **Company settings > Company**. - In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`. - `project_id` is displayed: - Next to the project name in Publisher Account. - In the URL in the browser address bar when working on a project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com//projects/`. - `api_key` is shown in Publisher Account only at the time of creation and must be stored securely on your side. You can create an API key in the following sections: - [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key) - [Project settings > API key](https://publisher.xsolla.com/0/projects/0/edit/api_key)
Notice

If a required API call doesn't include the project_id path parameter, use an API key that is valid across all company projects for authorization.
For more information about working with API keys, see the [API references](/ja/api/getting-started/#api_keys_overview). ## Authentication with guest access support The `AuthForCart` authentication scheme is used for cart purchases and supports two modes: 1. **Authentication with a user's JWT.** The token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token: ``` eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI ``` Alternatively, you can use a [token for opening the payment UI](/ja/api/pay-station/token/create-token). 2. **Simplified mode without Authorization header.** This mode is used only for unauthorized users and can be applied only for [game key sales](/ja/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers: - `x-unauthorized-id` with a request ID - `x-user` with the user's email address encoded in Base64 ## Useful links - [API calls by interaction model](https://developers.xsolla.com/ja/api/catalog/) - [Endpoint types](https://developers.xsolla.com/ja/api/catalog/) - [Errors handling](https://developers.xsolla.com/ja/api/catalog/) - [API keys](https://developers.xsolla.com/ja/api/catalog/) # Core entity structure Items of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.
Note

Some calls may include additional fields but they don't change the basic structure.
**Identification** - `merchant_id` — company ID in [Publisher Account](https://publisher.xsolla.com/) - `project_id` — project ID in Publisher Account - `sku` — item SKU, unique within the project **Store display** - `name` — item name - `description` — item description - `image_url` — image URL - `is_enabled` — item availability - `is_show_in_store` — whether the item is displayed in the catalog For more information about managing item availability in the catalog, see the [documentation](/ja/items-catalog/catalog-features/items-availability/). **Organization** - `type` — item type, for example, a virtual item (`virtual_item`) or bundle (`bundle`) - `groups` — groups the item belongs to - `order` — display order in the catalog **Sale conditions** - `prices` — prices in real or virtual currency - `limits` — purchase limits - `periods` — availability periods - `regions` — regional restrictions **Example of core entity structure:** ```json { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://.../image.png", "name": { "en": "Crystals", "de": "Kristalle" }, "quantity": 500, "sku": "com.xsolla.crystal_2", "type": "virtual_currency" } ], "description": { "en": "Crystals x500" }, "groups": [], "image_url": "https://.../image.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Medium crystal pack" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 20, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_2", "type": "bundle", "vc_prices": [] } ``` # Basic purchase flow The Xsolla API allows you to implement in-game store logic, including retrieving the item catalog, managing the cart, creating orders, and tracking their status. Depending on the integration scenario, API calls are divided into **Admin** and **Catalog** subsections, which use different [authentication schemes](/ja/api/catalog/section/authentication). The following example shows a basic flow for setting up and operating a store, from item creation to purchase. ## Create items and groups (Admin) Create an item catalog for your store, such as virtual items, bundles, or virtual currency. Example API calls: - [Create virtual item](/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-item) - [Create bundle](/ja/api/catalog/bundles-admin/admin-create-bundle) - [Create virtual currency](/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency) ## Set up promotions, chains, and limits (Admin) Configure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains. Example API calls: - [Create bonus promotion](/ja/api/liveops/promotions-bonuses/create-bonus-promotion) - [Create daily reward](/ja/api/liveops/daily-chain-admin/admin-create-daily-chain) - [Create unique catalog offer promotion](/ja/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer) ## Get item information (Client) Configure item display in your application.
Notice

Do not use API calls from the Admin subsection to build a user catalog. These API calls have rate limits and aren't intended for user traffic.

Example API calls: - [Get virtual items list](/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items) - [Get item group list](/ja/api/catalog/virtual-items-currency-catalog/get-item-groups) - [Get list of bundles](/ja/api/catalog/bundles-catalog/get-bundle-list) - [Get sellable items list](/ja/api/catalog/common-catalog/get-sellable-items)
Note

By default, catalog API calls return items that are currently available in the store at the time of the request. To retrieve items that are not yet available or are no longer available, include the parameter "show_inactive_time_limited_items": 1 in the catalog request.
## Sell items You can sell items using the following methods: - Fast purchase — sell one SKU multiple times. - Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order. If an item is purchased using virtual currency instead of real money, use the [Create order with specified item purchased by virtual currency](/ja/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API call. The payment UI is not required, as the charge is processed when the API call is executed. For free item purchase, use the [Create order with specified free item](/ja/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/ja/api/catalog/free-item/create-free-order) API call. The payment UI is not required — the order is immediately set to the done status. ### Fast purchase Use the client-side API call to [create an order with a specified item](/ja/api/catalog/payment-client-side/create-order-with-item). The call returns a token used to open the payment UI.
Note

Discount information is available to the user only in the payment UI. Promo codes are not supported.
### Cart purchase Cart setup and purchase can be performed on the client or on the server side. **Set up and purchase a cart on the client** Implement the logic of adding and removing items by yourself. Before calling the API for setting up a cart, you will not have information about which promotions will be applied to the purchase. This means that the total cost and details of the added bonus items will not be known. Implement the following cart logic: 1. After the player has filled a cart, use the [Fill cart with items](/ja/api/shop-builder/operation/cart-fill/) API call. The call returns the current information about the selected items (prices before and after discounts, bonus items). 2. Update the cart contents based on user actions: - To add an item or change item quantity, use the [Update cart item by cart ID](/ja/api/shop-builder/operation/put-item-by-cart-id/) API call. - To remove an item, use the [Delete cart item by cart ID](/ja/api/shop-builder/operation/delete-item-by-cart-id/) API call.
Note

To get the current status of the cart, use the Get current user's cart API call.
3. Use the [Create order with all items from current cart](/ja/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default. **Set up and purchase a cart on the server** This setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls. Implement the following cart logic: 1. After the player has filled a cart, use the [Fill cart with items](/ja/api/catalog/cart-server-side) API call. The call returns current information about the selected items (prices before and after discounts, bonus items). 2. Use the [Create order with all items from current cart](/ja/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default. ## Open payment UI Use the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the [documentation](/ja/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui). | Action | Endpoint | |:--------------------------------|:--------------------------------------------------------------------------| | Open in production environment. | https://secure.xsolla.com/paystation4/?token={token} | | Open in sandbox mode. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |
Note

Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use test bank cards. After the first real payment is made, a strict sandbox payment policy takes effect. A payment in sandbox mode is available only to users specified in [Publisher Account > Company settings > Users](https://publisher.xsolla.com/0/settings/users). Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in [Publisher Account](https://publisher.xsolla.com/), go to **Agreements & Taxes > Agreements**, complete the agreement form, and wait for confirmation. It may take up to 3 business days to review the agreement.
To enable or disable sandbox mode, change the value of the `sandbox` parameter in the request for fast purchase and cart purchase. Sandbox mode is off by default. Possible order statuses: - `new` — order created - `paid` — payment received - `done` — item delivered - `canceled` — order canceled - `expired` — payment expired Track order status using one of the following methods: - [webhooks configured on your server](/ja/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking) - [short-polling](/ja/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_short_polling) - [WebSocket API](/ja/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_websocket_api) ## Useful links - Authentication - [API calls by interaction model](/ja/api/catalog/section/authentication) - [Payment testing](/ja/dev-resources/testing/general-info/#general_overview) - [Set up order status tracking](/ja/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?link=200-api#payments_integration_order_tracking) - [Webhooks](/ja/webhooks/overview) - [Rate limits](/ja/api/login/rate-limits) - [Errors handling](/ja/api/getting-started/#api_errors_handling) - [API keys](/ja/api/getting-started/#api_keys_overview) # Pagination API calls that return large sets of records (for example, when building a catalog) return data in pages. Pagination is a mechanism that limits the number of items returned in a single API response and allows you to retrieve subsequent pages sequentially. Use the following parameters to control the number of returned items: - `limit` — number of items per page - `offset` — index of the first item on the page (numbering starts from 0) - `has_more` — indicates whether another page is available - `total_items_count` — total number of items Example request: ``` GET /items?limit=20&offset=40 ``` Response example: ```json { "items": [...], "has_more": true, "total_items_count": 135 } ``` It is recommended to send subsequent requests until the response returns `has_more = false`. # Date and time format Dates and time values are passed in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The following are supported: - UTC offset - `null` value when there is no time restriction for displaying an item - [Unix timestamp](https://www.unixtimestamp.com/) (in seconds) used in some fields Format: `YYYY-MM-DDTHH:MM:SS±HH:MM` Example: `2026-03-16T10:00:00+03:00` # Localization Xsolla supports localization of user-facing fields such as item name and description. Localized values are passed as an object where the language code is used as the key. The full list of supported languages is available in the [documentation](/ja/doc/shop-builder/references/supported-languages/). **Supported fields** Localization can be specified for the following parameters: - `name` - `description` - `long_description` **Locale format** The locale key can be specified in one of the following formats: - Two-letter language code: `en`, `ru` - Five-letter language code: `en-US`, `ru-RU`, `de-DE` **Examples** Example with a two-letter language code: ```json { "name": { "en": "Starter Pack", "ru": "Стартовый набор" } } ``` Example with a five-letter language code: ```json { "description": { "en-US": "Premium bundle", "de-DE": "Premium-Paket" } } ``` # Error response format If an error occurs, the API returns an HTTP status and a JSON response body. The full list of store-related errors is available in the [documentation](/ja/dev-resources/references/errors/store-errors/). **Response example:** ```json { "errorCode": 1102, "errorMessage": "Validation error", "statusCode": 422, "transactionId": "c9e1a..." } ``` - `errorCode` — error code. - `errorMessage` — short error description. - `statusCode` — HTTP response status. - `transactionId` — request ID. Returned only in some cases. - `errorMessageExtended` — additional error details, such as request parameters. Returned only in some cases. **Extended response example:** ```json { "errorCode": 7001, "errorMessage": "Chain not found", "errorMessageExtended": { "chain_id": "test_chain_id", "project_id": "test_project_id", "step_number": 2 }, "statusCode": 404 } ``` **Common HTTP status codes** - `400` — invalid request - `401` — authentication error - `403` — insufficient permissions - `404` — resource not found - `422` — validation error - `429` — rate limit exceeded **Recommendations** - Handle the HTTP status and the response body together. - Use `errorCode` to process errors related to application logic. - Use `transactionId` to identify requests more quickly when analyzing errors. Version: 2.0.0 ## Servers ``` https://store.xsolla.com/api ``` ## Security ### AuthForCart `AuthForCart`認証スキームはカートでの購入用であり、以下の2つのモードに対応しています： ユーザーのJWTによる認証。トークンは、以下の形式で認証ヘッダーに渡されます：`Authorization: Bearer `。「」はユーザー用トークンです。このトークンによってユーザーが識別され、パーソナライズされたデータへのアクセスが可能になります。以下のテスト用トークンを使用して、このAPIコールを試すことができます：`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`。 別の方法として、[決済UIを開くためのトークン](/ja/api/pay-station/token/create-token)を使用できます。 `Authorization`ヘッダーなしの簡易モード。これは未認証ユーザー専用のモードであり、[ゲームキー販売(/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users)のケースにのみ利用できます。トークンの代わりに、リクエストには以下のヘッダーを含める必要があります： * リクエストIDを指定した`x-unauthorized-id` * Base64でエンコードされたユーザーのメールアドレスを指定した`x-user` Type: http Scheme: bearer ### XsollaLoginUserJWT クライアント側からのAPIコールには、`XsollaLoginUserJWT`認証スキームを使用します。リクエストの`Authorization`ヘッダーには、「Bearer ``」という形式でユーザーのJWTを含める必要があります。このトークンによってユーザーが識別され、パーソナライズされたデータへのアクセスが可能になります。トークンの作成方法の詳細については、[エクソーラログインAPI](/ja/api/login/authentication-schemes#getting-user-token)に関するドキュメントをご参照ください。 以下のテスト用トークンを使用して、このAPIコールを試すことができます：`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`。 別の方法として、[決済UIを開くためのトークン](/ja/api/pay-station/token/create-token)を使用することも可能です。 Type: http Scheme: bearer Bearer Format: JWT ### basicAuth サーバー側からのAPIコールには、`basicAuth`認証スキームを使用します。すべてのAPIリクエストには `Authorization: Basic ` ヘッダーを含める必要があります。ここで、`your_authorization_basic_key`は`project_id:api_key` のペアをBase64標準に従ってエンコードしたものです。 必要に応じて、`project_id`の代わりに`merchant_id`を使用することができます。機能には影響しません。 [パブリッシャーアカウント](https://publisher.xsolla.com/)に移動して、パラメータの値を確認します： * `merchant_id`が表示されます： * **会社設定 > 会社**セクションで * 任意のパブリッシャーアカウントページのブラウザアドレスバーにあるURL。URLは以下の形式です：`https://publisher.xsolla.com/`。 * `api_key`は、作成時に一度だけパブリッシャーアカウントに表示され、お客様側で保存する必要があります。新しいキーは、次のセクションで作成することができます： * [会社設定 > APIキー](https://publisher.xsolla.com/0/settings/api_key) * [プロジェクト設定 > APIキー](https://publisher.xsolla.com/0/projects/0/edit/api_key) {% html name="div" attrs={"class": "notice"} %} **注意** 必須のAPIコールに`project_id`パスパラメータが含まれていない場合は、会社全般のプロジェクトで有効なAPIキーを認証に使用してください。 {% /html %} * `project_id`が以下の場所で表示されます： * パブリッシャーアカウント内のプロジェクト名の横。 * パブリッシャーアカウントでプロジェクトを操作している際、ブラウザのアドレスバーに表示されるURLの中。URLの形式は以下の通りです：`https://publisher.xsolla.com//projects/`。 APIキーの操作に関する詳細は、[APIリファレンス](https://developers.xsolla.com/ja/api/getting-started/#api_keys_overview)を参照してください。 Type: http Scheme: basic ### basicMerchantAuth サーバー側からのAPIコールには、`basicMerchantAuth`認証スキームを使用します。APIへのすべてのリクエストは `Authorization: Basic ` ヘッダーを含む必要があり、`your_authorization_basic_key` はBase64標準に従ってエンコードされた`merchant_id:api_key`ペアです。 [パブリッシャーアカウント](https://publisher.xsolla.com/)に移動して、パラメータの値を確認します： * `merchant_id`が表示されます： * **会社設定 > 会社**セクションで * 任意のパブリッシャーアカウントページのブラウザアドレスバーにあるURL。URLは以下の形式です：`https://publisher.xsolla.com/` * `api_key`は、作成時に一度だけパブリッシャーアカウントに表示され、お客様側で保存する必要があります。[会社設定 > APIキー](https://publisher.xsolla.com/0/settings/api_key)セクションで、新しいキーを作成できます。 APIキーの操作に関する詳細は、[APIリファレンス](https://developers.xsolla.com/ja/api/getting-started/#api_keys_overview)を参照してください。 Type: http Scheme: basic ## Download OpenAPI description [Catalog API](https://developers.xsolla.com/_bundle/@l10n/ja/api/catalog/index.yaml) ## 管理者 ### 仮想通貨のリストを取得する - [GET /v2/project/{project_id}/admin/items/virtual_currency](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-currencies-list.md): 管理用のプロジェクト内の仮想通貨リストを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### 仮想通貨を作成 - [POST /v2/project/{project_id}/admin/items/virtual_currency](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency.md): 仮想通貨を作成します。 ### 仮想通貨パッケージリストを取得する（管理者） - [GET /v2/project/{project_id}/admin/items/virtual_currency/package](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-packages-list.md): 管理用のプロジェクト内の仮想通貨パッケージリストを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### 仮想通貨パッケージを作成 - [POST /v2/project/{project_id}/admin/items/virtual_currency/package](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency-package.md): 仮想通貨パッケージを作成します。 ### 仮想通貨パッケージを削除 - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency-package.md): 仮想通貨パッケージを削除します。 ### 仮想通貨パッケージを取得 - [GET /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-package.md): 管理用のプロジェクト内の仮想通貨パッケージを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### 仮想通貨パッケージを更新 - [PUT /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency-package.md): 仮想通貨パッケージを更新します。 ### 仮想通貨を削除する - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency.md): 仮想通貨を削除します。 ### 仮想通貨を取得する - [GET /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency.md): 管理用のプロジェクト内の仮想通貨を取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### 仮想通貨を更新する - [PUT /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency.md): 仮想通貨を更新します。 ### 仮想アイテムのリストを取得する - [GET /v2/project/{project_id}/admin/items/virtual_items](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list.md): 管理用のプロジェクト内の仮想アイテムリストを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### 仮想アイテムを作成 - [POST /v2/project/{project_id}/admin/items/virtual_items](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-item.md): 仮想アイテムを作成します。 ### 指定されたグループ外部IDによる仮想アイテムのリストを取得します。 - [GET /v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-external-id.md): 管理用のグループ内の仮想アイテムリストを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### 指定されたグループIDによる仮想アイテムのリストを取得します。 - [GET /v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-id.md): 管理用のグループ内の仮想アイテムリストを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### 仮想アイテムを削除 - [DELETE /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-delete-virtual-item.md): 仮想アイテムを削除します。 ### 仮想アイテムを取得 - [GET /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-item.md): 管理用のプロジェクト内の仮想アイテムを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### 仮想アイテムを更新 - [PUT /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-update-virtual-item.md): 仮想アイテムを更新します。 ## カタログ ### 仮想通貨リストを取得する - [GET /v2/project/{project_id}/items/virtual_currency](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-catalog/get-virtual-currency.md): Gets a virtual currency list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 仮想通貨パッケージリストを取得 - [GET /v2/project/{project_id}/items/virtual_currency/package](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package.md): Gets a virtual currency packages list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### SKUによる販売可能なアイテムを取得する - [GET /v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-sku.md): Gets a virtual currency packages by SKU for building a catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### SKUによる仮想通貨を取得する - [GET /v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-catalog/get-virtual-currency-sku.md): Gets a virtual currency by SKU for building a catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 仮想アイテムリストを取得 - [GET /v2/project/{project_id}/items/virtual_items](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items.md): Gets a virtual items list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### すべての仮想アイテムリストを取得する - [GET /v2/project/{project_id}/items/virtual_items/all](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-catalog/get-all-virtual-items.md): Gets a list of all virtual items for searching on client-side. Notice Returns only item SKU, name, groups and description. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 指定されたグループによるアイテムリストを取得する - [GET /v2/project/{project_id}/items/virtual_items/group/{external_id}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items-group.md): Gets an items list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### SKUによる仮想アイテムを取得する - [GET /v2/project/{project_id}/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items-sku.md): Gets a virtual item by SKU for building a catalog. Notice This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 仮想決済 ### 仮想通貨で購入した指定商品で注文を作成する - [POST /v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}](https://developers.xsolla.com/ja/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency.md): Creates item purchase using virtual currency. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## カタログ ### ゲームリストを取得 - [GET /v2/project/{project_id}/items/game](https://developers.xsolla.com/ja/api/catalog/game-keys-catalog/get-games-list.md): Gets a games list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### DRMリストを取得 - [GET /v2/project/{project_id}/items/game/drm](https://developers.xsolla.com/ja/api/catalog/game-keys-catalog/get-drm-list.md): 利用可能なDRMのリストを取得します。 ### 指定されたグループによるゲームリストを取得 - [GET /v2/project/{project_id}/items/game/group/{external_id}](https://developers.xsolla.com/ja/api/catalog/game-keys-catalog/get-games-group.md): Gets a games list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 指定されたグループのゲームキーリストを取得 - [GET /v2/project/{project_id}/items/game/key/group/{external_id}](https://developers.xsolla.com/ja/api/catalog/game-keys-catalog/get-game-keys-group.md): Gets a game key list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### カタログ用のゲームキーを取得する - [GET /v2/project/{project_id}/items/game/key/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/game-keys-catalog/get-game-key-by-sku.md): Gets a game key for the catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### カタログ用ゲームを取得する - [GET /v2/project/{project_id}/items/game/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/game-keys-catalog/get-game-by-sku.md): Gets a game for the catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 資格 ### 資格付与（管理者） - [POST /v2/project/{project_id}/admin/entitlement/grant](https://developers.xsolla.com/ja/api/catalog/game-keys-entitlement/grant-entitlement-admin.md): ユーザーに権利を付与します。 注意 ゲームコードやDRM-freeプラットフォームのゲームのみ付与可能です。 ### 資格の取り消し（管理者） - [POST /v2/project/{project_id}/admin/entitlement/revoke](https://developers.xsolla.com/ja/api/catalog/game-keys-entitlement/revoke-entitlement-admin.md): ユーザーの権利を取り消します。 注意ゲームコードやDRMフリープラットフォームのゲームのみ取り消すことができます。 ### ユーザーが所有しているゲームソフトのリストを取得 - [GET /v2/project/{project_id}/entitlement](https://developers.xsolla.com/ja/api/catalog/game-keys-entitlement/get-user-games.md): Get the list of games owned by the user. The response will contain an array of games owned by a particular user. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### クライアントによるゲームコードを引き換える - [POST /v2/project/{project_id}/entitlement/redeem](https://developers.xsolla.com/ja/api/catalog/game-keys-entitlement/redeem-game-pin-code.md): Grants entitlement by a provided game code. Notice You can redeem codes only for the DRM-free platform. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 管理者 ### ゲームリストを取得する（管理者） - [GET /v2/project/{project_id}/admin/items/game](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-get-game-list.md): 管理用プロジェクト内のゲームのリストを取得します。 ゲームは、ユーザーが購入可能なゲームキーで構成されています。 注意このエンドポイントは、ストアカタログの構築に使用しないでください。 ### ゲームを作成 - [POST /v2/project/{project_id}/admin/items/game](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-create-game.md): プロジェクト内のゲームを作成します。 ### IDによるゲームを削除 - [DELETE /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-delete-game-by-id.md): IDによるプロジェクト内のゲームを削除します。 ### IDでゲームを取得する（管理者） - [GET /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-get-game-by-id.md): 管理用ゲームを取得します。 ゲームは、ユーザーが購入可能なゲームキーで構成されています。 注意このエンドポイントは、ストアカタログの構築に使用しないでください。 ### IDによるゲームを更新 - [PUT /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-update-game-by-id.md): IDによるプロジェクト内のゲームを更新します。 ### IDによるコードを削除 - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-delete-codes-by-id.md): ゲームキーIDによりすべてのコードを削除します。 ### コードを削除 - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-delete-codes-by-sku.md): ゲームキーSKUによる全コードを削除します。 ### IDによるコードを取得 - [GET /v2/project/{project_id}/admin/items/game/key/request/id/{item_id}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-get-codes-by-id.md): ゲームキーIDによる一定数のコードを取得します。 ### コードを取得 - [GET /v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-get-codes-by-sku.md): ゲームキーSKUによる一定数のコードを取得します。 ### IDによるコードをアップロード - [POST /v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-upload-codes-by-id.md): ゲームキーIDによるコードをアップロードします。 ### コード読み込みセッションに関する情報を取得 - [GET /v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-get-codes-session.md): コード読み込みセッションに関する情報を取得します。 ### コードをアップロード - [POST /v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-upload-codes-by-sku.md): ゲームキーSKUによるコードをアップロードします。 ### ゲームをSKUで削除 - [DELETE /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-delete-game-by-sku.md): SKUによるプロジェクト内のゲームを削除します。 ### ゲームを取得する（管理者） - [GET /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-get-game-by-sku.md): 管理用ゲームを取得します。 ゲームは、ユーザーが購入可能なゲームキーで構成されています。 注意このエンドポイントは、ストアカタログの構築に使用しないでください。 ### SKUによるゲームを更新 - [PUT /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/game-keys-admin/admin-update-game-by-sku.md): SKUによるプロジェクト内のゲームを更新します。 ## 管理者 ### バンドルのリストを取得 - [GET /v2/project/{project_id}/admin/items/bundle](https://developers.xsolla.com/ja/api/catalog/bundles-admin/admin-get-bundle-list.md): 管理用のプロジェクト内のバンドルリストを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### バンドルを作成 - [POST /v2/project/{project_id}/admin/items/bundle](https://developers.xsolla.com/ja/api/catalog/bundles-admin/admin-create-bundle.md): バンドルを作成します。 ### 指定されたグループexternal IDのバンドルリストを取得する - [GET /v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}](https://developers.xsolla.com/ja/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-external-id.md): 管理用のグループ内のバンドルリストを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### 指定されたグループIDのバンドルリストを取得する - [GET /v2/project/{project_id}/admin/items/bundle/group/id/{group_id}](https://developers.xsolla.com/ja/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-id.md): 管理用のグループ内のバンドルリストを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### バンドルを削除 - [DELETE /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/ja/api/catalog/bundles-admin/admin-delete-bundle.md): バンドルを削除します。 ### バンドルを取得 - [GET /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/ja/api/catalog/bundles-admin/admin-get-bundle.md): 管理用プロジェクト内のバンドルを取得します。 注このエンドポイントは、ストアカタログの構築に使用しないでください。 ### バンドルを更新 - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/ja/api/catalog/bundles-admin/admin-update-bundle.md): バンドルを更新します。 ### カタログにバンドルを非表示 - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide](https://developers.xsolla.com/ja/api/catalog/bundles-admin/admin-hide-bundle.md): カタログにバンドルを非表示します。 ### カタログにバンドルを表示 - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/show](https://developers.xsolla.com/ja/api/catalog/bundles-admin/admin-show-bundle.md): カタログにバンドルを表示します。 ## カタログ ### バンドルのリストを取得 - [GET /v2/project/{project_id}/items/bundle](https://developers.xsolla.com/ja/api/catalog/bundles-catalog/get-bundle-list.md): Gets a list of bundles for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 指定されたグループのバンドルリストを取得する - [GET /v2/project/{project_id}/items/bundle/group/{external_id}](https://developers.xsolla.com/ja/api/catalog/bundles-catalog/get-bundle-list-in-group.md): Gets a list of bundles within a group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 指定されたバンドルを取得する - [GET /v2/project/{project_id}/items/bundle/sku/{sku}](https://developers.xsolla.com/ja/api/catalog/bundles-catalog/get-bundle.md): Gets a specified bundle. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## カート（クライアント側） ### 現在のユーザーのカートを取得 - [GET /v2/project/{project_id}/cart](https://developers.xsolla.com/ja/api/catalog/cart-client-side/get-user-cart.md): 現在のユーザーのカートを返します。 ### 現在のカートからすべてのカートアイテムを削除 - [PUT /v2/project/{project_id}/cart/clear](https://developers.xsolla.com/ja/api/catalog/cart-client-side/cart-clear.md): カートのアイテムをすべて削除します。 ### カートにアイテムを入れる - [PUT /v2/project/{project_id}/cart/fill](https://developers.xsolla.com/ja/api/catalog/cart-client-side/cart-fill.md): カートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。 ### 現在のカートからアイテムを削除 - [DELETE /v2/project/{project_id}/cart/item/{item_sku}](https://developers.xsolla.com/ja/api/catalog/cart-client-side/delete-item.md): カートからアイテムを削除します。 ### 現在のカートからカートのアイテムを更新 - [PUT /v2/project/{project_id}/cart/item/{item_sku}](https://developers.xsolla.com/ja/api/catalog/cart-client-side/put-item.md): 既存のカートアイテムを更新するか、カート内のアイテムを作成します。 ### カートIDによりカートを取得 - [GET /v2/project/{project_id}/cart/{cart_id}](https://developers.xsolla.com/ja/api/catalog/cart-client-side/get-cart-by-id.md): カートIDによりユーザーのカートを返します。 ### カートIDによるすべてカートアイテムを削除 - [PUT /v2/project/{project_id}/cart/{cart_id}/clear](https://developers.xsolla.com/ja/api/catalog/cart-client-side/cart-clear-by-id.md): カートのアイテムをすべて削除します。 ### カートに特定のアイテムを入れる - [PUT /v2/project/{project_id}/cart/{cart_id}/fill](https://developers.xsolla.com/ja/api/catalog/cart-client-side/cart-fill-by-id.md): カートに特定のアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテム位置が渡された値で置き換えられます。 ### カートIDによるカートアイテムを削除 - [DELETE /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://developers.xsolla.com/ja/api/catalog/cart-client-side/delete-item-by-cart-id.md): カートからアイテムを削除します。 ### カートIDによるカートアイテムを更新 - [PUT /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://developers.xsolla.com/ja/api/catalog/cart-client-side/put-item-by-cart-id.md): 既存のカートアイテムを更新するか、カート内のアイテムを作成します。 ## カート（サーバー側） ### カートにアイテムを入れる - [PUT /v2/admin/project/{project_id}/cart/fill](https://developers.xsolla.com/ja/api/catalog/cart-server-side/admin-cart-fill.md): 現在のカートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。 ### カートIDでカートにアイテムを入れる - [PUT /v2/admin/project/{project_id}/cart/{cart_id}/fill](https://developers.xsolla.com/ja/api/catalog/cart-server-side/admin-fill-cart-by-id.md): カートIDによるカートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。 ## 決済（クライアント側） ### 現在のカートの全アイテムを対象とした注文を作成する - [POST /v2/project/{project_id}/payment/cart](https://developers.xsolla.com/ja/api/catalog/payment-client-side/create-order.md): クライアントサーバーへの統合に使用されます。カートからのすべてのアイテムを含む注文を作成し、そのための決済トークンを生成します。作成された注文はnew注文ステータスを取得します。 クライアントIPは、ユーザーの国を決定するために使用され、注文に対応する通貨と利用可能な決済方法を適用するために使用されます。 決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください：https://secure.xsolla.com/paystation4/?token={token}で{token}受信したトークン。 テスト目的には、以下のリンクを使用してください：https://sandbox-secure.xsolla.com/paystation4/?token={token}。 注意このメソッドはIPを使用してユーザーの国を決定し、注文の通貨を選択するため、このメソッドはクライアント側からのみ使用し、サーバー側からは使用しないことが重要です。サーバー側からこの方法を使用すると、通貨が正しく判定されず、ペイステーションの決済方法に影響を与える可能性があります。 ### 特定のカートの全アイテムを対象とした注文を作成する - [POST /v2/project/{project_id}/payment/cart/{cart_id}](https://developers.xsolla.com/ja/api/catalog/payment-client-side/create-order-by-cart-id.md): クライアントサーバーへの統合に使用されます。特定のカートからのすべてのアイテムを含む注文を作成し、そのための決済トークンを生成します。作成された注文はnew注文ステータスを取得します。 クライアントIPは、ユーザーの国を決定するために使用され、注文に対応する通貨と利用可能な決済方法を適用するために使用されます。 決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください：https://secure.xsolla.com/paystation4/?token={token}で{token}受信したトークン。 テスト目的には、以下のリンクを使用してください：https://sandbox-secure.xsolla.com/paystation4/?token={token}。 注意このメソッドはIPを使用してユーザーの国を決定し、注文の通貨を選択するため、このメソッドはクライアント側からのみ使用し、サーバー側からは使用しないことが重要です。サーバー側からこの方法を使用すると、通貨が正しく判定されず、ペイステーションの決済方法に影響を与える可能性があります。 ### 指定したアイテムで注文を作成する - [POST /v2/project/{project_id}/payment/item/{item_sku}](https://developers.xsolla.com/ja/api/catalog/payment-client-side/create-order-with-item.md): Used for client-to-server integration. Creates an order with a specified item and generates a payment token for it. The created order gets the new order status. The client IP is used to determine the user’s country, which is then used to apply the corresponding currency and available payment methods for the order. To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation4/?token={token}, where {token} is the received token. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Notice As this method uses the IP to determine the user’s country and select a currency for the order, it is important to only use this method from the client side and not from the server side. Using this method from the server side may cause incorrect currency determination and affect payment methods in Pay Station. Notice This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ## 決済（サーバー側） ### 購入用の決済トークンを作成する - [POST /v3/project/{project_id}/admin/payment/token](https://developers.xsolla.com/ja/api/catalog/payment-server-side/admin-create-payment-token.md): 注文とその支払いトークンを生成します。注文はリクエストボディに渡されたアイテムに基づいて生成されます。 決済UIを新しいウィンドウで開くには、次のリンクを使用します：https://secure.xsolla.com/paystation4/?token={token}。そこで、{token}は受信したトークンです。 テスト目的では、次のURLを使用します：https://sandbox-secure.xsolla.com/paystation4/?token={token}。 通知 user.country.valueパラメータは、注文の通貨を選択するために使用されます。ユーザーの国が不明な場合は、 X-User-IpヘッダーにユーザーのIPを指定することもできます。この方法の正しい動作には、これら2つのオプションのいずれかが必要です。選択した通貨は、ペイステーションでの決済方法に使用されます。 ## 注文 ### 注文する - [GET /v2/project/{project_id}/order/{order_id}](https://developers.xsolla.com/ja/api/catalog/order/get-order.md): 指定された注文を取得します。 ### 指定期間の注文リストを取得する - [POST /v3/project/{project_id}/admin/order/search](https://developers.xsolla.com/ja/api/catalog/order/admin-order-search.md): 作成日の古いものから新しいものへと並べられた注文リストを取得します。 ## 無料アイテム ### 無料カートで注文を作成する - [POST /v2/project/{project_id}/free/cart](https://developers.xsolla.com/ja/api/catalog/free-item/create-free-order.md): 無料カートのすべてのアイテムを含む注文を作成します。作成された注文はdoneという注文状況を取得します。 ### 特定の無料カートで注文を作成する - [POST /v2/project/{project_id}/free/cart/{cart_id}](https://developers.xsolla.com/ja/api/catalog/free-item/create-free-order-by-cart-id.md): 特定の無料カートのすべてのアイテムを含む注文を作成します。作成された注文はdoneという注文状況を取得します。 ### 指定された無料アイテムで注文を作成する - [POST /v2/project/{project_id}/free/item/{item_sku}](https://developers.xsolla.com/ja/api/catalog/free-item/create-free-order-with-item.md): Creates an order with a specified free item. The created order will get a done order status. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 管理 ### 指定したユーザーのすべての購入制限を更新する - [DELETE /v2/project/{project_id}/admin/user/limit/item/all](https://developers.xsolla.com/ja/api/catalog/user-limits-admin/reset-all-user-items-limit.md): ユーザーが再度購入できるように、アイテムの購入制限を更新します。 User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します： * ゲームキー * 仮想アイテム & 通貨 * バンドル ### 指定したユーザーが利用できるアイテムの数を減らす - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/user-limits-admin/remove-user-item-limit.md): 適用される制限内で、指定されたユーザーが使用できるアイテムの残りの数を減らします。 User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します： * ゲームキー * 仮想アイテム & 通貨 * バンドル ### 指定されたユーザが利用できるアイテムの数を取得する - [GET /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/user-limits-admin/get-user-item-limit.md): 適用される制限内で、指定されたユーザーが使用できるアイテムの残りの数を取得します。 User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテムタイプモジュールの 管理セクションに移動します： * ゲームキー * 仮想アイテム & 通貨 * バンドル ### 指定したユーザーが使用できるアイテムの数を増やす - [POST /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/user-limits-admin/add-user-item-limit.md): 適用される制限内で、指定されたユーザーが使用できるアイテムの残りの数を増やします。 User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します： * ゲームキー * 仮想アイテム & 仮想通貨 * バンドル ### 指定されたユーザーが利用できるアイテムの数を設定する - [PUT /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/user-limits-admin/set-user-item-limit.md): 指定されたユーザーが、増減後に適用された制限の範囲内で購入できる数量を設定します。 User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテムタイプモジュールの 管理セクションに移動します： * ゲームキー * 仮想アイテム & 仮想通貨 * バンドル ### 購入制限を更新する - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all](https://developers.xsolla.com/ja/api/catalog/user-limits-admin/reset-user-item-limit.md): ユーザーが再び購入できるように、アイテムの購入制限を更新します。userパラメータがnullである場合、このコールはすべてのユーザーに対してこの制限を更新します。 User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します： * ゲームキー * 仮想アイテム & 仮想通貨 * バンドル ## 管理者 ### アイテムのインポート状況を取得する - [GET /v1/admin/projects/{project_id}/connectors/import_items/import/status](https://developers.xsolla.com/ja/api/catalog/connector-admin/get-items-import-status.md): プロジェクトへのアイテムのインポートの進行状況に関する情報を取得します。このAPIコールでは、APIまたはPublisher Account APIを通じて最後に実行されたインポートに関するデータを取得します。 ### JSONファイル経由でアイテムをインポートする - [POST /v1/projects/{project_id}/import/from_external_file](https://developers.xsolla.com/ja/api/catalog/connector-admin/import-items-from-external-file.md): 指定したURLを介してJSONファイルからストアにアイテムをインポートします。JSONファイルからのインポートの詳細については、ドキュメントを参照してください。 ## 先行予約 ### アイテムの先行予約制限の数量を削除 - [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/common-pre-orders/remove-pre-order-limit.md): アイテムの先行予約制限の数量を削除します。 Pre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います： * ゲームキー * 仮想アイテム & 仮想通貨 * バンドル このエンドポイントの別名： * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### アイテム先行予約制限に関する情報を取得 - [GET /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/common-pre-orders/get-pre-order-limit.md): アイテムの先行予約制限の取得を設定します。 Pre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います： * ゲームキー * 仮想アイテム & 仮想通貨 * バンドル このエンドポイントの別名： * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### アイテム先行予約制限に数量を追加 - [POST /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/common-pre-orders/add-pre-order-limit.md): アイテムの先行予約数に数量を追加します。 Pre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います： * ゲームキー * 仮想アイテム & 仮想通貨 * バンドル このエンドポイントの別名： * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### アイテムの先行予約制限の数量を設定 - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://developers.xsolla.com/ja/api/catalog/common-pre-orders/set-pre-order-limit.md): アイテムの先行予約制限の数量を設定します。 Pre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います： * ゲームキー * 仮想アイテム & 仮想通貨 * バンドル このエンドポイントの別名： * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### アイテムの先行予約制限の数量をすべて削除 - [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all](https://developers.xsolla.com/ja/api/catalog/common-pre-orders/remove-all-pre-order-limit.md): アイテムの先行予約制限のすべての数量を削除します。 Pre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います： * ゲームキー * 仮想アイテム & 仮想通貨 * バンドル このエンドポイントの別名： * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all ### アイテムの先行予約制限をトグル - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle](https://developers.xsolla.com/ja/api/catalog/common-pre-orders/toggle-pre-order-limit.md): アイテムの先行予約制限を有効/無効にします。 Pre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います： * ゲームキー * 仮想アイテム & 通貨 * バンドル このエンドポイントの別名： * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/toggle ## マーチャント ### プロジェクトを取得 - [GET /v2/merchant/{merchant_id}/projects](https://developers.xsolla.com/ja/api/catalog/common-merchant/get-projects.md): マーチャントのプロジェクトのリストを取得します。 注意このAPIコールには、project_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ## カタログ このAPIは販売可能なアイテムや特定のアイテムを取得することができます。 ### 販売可能なアイテムのリストを取得 - [GET /v2/project/{project_id}/items](https://developers.xsolla.com/ja/api/catalog/common-catalog/get-sellable-items.md): Gets a sellable items list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### 指定されたグループの販売可能なアイテムリストを取得 - [GET /v2/project/{project_id}/items/group/{external_id}](https://developers.xsolla.com/ja/api/catalog/common-catalog/get-sellable-items-group.md): Gets a sellable items list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### IDによる販売可能なアイテムを取得する - [GET /v2/project/{project_id}/items/id/{item_id}](https://developers.xsolla.com/ja/api/catalog/common-catalog/get-sellable-item-by-id.md): Gets a sellable item by its ID. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### SKUによる販売可能なアイテムを取得する - [GET /v2/project/{project_id}/items/sku/{sku}](https://developers.xsolla.com/ja/api/catalog/common-catalog/get-sellable-item-by-sku.md): Gets a sellable item by SKU for building a catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 共通地域 ### 地域リストを取得する - [GET /v2/project/{project_id}/admin/region](https://developers.xsolla.com/ja/api/catalog/common-regions/admin-get-regions.md): 地域を取得します。 地域制限を管理するためにリージョンを使用することができます。 ### 地域を作成する - [POST /v2/project/{project_id}/admin/region](https://developers.xsolla.com/ja/api/catalog/common-regions/admin-create-region.md): 地域を作成します。 地域制限を管理するためにリージョンを使用することができます。 ### 地域を削除する - [DELETE /v2/project/{project_id}/admin/region/{region_id}](https://developers.xsolla.com/ja/api/catalog/common-regions/admin-delete-region.md): 特定の地域を削除します。 ### 地域を取得する - [GET /v2/project/{project_id}/admin/region/{region_id}](https://developers.xsolla.com/ja/api/catalog/common-regions/admin-get-region.md): 特定地域を取得します。 地域制限を管理するために地域を使用することができます。 ### 地域を更新する - [PUT /v2/project/{project_id}/admin/region/{region_id}](https://developers.xsolla.com/ja/api/catalog/common-regions/admin-update-region.md): 特定地域を更新します。 地域制限を管理するために地域を使用することができます。 ## 管理者 ### 属性リストを取得する（管理者） - [GET /v2/project/{project_id}/admin/attribute](https://developers.xsolla.com/ja/api/catalog/attribute-admin/admin-get-attribute-list.md): 管理用プロジェクトから属性のリストを取得します。 ### 属性を作成 - [POST /v2/project/{project_id}/admin/attribute](https://developers.xsolla.com/ja/api/catalog/attribute-admin/admin-create-attribute.md): 属性を作成します。 ### 属性を削除 - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/ja/api/catalog/attribute-admin/delete-attribute.md): 属性を削除します。 注意アイテム属性を削除すると、そのすべてのデータおよびアイテムとの関連付けが失われます。 ### 指定された属性を取得 - [GET /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/ja/api/catalog/attribute-admin/admin-get-attribute.md): 指定された属性を取得します。 ### 属性を更新 - [PUT /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/ja/api/catalog/attribute-admin/admin-update-attribute.md): 属性を更新します。 ### 属性値をすべて削除 - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value](https://developers.xsolla.com/ja/api/catalog/attribute-admin/admin-delete-all-attribute-value.md): 属性のすべての値を削除します。 注意属性の値を削除すると、その属性とアイテム間のすべての関連付けが失われます。アイテムの属性値を変更するには、値を削除して新しい値を作成するのではなく、属性値を更新するAPIコールを使用してください。 ### 属性値を作成 - [POST /v2/project/{project_id}/admin/attribute/{external_id}/value](https://developers.xsolla.com/ja/api/catalog/attribute-admin/admin-create-attribute-value.md): 属性値を作成します。 注意すべてのプロジェクトには、応答で得られる属性値に制限があります。初期値および最大値は、1属性あたり20個の値。 ### 属性値を削除 - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://developers.xsolla.com/ja/api/catalog/attribute-admin/admin-delete-attribute-value.md): 一つの属性値を削除します。 注意属性の値を削除すると、その属性とアイテム間のすべての関連付けが失われます。アイテムの属性値を変更するには、値を削除して新しい値を作成するのではなく、属性値を更新するAPIコールを使用してください。 ### 属性値を更新 - [PUT /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://developers.xsolla.com/ja/api/catalog/attribute-admin/admin-update-attribute-value.md): 属性値を更新します。 ## 管理者 ### Reorder items within a group (by ID) - [PUT /v2/project/{project_id}/admin/group/id/{id}/order/item](https://developers.xsolla.com/ja/api/catalog/item-groups-admin/admin-reorder-items-in-group-by-id.md): Sets the display order of items within a group identified by its internal numeric ID. Pass an array of items with their new order values. ### Reorder item groups - [PUT /v2/project/{project_id}/admin/group/order](https://developers.xsolla.com/ja/api/catalog/item-groups-admin/admin-reorder-item-groups.md): Sets the display order for item groups within a project. Pass an array of groups with their new order values. ### Reorder items within a group (by external ID) - [PUT /v2/project/{project_id}/admin/group/{external_id}/order/item](https://developers.xsolla.com/ja/api/catalog/item-groups-admin/admin-reorder-items-in-group.md): Sets the display order of items within a group identified by its external ID. Pass an array of items with their new order values. ### アイテムグループリストを取得する - [GET /v2/project/{project_id}/admin/items/groups](https://developers.xsolla.com/ja/api/catalog/item-groups-admin/admin-get-item-group-list.md): Retrieves the full list of item groups within a project without pagination. For administrative purposes. NoteDo not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead. ### Create item group - [POST /v2/project/{project_id}/admin/items/groups](https://developers.xsolla.com/ja/api/catalog/item-groups-admin/admin-create-item-group.md): Creates an item group within a project. To retrieve item groups for building a catalog, use the Get item group list client-side endpoint. ### Delete item group - [DELETE /v2/project/{project_id}/admin/items/groups/{external_id}](https://developers.xsolla.com/ja/api/catalog/item-groups-admin/admin-delete-item-group.md): Deletes an item group by its external ID. ### Get item group by external ID - [GET /v2/project/{project_id}/admin/items/groups/{external_id}](https://developers.xsolla.com/ja/api/catalog/item-groups-admin/admin-get-item-group.md): Retrieves an item group by its external ID for administrative purposes. NoteDo not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead. ### Update item group - [PUT /v2/project/{project_id}/admin/items/groups/{external_id}](https://developers.xsolla.com/ja/api/catalog/item-groups-admin/admin-update-item-group.md): Updates an item group by its external ID. ### Get item group list filtered by item type - [GET /v2/project/{project_id}/admin/items/{item_type}/groups](https://developers.xsolla.com/ja/api/catalog/item-groups-admin/admin-get-item-group-list-by-item-type.md): Retrieves item group list with filtering by item type. Only items of the specified type are counted for the group. This is similar to the Get item group list endpoint, with additional filtering of items by type when counting them. ### Get item group by external ID filtered by item type - [GET /v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}](https://developers.xsolla.com/ja/api/catalog/item-groups-admin/admin-get-item-group-by-item-type.md): Retrieves an item group by external ID. Only items of the specified type are counted for the group. This is similar to the Get item group by external ID endpoint, with additional filtering of items by type when counting them. ## カタログ ### アイテムグループリストを取得する - [GET /v2/project/{project_id}/items/groups](https://developers.xsolla.com/ja/api/catalog/item-groups-catalog/get-item-groups.md): Retrieves an item group list for building a catalog without pagination. NoteThe use of the item catalog API calls is available without authorization, but to get a personalized catalog, you must pass the user JWT in the Authorization header.