` is the user token. The token identifies the user and provides access to personalized data.
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/)
- [Webhooks](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` — order 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"
}
}
```
# Country and currency determination
The user's country determines catalog prices, the payment currency, and available payment methods
in the payment UI. Depending on the API call, the country is determined as follows:
- In client-side API calls,
the country is determined by the IP address of the request.
- In server-side API calls,
the country is determined by the value of the
user.country.value parameter or by the user's IP address
from the X-User-Ip header. If both are passed, the user.country.value parameter takes precedence.
Note
Only
IPv4 addresses are supported for country determination.
Passing an
IPv6 address may result in incorrect country
and currency detection. If you use the server-side API call and cannot provide the user's IPv4 address,
pass the country in the
user.country.value parameter.
# 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
### 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
### XsollaLoginUserJWT
クライアント側からのAPIコールには、`XsollaLoginUserJWT`認証スキームを使用します。リクエストの`Authorization`ヘッダーには、「Bearer ``」という形式でユーザーのJWTを含める必要があります：このトークンによってユーザーが識別され、パーソナライズされたデータへのアクセスが可能になります。トークンの作成方法の詳細については、[エクソーラログインAPIに関するドキュメント](/ja/api/login/authentication-schemes#getting-user-token)を参照してください。
別の方法として、[決済UIを開くためのトークン](/ja/api/pay-station/token/create-token)を使用することも可能です。
Type: http
Scheme: bearer
Bearer Format: JWT
### AuthForCart
`AuthForCart`認証スキームはカートでの購入用であり、以下の2つのモードに対応しています：
1. ユーザーのJWTによる認証。トークンは次の形式で認証ヘッダーに渡されます：`Authorization: Bearer `。ここで``はユーザートークンです。トークンはユーザーを識別し、パーソナライズされたデータへのアクセスを提供します。
別の方法として、[決済UIを開くためのトークン](/ja/api/pay-station/token/create-token)を使用することも可能です。
`Authorization`ヘッダーなしの簡易モード。これは未認証ユーザー専用のモードであり、[ゲームキー販売](/ja/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
### basicMerchantAuth
サーバー側のコールでは、`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
[カタログAPI](https://xsolla.redocly.app/_bundle/@l10n/ja/api/catalog/index.yaml)
## 管理者
### 仮想アイテムのリストを取得
- [GET /v2/project/{project_id}/admin/items/virtual_items](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list.md): 管理用のプロジェクト内の仮想アイテムリストを取得します。
注このエンドポイントは、ストアカタログの構築に使用しないでください。
### 仮想アイテムを作成
- [POST /v2/project/{project_id}/admin/items/virtual_items](https://xsolla.redocly.app/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://xsolla.redocly.app/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://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-id.md): 管理用のグループ内の仮想アイテムリストを取得します。
注このエンドポイントは、ストアカタログの構築に使用しないでください。
### 仮想アイテムを取得
- [GET /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/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://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-update-virtual-item.md): 仮想アイテムを更新します。
### 仮想アイテムを削除
- [DELETE /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-delete-virtual-item.md): 仮想アイテムを削除します。
### 仮想通貨のリストを取得
- [GET /v2/project/{project_id}/admin/items/virtual_currency](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-currencies-list.md): 管理用のプロジェクト内の仮想通貨リストを取得します。
注このエンドポイントは、ストアカタログの構築に使用しないでください。
### 仮想通貨を作成
- [POST /v2/project/{project_id}/admin/items/virtual_currency](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency.md): 仮想通貨を作成します。
### 仮想通貨を取得
- [GET /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/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://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency.md): 仮想通貨を更新します。
### 仮想通貨を削除
- [DELETE /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency.md): 仮想通貨を削除します。
### 仮想通貨パッケージリストを取得（管理者）
- [GET /v2/project/{project_id}/admin/items/virtual_currency/package](https://xsolla.redocly.app/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://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency-package.md): 仮想通貨パッケージを作成します。
### 仮想通貨パッケージを更新
- [PUT /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency-package.md): 仮想通貨パッケージを更新します。
### 仮想通貨パッケージを削除
- [DELETE /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://xsolla.redocly.app/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://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-package.md): 管理用のプロジェクト内の仮想通貨パッケージを取得します。
注このエンドポイントは、ストアカタログの構築に使用しないでください。
## カタログ
### 仮想アイテムリストを取得
- [GET /v2/project/{project_id}/items/virtual_items](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items.md): カタログ構築のために、仮想アイテムのリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
関連情報： クライアント側の検索またはインデックス作成のためのすべての仮想アイテムリストを取得するAPIコール。
### SKUによる仮想アイテムを取得
- [GET /v2/project/{project_id}/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items-sku.md): カタログを作成するためにSKUによる仮想アイテムを取得します。
注意
このAPIコールは、認証なしで使用した場合、一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連付けられた制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、AuthorizationヘッダーにユーザーJWTを渡します。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### すべての仮想アイテムリストを取得
- [GET /v2/project/{project_id}/items/virtual_items/all](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-catalog/get-all-virtual-items.md): ククライアント側での検索用に、すべての仮想アイテムのリストを取得します。
注意
アイテムSKU、名前、グループ、および説明のみを返します。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
関連情報： ページネーションに対応した詳細なアイテムデータをを取得するため仮想アイテムリストを取得するAPIコール。
### 仮想通貨リストを取得
- [GET /v2/project/{project_id}/items/virtual_currency](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-catalog/get-virtual-currency.md): カタログ構築のために、仮想通貨のリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### SKUによる仮想通貨を取得
- [GET /v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-catalog/get-virtual-currency-sku.md): カタログを作成するためにSKUによる仮想通貨を取得します。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### 仮想通貨パッケージリストを取得
- [GET /v2/project/{project_id}/items/virtual_currency/package](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package.md): カタログ構築のために、仮想通貨パッケージを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### SKUによる販売可能なアイテムを取得する
- [GET /v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-sku.md): カタログを作成するためにSKUによる仮想通貨パッケージを取得します。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### 指定されたグループによるアイテムリストを取得
- [GET /v2/project/{project_id}/items/virtual_items/group/{external_id}](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items-group.md): カタログを作成するために、指定されたグループからアイテムリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### 指定されたグループの仮想通貨リストを取得します
- [GET /v2/project/{project_id}/items/virtual_currency/group/{external_id}](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-catalog/get-virtual-currency-group.md): カタログを構築するために、指定されたグループから仮想通貨リストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### 指定されたグループの仮想通貨パッケージリストを取得します
- [GET /v2/project/{project_id}/items/virtual_currency/package/group/{external_id}](https://xsolla.redocly.app/ja/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-group.md): カタログを構築するために、指定されたグループから仮想通貨パッケージリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
## 仮想決済
### 仮想通貨で購入した指定商品で注文を作成する
- [POST /v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}](https://xsolla.redocly.app/ja/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency.md): 仮想通貨を使用したアイテム購入を作成します。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
## カタログ
### ゲームリストを取得
- [GET /v2/project/{project_id}/items/game](https://xsolla.redocly.app/ja/api/catalog/game-keys-catalog/get-games-list.md): カタログ構築のために、ゲームのリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### 指定されたグループによるゲームリストを取得
- [GET /v2/project/{project_id}/items/game/group/{external_id}](https://xsolla.redocly.app/ja/api/catalog/game-keys-catalog/get-games-group.md): カタログ構築のために、指定されたグループからゲームリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### カタログ用ゲームを取得
- [GET /v2/project/{project_id}/items/game/sku/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/game-keys-catalog/get-game-by-sku.md): カタログのゲームを取得します。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### カタログ用のゲームキーを取得
- [GET /v2/project/{project_id}/items/game/key/sku/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/game-keys-catalog/get-game-key-by-sku.md): カタログのゲームキーを取得します。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### 指定されたグループのゲームキーリストを取得
- [GET /v2/project/{project_id}/items/game/key/group/{external_id}](https://xsolla.redocly.app/ja/api/catalog/game-keys-catalog/get-game-keys-group.md): カタログ構築のために、指定されたグループからゲームキーのリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### DRMリストを取得
- [GET /v2/project/{project_id}/items/game/drm](https://xsolla.redocly.app/ja/api/catalog/game-keys-catalog/get-drm-list.md): 利用可能なDRMのリストを取得します。
## 資格
### ユーザーが所有しているゲームソフトのリストを取得
- [GET /v2/project/{project_id}/entitlement](https://xsolla.redocly.app/ja/api/catalog/game-keys-entitlement/get-user-games.md): ユーザーが所有しているゲームソフトのリストを取得します。応答には特定のユーザーが所有するゲームの配列が含まれます。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### クライアントによるゲームコードを引き換える
- [POST /v2/project/{project_id}/entitlement/redeem](https://xsolla.redocly.app/ja/api/catalog/game-keys-entitlement/redeem-game-pin-code.md): 提供されたゲームコードで権利を付与します。
注意
コードの引き換えは、DRMフリーのプラットフォームのみに対応しています。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### 資格付与（管理者）
- [POST /v2/project/{project_id}/admin/entitlement/grant](https://xsolla.redocly.app/ja/api/catalog/game-keys-entitlement/grant-entitlement-admin.md): ユーザーに権利を付与します。
注意 ゲームコードやDRM-freeプラットフォームのゲームのみ付与可能です。
### 資格の取り消し（管理者）
- [POST /v2/project/{project_id}/admin/entitlement/revoke](https://xsolla.redocly.app/ja/api/catalog/game-keys-entitlement/revoke-entitlement-admin.md): ユーザーの権利を取り消します。
注意ゲームコードやDRMフリープラットフォームのゲームのみ取り消すことができます。
## 管理者
### ゲームを作成
- [POST /v2/project/{project_id}/admin/items/game](https://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-create-game.md): プロジェクト内のゲームを作成します。
### ゲームリストを取得（管理者）
- [GET /v2/project/{project_id}/admin/items/game](https://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-get-game-list.md): 管理用プロジェクト内のゲームのリストを取得します。
ゲームは、ユーザーが購入可能なゲームキーで構成されています。
注このエンドポイントは、ストアカタログの構築に使用しないでください。
### ゲームを取得（管理者）
- [GET /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/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://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-update-game-by-sku.md): SKUによるプロジェクト内のゲームを更新します。
### ゲームをSKUで削除
- [DELETE /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-delete-game-by-sku.md): SKUによるプロジェクト内のゲームを削除します。
### IDでゲームを取得（管理者）
- [GET /v2/project/{project_id}/admin/items/game/id/{item_id}](https://xsolla.redocly.app/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://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-update-game-by-id.md): IDによるプロジェクト内のゲームを更新します。
### IDによるゲームを削除
- [DELETE /v2/project/{project_id}/admin/items/game/id/{item_id}](https://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-delete-game-by-id.md): IDによるプロジェクト内のゲームを削除します。
### コードをアップロード
- [POST /v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-upload-codes-by-sku.md): ゲームキーSKUによるコードをアップロードします。
### IDによるコードをアップロード
- [POST /v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}](https://xsolla.redocly.app/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://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-get-codes-session.md): コード読み込みセッションに関する情報を取得します。
### コードを取得
- [GET /v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-get-codes-by-sku.md): ゲームキーSKUによる一定数のコードを取得します。
### IDによるコードを取得
- [GET /v2/project/{project_id}/admin/items/game/key/request/id/{item_id}](https://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-get-codes-by-id.md): ゲームキーIDによる一定数のコードを取得します。
### コードを削除
- [DELETE /v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-delete-codes-by-sku.md): ゲームキーSKUによる全コードを削除します。
### IDによるコードを削除
- [DELETE /v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}](https://xsolla.redocly.app/ja/api/catalog/game-keys-admin/admin-delete-codes-by-id.md): ゲームキーIDによりすべてのコードを削除します。
## 管理者
### バンドルのリストを取得
- [GET /v2/project/{project_id}/admin/items/bundle](https://xsolla.redocly.app/ja/api/catalog/bundles-admin/admin-get-bundle-list.md): 管理用のプロジェクト内のバンドルリストを取得します。
注このエンドポイントは、ストアカタログの構築に使用しないでください。
### バンドルを作成
- [POST /v2/project/{project_id}/admin/items/bundle](https://xsolla.redocly.app/ja/api/catalog/bundles-admin/admin-create-bundle.md): 複数のアイテムを1つの単位としてセット販売するバンドルを作成します。バンドルには、仮想アイテム、仮想通貨パッケージ、ゲームキー、および他のバンドルを含めることができます。詳細については、バンドルセクションを参照してください。
注意content配列内のすべてのアイテムは、事前にプロジェクト内で作成されている必要があります。指定されたSKUが存在しない場合、システムはエラーを返します。
### 指定されたグループIDのバンドルリストを取得する
- [GET /v2/project/{project_id}/admin/items/bundle/group/id/{group_id}](https://xsolla.redocly.app/ja/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-id.md): 管理用にグループ内のバンドルリストを取得します。
注このエンドポイントは、ストアカタログの構築に使用しないでください。
### 指定されたグループexternal IDのバンドルリストを取得
- [GET /v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}](https://xsolla.redocly.app/ja/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-external-id.md): 管理用にグループ内のバンドルリストを取得します。
注このエンドポイントは、ストアカタログの構築に使用しないでください。
### バンドルを更新
- [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/ja/api/catalog/bundles-admin/admin-update-bundle.md): バンドルを更新します。このAPIコールはバンドル情報を完全に上書きします。変更したいフィールドだけでなく、リクエスト本文に必要なすべてのフィールドを渡してください。詳細については、バンドルセクションを参照してください。
注意content配列内のすべてのアイテムは、事前にプロジェクト内で作成されている必要があります。指定されたSKUが存在しない場合、システムはエラーを返します。
### バンドルを削除
- [DELETE /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/ja/api/catalog/bundles-admin/admin-delete-bundle.md): バンドルを削除します。
### バンドルを取得
- [GET /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/ja/api/catalog/bundles-admin/admin-get-bundle.md): 管理用プロジェクト内のバンドルを取得します。
注このエンドポイントは、ストアカタログの構築に使用しないでください。
### カタログにバンドルを表示
- [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/show](https://xsolla.redocly.app/ja/api/catalog/bundles-admin/admin-show-bundle.md): カタログにバンドルを表示します。
### カタログにバンドルを非表示
- [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide](https://xsolla.redocly.app/ja/api/catalog/bundles-admin/admin-hide-bundle.md): カタログにバンドルを非表示します。
## カタログ
### バンドルのリストを取得
- [GET /v2/project/{project_id}/items/bundle](https://xsolla.redocly.app/ja/api/catalog/bundles-catalog/get-bundle-list.md): カタログ構築のために、バンドルのリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### 指定されたバンドルを取得
- [GET /v2/project/{project_id}/items/bundle/sku/{sku}](https://xsolla.redocly.app/ja/api/catalog/bundles-catalog/get-bundle.md): 指定されたバンドルを取得します。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### 指定されたグループのバンドルリストを取得
- [GET /v2/project/{project_id}/items/bundle/group/{external_id}](https://xsolla.redocly.app/ja/api/catalog/bundles-catalog/get-bundle-list-in-group.md): カタログ構築のために、グループ内のバンドルのリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
## カート（クライアント側）
このセクションのコールを使用して、クライアント側でカートを管理します。
### カートIDによりカートを取得
- [GET /v2/project/{project_id}/cart/{cart_id}](https://xsolla.redocly.app/ja/api/catalog/cart-client-side/get-cart-by-id.md): カートIDによりユーザーのカートを返します。
### 現在のユーザーのカートを取得
- [GET /v2/project/{project_id}/cart](https://xsolla.redocly.app/ja/api/catalog/cart-client-side/get-user-cart.md): 現在のユーザーのカートを返します。
### カートIDによるすべてカートアイテムを削除
- [PUT /v2/project/{project_id}/cart/{cart_id}/clear](https://xsolla.redocly.app/ja/api/catalog/cart-client-side/cart-clear-by-id.md): カートのアイテムをすべて削除します。
### 現在のカートからすべてのカートアイテムを削除
- [PUT /v2/project/{project_id}/cart/clear](https://xsolla.redocly.app/ja/api/catalog/cart-client-side/cart-clear.md): カートのアイテムをすべて削除します。
### カートにアイテムを入れる
- [PUT /v2/project/{project_id}/cart/fill](https://xsolla.redocly.app/ja/api/catalog/cart-client-side/cart-fill.md): カートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。
### カートに特定のアイテムを入れる
- [PUT /v2/project/{project_id}/cart/{cart_id}/fill](https://xsolla.redocly.app/ja/api/catalog/cart-client-side/cart-fill-by-id.md): カートに特定のアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテム位置が渡された値で置き換えられます。
### カートIDによるカートアイテムを更新
- [PUT /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/cart-client-side/put-item-by-cart-id.md): 既存のカートアイテムを更新するか、カート内のアイテムを作成します。
### カートIDによるカートアイテムを削除
- [DELETE /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/cart-client-side/delete-item-by-cart-id.md): カートからアイテムを削除します。
### 現在のカートからカートのアイテムを更新
- [PUT /v2/project/{project_id}/cart/item/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/cart-client-side/put-item.md): 既存のカートアイテムを更新するか、カート内のアイテムを作成します。
### 現在のカートからアイテムを削除
- [DELETE /v2/project/{project_id}/cart/item/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/cart-client-side/delete-item.md): カートからアイテムを削除します。
## カート（サーバー側）
このセクションのコールを使用して、サーバー側でカートを管理します。
### カートにアイテムを入れる
- [PUT /v2/admin/project/{project_id}/cart/fill](https://xsolla.redocly.app/ja/api/catalog/cart-server-side/admin-cart-fill.md): 現在のカートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。
### カートIDでカートにアイテムを入れる
- [PUT /v2/admin/project/{project_id}/cart/{cart_id}/fill](https://xsolla.redocly.app/ja/api/catalog/cart-server-side/admin-fill-cart-by-id.md): カートIDによるカートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。
## 決済（クライアント側）
このセクションのコールを使用して、クライアント側で決済トークンを作成します。
### 特定のカートの全アイテムを対象とした注文を作成する
- [POST /v2/project/{project_id}/payment/cart/{cart_id}](https://xsolla.redocly.app/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/cart](https://xsolla.redocly.app/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/item/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/payment-client-side/create-order-with-item.md): クライアントからサーバーへの統合に使用されます。指定したアイテムで注文を作成し、その注文用の決済トークンを生成します。作成された注文は、newの注文ステータスになります。
クライアントIPは、ユーザーの国を決定するために使用され、注文に対応する通貨と利用可能な決済方法を適用するために使用されます。
決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください：https://secure.xsolla.com/paystation4/?token={token}で{token}受信したトークン。
テスト目的には、以下のリンクを使用してください：https://sandbox-secure.xsolla.com/paystation4/?token={token}。
注意このメソッドはIPを使用してユーザーの国を決定し、注文の通貨を選択するため、このメソッドはクライアント側からのみ使用し、サーバー側からは使用しないことが重要です。サーバー側からこの方法を使用すると、通貨が正しく判定されず、ペイステーションの決済方法に影響を与える可能性があります。
注意
このAPIコールは、認証にユーザーのJWTを使用します。
以下の形式でAuthorizationヘッダーにトークンを含めます：Bearer <user_JWT>。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
## 決済（サーバー側）
このセクションのコールを使用して、サーバー側で決済トークンを作成します。
### 購入用の決済トークンを作成
- [POST /v3/project/{project_id}/admin/payment/token](https://xsolla.redocly.app/ja/api/catalog/payment-server-side/admin-create-payment-token.md): 注文とその支払いトークンを生成します。注文はリクエスト本文に渡されたアイテムに基づいて生成されます。
決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください：https://secure.xsolla.com/paystation4/?token={token}で{token}受信したトークン。
テスト目的には、以下のリンクを使用してください：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://xsolla.redocly.app/ja/api/catalog/order/get-order.md): 指定された注文を取得します。
### 指定期間の注文リストを取得する
- [POST /v3/project/{project_id}/admin/order/search](https://xsolla.redocly.app/ja/api/catalog/order/admin-order-search.md): 作成日の古いものから新しいものへと並べられた注文リストを取得します。
## 無料アイテム
ユーザーに無料アイテムを付与するには、このセクションのコールを使用してください。
### 無料カートで注文を作成
- [POST /v2/project/{project_id}/free/cart](https://xsolla.redocly.app/ja/api/catalog/free-item/create-free-order.md): 無料カートのすべてのアイテムを含む注文を作成します。作成された注文はdoneという注文状況を取得します。
### 特定の無料カートで注文を作成
- [POST /v2/project/{project_id}/free/cart/{cart_id}](https://xsolla.redocly.app/ja/api/catalog/free-item/create-free-order-by-cart-id.md): 特定の無料カートのすべてのアイテムを含む注文を作成します。作成された注文はdoneという注文状況を取得します。
### 指定された無料アイテムで注文を作成
- [POST /v2/project/{project_id}/free/item/{item_sku}](https://xsolla.redocly.app/ja/api/catalog/free-item/create-free-order-with-item.md): 指定された無料アイテムで注文を作成します。作成された注文は、doneの注文ステータスになります。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
## 管理
### 指定したユーザーのすべての購入制限を更新
- [DELETE /v2/project/{project_id}/admin/user/limit/item/all](https://xsolla.redocly.app/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}/all](https://xsolla.redocly.app/ja/api/catalog/user-limits-admin/reset-user-item-limit.md): ユーザーが再び購入できるように、アイテムの購入制限を更新します。userパラメータがnullである場合、このコールはすべてのユーザーに対してこの制限を更新します。
User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します：
* ゲームキー
* 仮想アイテム & 通貨
* バンドル
### 指定されたユーザが利用できるアイテムの数を取得
- [GET /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/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://xsolla.redocly.app/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://xsolla.redocly.app/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}](https://xsolla.redocly.app/ja/api/catalog/user-limits-admin/remove-user-item-limit.md): 適用される制限内で、指定されたユーザーが使用できるアイテムの残りの数を減らします。
User limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します：
* ゲームキー
* 仮想アイテム & 通貨
* バンドル
## 管理者
### JSONファイル経由でアイテムをインポートする
- [POST /v1/projects/{project_id}/import/from_external_file](https://xsolla.redocly.app/ja/api/catalog/connector-admin/import-items-from-external-file.md): 指定したURLを介してJSONファイルからストアにアイテムをインポートします。JSONファイルからのインポートの詳細については、ドキュメントを参照してください。
### アイテムのインポート状況を取得
- [GET /v1/admin/projects/{project_id}/connectors/import_items/import/status](https://xsolla.redocly.app/ja/api/catalog/connector-admin/get-items-import-status.md): プロジェクトへのアイテムのインポートの進行状況に関する情報を取得します。このAPIコールでは、APIまたはPublisher Account APIを通じて最後に実行されたインポートに関するデータを取得します。
## 先行予約
### アイテム先行予約制限に関する情報を取得
- [GET /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://xsolla.redocly.app/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://xsolla.redocly.app/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://xsolla.redocly.app/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}](https://xsolla.redocly.app/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}
### アイテムの先行予約制限をトグル
- [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle](https://xsolla.redocly.app/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
### アイテムの先行予約制限の数量をすべて削除
- [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all](https://xsolla.redocly.app/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
## マーチャント
### プロジェクトを取得
- [GET /v2/merchant/{merchant_id}/projects](https://xsolla.redocly.app/ja/api/catalog/common-merchant/get-projects.md): マーチャントのプロジェクトのリストを取得します。
注意このAPIコールには、project_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。
## カタログ
このAPIは販売可能なアイテムや特定のアイテムを取得することができます。
### 販売可能なアイテムのリストを取得
- [GET /v2/project/{project_id}/items](https://xsolla.redocly.app/ja/api/catalog/common-catalog/get-sellable-items.md): カタログ構築のために、販売可能なアイテムのリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### IDによる販売可能なアイテムを取得
- [GET /v2/project/{project_id}/items/id/{item_id}](https://xsolla.redocly.app/ja/api/catalog/common-catalog/get-sellable-item-by-id.md): IDによる販売可能なアイテムを取得します。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### SKUによる販売可能なアイテムを取得
- [GET /v2/project/{project_id}/items/sku/{sku}](https://xsolla.redocly.app/ja/api/catalog/common-catalog/get-sellable-item-by-sku.md): カタログを作成するためにSKUによる販売可能なアイテムを取得します。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
### 指定されたグループの販売可能なアイテムリストを取得
- [GET /v2/project/{project_id}/items/group/{external_id}](https://xsolla.redocly.app/ja/api/catalog/common-catalog/get-sellable-items-group.md): カタログ構築のために、指定されたグループから販売可能なアイテムのリストを取得します。
注意
すべてのプロジェクトには、応答で取得できるアイテム数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにデータを取得するには、制限とオフセットフィールドを使用してください。
注意
認証なしで使用した場合、このAPIコールは一般的なアイテムカタログデータを返します。認証を使用して、アイテムに関連する制限やプロモーションなどのパーソナライズされたユーザーデータを取得します。これを行うには、ユーザーのJWTをAuthorizationヘッダーに渡してください。ユーザーJWTの詳細については、このコールのセキュリティブロックを参照してください。
## 共通地域
地域別の販売制限を使用すると、特定の国または国グループにおけるアイテムの可用性を管理できます。例えば、ライセンスの制約により、特定の国だけでゲームを販売するといったことが可能です。
制限の設定には「地域」を使用します。各地域は、1つ以上の国を単一の`region_id`でまとめたものです。アイテムを1つ以上の地域に関連付けることができます。
アイテムの可用性は、以下のように判定されます：
* アイテムに地域の指定がない場合、すべての国で購入可能です。
* アイテムに地域が指定されており、ユーザーの国がそのいずれかに含まれている場合、そのユーザーはアイテムを購入できます。
* アイテムに地域が指定されており、ユーザーの国がどの地域にも含まれていない場合、そのユーザーはアイテムを購入できません。
ユーザーの国は、カタログセクションからのAPIコールを通じてカタログをリクエストする際、`country`パラメータとして渡されます。このパラメータが渡されない場合は、ユーザーのIPアドレスに基づいて国が判定されます。
ユーザーの国とアイテムの地域との照合は、カタログのリクエスト時と注文作成時の2回行われます。購入不可のアイテムはカタログのレスポンスには含まれず、そのようなアイテムを含む注文が作成されることはありません。
地域の作成、更新、および削除には、**共通地域**グループのAPIコールを使用します。
地域別の販売制限のセットアップフロー：
1. [地域を作成する](https://developers.xsolla.com/ja/api/catalog/common-regions/admin-create-region/)APIコールを使用して、対象となる国のリストを指定して地域を作成します。レスポンスには、次のステップで必要となる`region_id`が返されます。
2. アイテムを[作成する](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-item/)際、または[更新する](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-admin/admin-update-virtual-item/)際に、`regions`配列にその`region_id`を渡すことで、仮想アイテムを地域に関連付けます。
3. **カタログ**セクションのAPIコール（例：[仮想アイテムリストを取得する](https://developers.xsolla.com/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items)APIコール）を使用して、ユーザーにカタログを表示します。ユーザーの国は`country`パラメータによって決定されます。このパラメータが提供されない場合は、ユーザーのIPアドレスに基づいて判定されます。ユーザーの国で利用不可のアイテムは、カタログの応答には含まれません。
4. ユーザーがアイテムまたはカートの決済に進む際に、注文を作成します：
* アイテムをカートに追加している場合 — [特定のカートの全アイテムを対象とした注文を作成する](https://developers.xsolla.com/ja/api/catalog/payment-client-side/create-order)または[現在のカートの全アイテムを対象とした注文を作成する](https://developers.xsolla.com/ja/api/catalog/payment-client-side/create-order)APIコールを使用します。
* 単一アイテムの迅速な購入の場合 — アイテムのSKUを渡して[指定したアイテムで注文を作成する](https://developers.xsolla.com/ja/api/catalog/payment-client-side/create-order-with-item)APIコールを使用します。
レスポンスには、決済UIを開くためのトークンが含まれています。
注意
エクソーラは、ユーザーの国がアイテムに指定された地域に含まれているかを確認します。国がアイテムの地域に含まれていない場合、注文を作成することはできません。
5. 注文を支払うための決済UIを開く処理を実装します。
### 地域リストを取得
- [GET /v2/project/{project_id}/admin/region](https://xsolla.redocly.app/ja/api/catalog/common-regions/admin-get-regions.md): 地域を取得します。
地域制限を管理するためにリージョンを使用することができます。
### 地域を作成
- [POST /v2/project/{project_id}/admin/region](https://xsolla.redocly.app/ja/api/catalog/common-regions/admin-create-region.md): 地域を作成します。
地域制限を管理するためにリージョンを使用することができます。
### 地域を取得
- [GET /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/ja/api/catalog/common-regions/admin-get-region.md): 特定地域を取得します。
地域制限を管理するためにリージョンを使用することができます。
### 地域を更新
- [PUT /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/ja/api/catalog/common-regions/admin-update-region.md): 特定地域を更新します。
地域制限を管理するためにリージョンを使用することができます。
### 地域を削除
- [DELETE /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/ja/api/catalog/common-regions/admin-delete-region.md): 特定の地域を削除します。
## ウェブフック
### ウェブフックバージョンの更新
- [PUT /v2/project/{project_id}/admin/webhook/version](https://xsolla.redocly.app/ja/api/catalog/common-webhooks/update-webhook-version.md): プロジェクトのウェブフックバージョンを更新します。バージョン2では、items配列に追加のパラメータが含まれます。
ウェブフックの詳細については、注文状況の追跡のセットアップを参照してください。
## 管理者
### 属性リストを取得（管理者）
- [GET /v2/project/{project_id}/admin/attribute](https://xsolla.redocly.app/ja/api/catalog/attribute-admin/admin-get-attribute-list.md): 管理用プロジェクトから属性のリストを取得します。
### 属性を作成
- [POST /v2/project/{project_id}/admin/attribute](https://xsolla.redocly.app/ja/api/catalog/attribute-admin/admin-create-attribute.md): 属性を作成します。
### 属性を更新
- [PUT /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/ja/api/catalog/attribute-admin/admin-update-attribute.md): 属性を更新します。
### 指定された属性を取得
- [GET /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/ja/api/catalog/attribute-admin/admin-get-attribute.md): 指定された属性を取得します。
### 属性を削除
- [DELETE /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/ja/api/catalog/attribute-admin/delete-attribute.md): 属性を削除します。
注意アイテム属性を削除すると、そのすべてのデータおよびアイテムとの関連付けが失われます。
### 属性値を作成
- [POST /v2/project/{project_id}/admin/attribute/{external_id}/value](https://xsolla.redocly.app/ja/api/catalog/attribute-admin/admin-create-attribute-value.md): 属性値を作成します。
注意すべてのプロジェクトには、応答で得られる属性値に制限があります。初期値および最大値は、1属性あたり20個の値。
### 属性値をすべて削除
- [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value](https://xsolla.redocly.app/ja/api/catalog/attribute-admin/admin-delete-all-attribute-value.md): 属性のすべての値を削除します。
注意属性の値を削除すると、その属性とアイテム間のすべての関連付けが失われます。アイテムの属性値を変更するには、値を削除して新しい値を作成するのではなく、属性値を更新するAPIコールを使用してください。
### 属性値を更新
- [PUT /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://xsolla.redocly.app/ja/api/catalog/attribute-admin/admin-update-attribute-value.md): 属性値を更新します。
### 属性値を削除
- [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://xsolla.redocly.app/ja/api/catalog/attribute-admin/admin-delete-attribute-value.md): 一つの属性値を削除します。
注意属性の値を削除すると、その属性とアイテム間のすべての関連付けが失われます。アイテムの属性値を変更するには、値を削除して新しい値を作成するのではなく、属性値を更新するAPIコールを使用してください。
## 管理者
### アイテムグループリストを取得する
- [GET /v2/project/{project_id}/admin/items/groups](https://xsolla.redocly.app/ja/api/catalog/item-groups-admin/admin-get-item-group-list.md): プロジェクト内のアイテムグループの完全なリストをページネーションなしで取得します。管理目的のため。
注意このエンドポイントは、ストアカタログの構築に使用しないでください。代わりに、アイテムグループリストを取得クライアント側エンドポイントを使用してください。
### アイテムグループの作成
- [POST /v2/project/{project_id}/admin/items/groups](https://xsolla.redocly.app/ja/api/catalog/item-groups-admin/admin-create-item-group.md): プロジェクト内にアイテムグループを作成します。
カタログを構築するためにアイテムグループを取得するには、アイテムグループリストを取得するクライアント側エンドポイントを使用してください。
### 外部IDによるアイテムグループの取得
- [GET /v2/project/{project_id}/admin/items/groups/{external_id}](https://xsolla.redocly.app/ja/api/catalog/item-groups-admin/admin-get-item-group.md): 管理目的で外部IDを指定してアイテムグループを取得します。
注意このエンドポイントは、ストアカタログの構築に使用しないでください。代わりに、アイテムグループリストを取得クライアント側エンドポイントを使用してください。
### アイテムグループの更新
- [PUT /v2/project/{project_id}/admin/items/groups/{external_id}](https://xsolla.redocly.app/ja/api/catalog/item-groups-admin/admin-update-item-group.md): 外部IDによるアイテムグループを更新します。
### アイテムグループの削除
- [DELETE /v2/project/{project_id}/admin/items/groups/{external_id}](https://xsolla.redocly.app/ja/api/catalog/item-groups-admin/admin-delete-item-group.md): 外部IDによるアイテムグループを削除します。
### アイテムタイプでフィルタリングされたアイテムグループリストの取得
- [GET /v2/project/{project_id}/admin/items/{item_type}/groups](https://xsolla.redocly.app/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.
### アイテムタイプでフィルタリングされた外部IDによるアイテムグループの取得
- [GET /v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}](https://xsolla.redocly.app/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.
### アイテムグループの並び替え
- [PUT /v2/project/{project_id}/admin/group/order](https://xsolla.redocly.app/ja/api/catalog/item-groups-admin/admin-reorder-item-groups.md): プロジェクト内のアイテムグループの表示順を設定します。新しい順序の値を持つグループの配列を渡します。
### グループ内（外部IDによる）のアイテムの並べ替え
- [PUT /v2/project/{project_id}/admin/group/{external_id}/order/item](https://xsolla.redocly.app/ja/api/catalog/item-groups-admin/admin-reorder-items-in-group.md): 外部IDによって識別されるグループ内のアイテムの表示順序を設定します。新しい順序の値を指定したアイテムの配列を渡します。
### グループ内（IDによる）のアイテムの並べ替え
- [PUT /v2/project/{project_id}/admin/group/id/{id}/order/item](https://xsolla.redocly.app/ja/api/catalog/item-groups-admin/admin-reorder-items-in-group-by-id.md): 内部の数値IDによって識別されるグループ内のアイテムの表示順序を設定します。新しい順序の値を指定したアイテムの配列を渡します。
## カタログ
### アイテムグループリストを取得する
- [GET /v2/project/{project_id}/items/groups](https://xsolla.redocly.app/ja/api/catalog/item-groups-catalog/get-item-groups.md): ページネーションなしでカタログを構築するためのアイテムグループリストを取得します。
NoteIn general, the use of catalog of items is available without authorization. Only authorized users can get a personalized catalog.