# 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/ru/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](/ru/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. В качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/ru/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](/ru/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](/ru/api/getting-started/#api_keys_overview). ## Authentication with guest access support Для продажи корзины используется схема аутентификации `AuthForCart`, которая поддерживает два режима: 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. Alternatively, you can use a [token for opening the payment UI](/ru/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](/ru/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/ru/api/catalog/) - [Endpoint types](https://developers.xsolla.com/ru/api/catalog/) - [Errors handling](https://developers.xsolla.com/ru/api/catalog/) - [API keys](https://developers.xsolla.com/ru/api/catalog/) - [Webhooks](https://developers.xsolla.com/ru/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](/ru/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](/ru/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](/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-item) - [Create bundle](/ru/api/catalog/bundles-admin/admin-create-bundle) - [Create virtual currency](/ru/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](/ru/api/liveops/promotions-bonuses/create-bonus-promotion) - [Create daily reward](/ru/api/liveops/daily-chain-admin/admin-create-daily-chain) - [Create unique catalog offer promotion](/ru/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](/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items) - [Get item group list](/ru/api/catalog/virtual-items-currency-catalog/get-item-groups) - [Get list of bundles](/ru/api/catalog/bundles-catalog/get-bundle-list) - [Get sellable items list](/ru/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](/ru/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](/ru/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/ru/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](/ru/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](/ru/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](/ru/api/shop-builder/operation/put-item-by-cart-id/) API call. - To remove an item, use the [Delete cart item by cart ID](/ru/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](/ru/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](/ru/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](/ru/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](/ru/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](/ru/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking) - [short-polling](/ru/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](/ru/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](/ru/api/catalog/section/authentication) - [Payment testing](/ru/dev-resources/testing/general-info/#general_overview) - [Set up order status tracking](/ru/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?link=200-api#payments_integration_order_tracking) - [Webhooks](/ru/webhooks/overview) - [Rate limits](/ru/api/login/rate-limits) - [Errors handling](/ru/api/getting-started/#api_errors_handling) - [API keys](/ru/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](/ru/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](/ru/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 Для серверных методов используется схема аутентификации `basicAuth`. Все запросы к API должны содержать заголовок `Authorization: Basic `, где `your_authorization_basic_key` — пара `project_id:api_key`, закодированная по стандарту Base64. Вы можете использовать `merchant_id` вместо `project_id` при необходимости. Это не влияет на функциональность. Значения параметров вы можете найти в [Личном кабинете](https://publisher.xsolla.com/): * `merchant_id` отображается: * В разделе **Настройки компании > Компания** * В адресной строке браузера на любой странице Личного кабинета. 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 не включает в себя path-параметр `project_id`, используйте для авторизации ключ API, который действует во всех проектах. {% /html %} * `project_id` отображается: * В Личном кабинете рядом с названием проекта. * В адресной строке браузера при работе с проектом в Личном кабинете. URL-адрес имеет вид: `https://publisher.xsolla.com//projects/`. Подробная информация о работе с ключами API приведена в [справочнике API](https://developers.xsolla.com/ru/api/getting-started/#api_keys_overview). Type: http Scheme: basic ### XsollaLoginUserJWT Для клиентских методов используется схема аутентификации `XsollaLoginUserJWT`. Запрос должен содержать JWT пользователя в заголовке `Authorization` в формате Bearer ``. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным. Подробная информация о создании токена приведена в [документации Xsolla Login API](/ru/api/login/authentication-schemes#getting-user-token). В качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/ru/api/pay-station/token/create-token). Type: http Scheme: bearer Bearer Format: JWT ### AuthForCart Для продажи корзины используется схема аутентификации `AuthForCart`, которая поддерживает два режима: 1. Аутентификация с использованием JWT пользователя. Токен передается в заголовке Authorization в следующем формате: `Authorization: Bearer `, где `` — это токен пользователя. Токен идентифицирует пользователя и предоставляет доступ к персонализированным данным. В качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/ru/api/pay-station/token/create-token). 2. Упрощенный режим без заголовка `Authorization`. Он применяется только для неавторизованных пользователей и может быть использована только для [продажи игровых ключей](/ru/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Вместо токена в запрос передаются специальные заголовки: * `x-unauthorized-id` с ID запроса; * `x-user` с email пользователя, закодированным по стандарту Base64. Type: http Scheme: bearer ### basicMerchantAuth Для серверных методов используется схема аутентификации `basicMerchantAuth`. Все запросы к API должны содержать заголовок `Authorization: Basic `, где `your_authorization_basic_key` — пара `merchant_id:api_key`, закодированная по стандарту Base64. Значения параметров вы можете найти в [Личном кабинете](https://publisher.xsolla.com/): * `merchant_id` отображается: * В разделе **Настройки компании > Компания** * В адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид: `https://publisher.xsolla.com/` * `api_key` отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделе [Настройки компании > Ключи API](https://publisher.xsolla.com/0/settings/api_key). Подробная информация о работе с ключами API приведена в [справочнике API](https://developers.xsolla.com/ru/api/getting-started/#api_keys_overview). Type: http Scheme: basic ## Download OpenAPI description [Catalog API](https://xsolla.redocly.app/_bundle/@l10n/ru/api/catalog/index.yaml) ## Admin ### Получение списка виртуальных предметов - [GET /v2/project/{project_id}/admin/items/virtual_items](https://xsolla.redocly.app/ru/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/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-item.md): Создает виртуальный предмет. ### Получение списка виртуальных предметов по указанному External ID группы - [GET /v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}](https://xsolla.redocly.app/ru/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/ru/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/ru/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/ru/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/ru/api/catalog/virtual-items-currency-admin/admin-delete-virtual-item.md): Удаляет виртуальный предмет. ### Получение списка виртуальных валют - [GET /v2/project/{project_id}/admin/items/virtual_currency](https://xsolla.redocly.app/ru/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/ru/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/ru/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/ru/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/ru/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency.md): Удаляет виртуальную валюту. ### Получение списка пакетов виртуальной валюты (admin) - [GET /v2/project/{project_id}/admin/items/virtual_currency/package](https://xsolla.redocly.app/ru/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/ru/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/ru/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/ru/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/ru/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-package.md): Получает пакет виртуальной валюты в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ## Catalog ### Получение списка виртуальных предметов - [GET /v2/project/{project_id}/items/virtual_items](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items.md): Получает список виртуальных предметов для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. См. также: Метод Получение списка всех виртуальных предметов для поиска и индексирования на стороне клиента. ### Получение виртуального предмета по артикулу - [GET /v2/project/{project_id}/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items-sku.md): Получает виртуальный предмет по артикулу для построения каталога. Внимание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка всех виртуальных предметов - [GET /v2/project/{project_id}/items/virtual_items/all](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-all-virtual-items.md): Возвращает список всех виртуальных предметов для поиска на стороне клиента. Внимание Возвращаются только артикул товара, название, группы и описание. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. См. также: Метод Получение списка всех виртуальных предметов для поиска и индексирования на стороне клиента. ### Получение списка виртуальных валют - [GET /v2/project/{project_id}/items/virtual_currency](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency.md): Получает список виртуальных валют для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение виртуальной валюты по артикулу - [GET /v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency-sku.md): Получает виртуальную валюту по артикулу для построения каталога. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка пакетов виртуальной валюты - [GET /v2/project/{project_id}/items/virtual_currency/package](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package.md): Получает список пакетов виртуальной валюты для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение пакета виртуальной валюты по артикулу - [GET /v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-sku.md): Получает пакет виртуальной валюты по артикулу для построения каталога. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка товаров по указанной группе - [GET /v2/project/{project_id}/items/virtual_items/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items-group.md): Получает список товаров из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка виртуальных валют по указанной группе - [GET /v2/project/{project_id}/items/virtual_currency/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency-group.md): Возвращает список виртуальных валют из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка пакетов виртуальных валют по указанной группе - [GET /v2/project/{project_id}/items/virtual_currency/package/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-group.md): Возвращает список пакетов виртуальной валюты из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Виртуальная оплата ### Создание заказа с указанным товаром, приобретенным за виртуальную валюту - [POST /v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency.md): Создает покупку товара с использованием виртуальной валюты. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Catalog ### Получение списка игр - [GET /v2/project/{project_id}/items/game](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-games-list.md): Получает список игр для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка игр по указанной группе - [GET /v2/project/{project_id}/items/game/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-games-group.md): Получает список игр из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение игры для каталога - [GET /v2/project/{project_id}/items/game/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-game-by-sku.md): Получает игру для каталога. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение игрового ключа для каталога - [GET /v2/project/{project_id}/items/game/key/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-game-key-by-sku.md): Получает иговой ключ для каталога. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка игровых ключей по указанной группе - [GET /v2/project/{project_id}/items/game/key/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-game-keys-group.md): Получает список игровых ключей из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка платформ - [GET /v2/project/{project_id}/items/game/drm](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-drm-list.md): Получает список доступных платформ. ## Владение играми ### Получение списка игр, принадлежащих пользователю - [GET /v2/project/{project_id}/entitlement](https://xsolla.redocly.app/ru/api/catalog/game-keys-entitlement/get-user-games.md): Получает список игр, принадлежащих пользователю. Ответ будет содержать массив игр, принадлежащих определенному пользователю. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Активация игрового ключа на стороне клиента - [POST /v2/project/{project_id}/entitlement/redeem](https://xsolla.redocly.app/ru/api/catalog/game-keys-entitlement/redeem-game-pin-code.md): Дает право владения по предоставленному игровому коду. Notice You can redeem codes only for the DRM-free platform. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Предоставление права владения (admin) - [POST /v2/project/{project_id}/admin/entitlement/grant](https://xsolla.redocly.app/ru/api/catalog/game-keys-entitlement/grant-entitlement-admin.md): Дает пользователю право владения. ВниманиеМогут быть предоставлены только игровые ключи или игры для DRM-free-платформ. ### Отзыв права владения (admin) - [POST /v2/project/{project_id}/admin/entitlement/revoke](https://xsolla.redocly.app/ru/api/catalog/game-keys-entitlement/revoke-entitlement-admin.md): Отзывает право владения у пользователя. ВниманиеМогут быть отозваны только игровые ключи или игры для DRM-free-платформ. ## Admin ### Создание игры - [POST /v2/project/{project_id}/admin/items/game](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-create-game.md): Создает игру в проекте. ### Получение списка игр (admin) - [GET /v2/project/{project_id}/admin/items/game](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-get-game-list.md): Получает список игр в рамках проекта для администрирования. Игра состоит из игровых ключей, которые могут быть приобретены пользователем. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Получение игры (admin) - [GET /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-get-game-by-sku.md): Получает игру для администрирования. Игра состоит из игровых ключей, которые могут быть приобретены пользователем. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Обновление игры по артикулу - [PUT /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-update-game-by-sku.md): Обновляет игру в проекте по артикулу. ### Удаление игры по артикулу - [DELETE /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-delete-game-by-sku.md): Удаляет игру в проекте по артикулу. ### Получение игры по ID (admin) - [GET /v2/project/{project_id}/admin/items/game/id/{item_id}](https://xsolla.redocly.app/ru/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/ru/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/ru/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/ru/api/catalog/game-keys-admin/admin-upload-codes-by-sku.md): Загружает коды по артикулу игрового ключа. ### Загрузка кодов по ID - [POST /v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}](https://xsolla.redocly.app/ru/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/ru/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/ru/api/catalog/game-keys-admin/admin-get-codes-by-sku.md): Получает определенное количество кодов по артикулу игрового ключа. ### Получение кодов по ID - [GET /v2/project/{project_id}/admin/items/game/key/request/id/{item_id}](https://xsolla.redocly.app/ru/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/ru/api/catalog/game-keys-admin/admin-delete-codes-by-sku.md): Удаляет все коды по артикулу игрового ключа. ### Удаление кодов по ID - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-delete-codes-by-id.md): Удаляет все коды по ID игрового ключа. ## Admin ### Получение списка бандлов - [GET /v2/project/{project_id}/admin/items/bundle](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-get-bundle-list.md): Получает список бандлов в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Создание бандла - [POST /v2/project/{project_id}/admin/items/bundle](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-create-bundle.md): Creates a bundle — a set of items sold as a single unit. A bundle can contain virtual items, virtual currency packages, game keys, and other bundles. For more information, refer to the Bundles section. NoticeAll items in the content array must be created in your project in advance. The system returns an error if the specified SKU doesn't exist. ### Получение списка бандлов по указанному ID группы - [GET /v2/project/{project_id}/admin/items/bundle/group/id/{group_id}](https://xsolla.redocly.app/ru/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/ru/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/ru/api/catalog/bundles-admin/admin-update-bundle.md): Updates a bundle. This call fully replaces the bundle — pass all required fields in the request body, not only the fields you want to change. For more information, refer to the Bundles section. NoticeAll items in the content array must be created in your project in advance. The system returns an error if the specified SKU doesn't exist. ### Удаление бандла - [DELETE /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-delete-bundle.md): Удаляет бандл. ### Получение бандла - [GET /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-get-bundle.md): Получает бандл в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Отображение бандла в каталоге - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/show](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-show-bundle.md): Показывает бандл в каталоге. ### Скрытие бандла в каталоге - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-hide-bundle.md): Скрывает бандл в каталоге. ## Catalog ### Получение списка бандлов - [GET /v2/project/{project_id}/items/bundle](https://xsolla.redocly.app/ru/api/catalog/bundles-catalog/get-bundle-list.md): Получает список бандлов для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение указанного бандла - [GET /v2/project/{project_id}/items/bundle/sku/{sku}](https://xsolla.redocly.app/ru/api/catalog/bundles-catalog/get-bundle.md): Получает указанный бандл. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка бандлов по указанной группе - [GET /v2/project/{project_id}/items/bundle/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/bundles-catalog/get-bundle-list-in-group.md): Получает список бандлов в рамках группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Корзина (на стороне клиента) Используйте методы из этого подраздела для управления корзиной на стороне клиента. ### Получение корзины по ID корзины - [GET /v2/project/{project_id}/cart/{cart_id}](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/get-cart-by-id.md): Возвращает корзину пользователя по ID корзины. ### Получение корзины текущего пользователя - [GET /v2/project/{project_id}/cart](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/get-user-cart.md): Возвращает корзину текущего пользователя. ### Удаление всех товаров из корзины по ID корзины - [PUT /v2/project/{project_id}/cart/{cart_id}/clear](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/cart-clear-by-id.md): Удаляет все товары из корзины. ### Удаление всех товаров из текущей корзины - [PUT /v2/project/{project_id}/cart/clear](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/cart-clear.md): Удаляет все товары из корзины. ### Наполнение корзины товарами - [PUT /v2/project/{project_id}/cart/fill](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/cart-fill.md): Наполняет корзину товарами. Если в корзине уже есть товар с тем же артикулом, существующий товар будет заменен переданным значением. ### Наполнение определенной корзины товарами - [PUT /v2/project/{project_id}/cart/{cart_id}/fill](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/cart-fill-by-id.md): Наполняет определенную корзину товарами. Если в корзине уже есть товар с тем же артикулом, существующая позиция товара будет заменен переданным значением. ### Обновление товара в корзине по ID корзины - [PUT /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://xsolla.redocly.app/ru/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/ru/api/catalog/cart-client-side/delete-item-by-cart-id.md): Удаляет товар из корзины. ### Обновление товара из текущей корзины - [PUT /v2/project/{project_id}/cart/item/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/put-item.md): Обновляет уже имеющийся в корзине товар или создает его в корзине. ### Удаление товара из текущей корзины - [DELETE /v2/project/{project_id}/cart/item/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/delete-item.md): Удаляет товар из корзины. ## Корзина (на стороне сервера) Используйте методы из этого подраздела для управления корзиной на стороне сервера. ### Наполнение корзины товарами - [PUT /v2/admin/project/{project_id}/cart/fill](https://xsolla.redocly.app/ru/api/catalog/cart-server-side/admin-cart-fill.md): Заполняет текущую корзину товарами. Если в корзине уже есть товар с таким же артикулом, существующий товар будет заменен на переданное значение. ### Наполнение корзины по ID корзины товарами - [PUT /v2/admin/project/{project_id}/cart/{cart_id}/fill](https://xsolla.redocly.app/ru/api/catalog/cart-server-side/admin-fill-cart-by-id.md): Заполняет корзину товарами по идентификатору корзины. Если в корзине уже есть товар с таким же артикулом, существующий товар будет заменен на переданное значение. ## Оплата (на стороне клиента) Используйте методы из этого подраздела для формирования платежного токена на стороне клиента. ### Создание заказа со всеми товарами из определенной корзины - [POST /v2/project/{project_id}/payment/cart/{cart_id}](https://xsolla.redocly.app/ru/api/catalog/payment-client-side/create-order-by-cart-id.md): Используется для интеграции клиент-сервер. Создает заказ со всеми товарами из конкретной корзины и генерирует для него токен оплаты. Созданный заказ получает статус заказа new. IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа. Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен. Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Внимание Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station. ### Создание заказа со всеми товарами из текущей корзины - [POST /v2/project/{project_id}/payment/cart](https://xsolla.redocly.app/ru/api/catalog/payment-client-side/create-order.md): Используется для интеграции клиент-сервер. Создает заказ со всеми товарами из корзины и генерирует для него токен оплаты. Созданный заказ получает new статус заказа. IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа. Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен. Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Внимание Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station. ### Создание заказа с указанным товаром - [POST /v2/project/{project_id}/payment/item/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/payment-client-side/create-order-with-item.md): Используется для интеграции клиент-сервер. Создает заказ с указанным товаром и генерирует для него токен оплаты. Созданный заказ получает статус заказа new. IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа. Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен. Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Внимание Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station. Уведомление Этот метод использует JWT пользователя для авторизации. Передайте токен в заголовке Authorization в формате Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Оплата (на стороне сервера) Используйте методы из этого подраздела для формирования платежного токена на стороне сервера. ### Создание платежного токена для покупки - [POST /v3/project/{project_id}/admin/payment/token](https://xsolla.redocly.app/ru/api/catalog/payment-server-side/admin-create-payment-token.md): Генерирует заказ и платежный токен для него. Заказ генерируется на основе товаров, переданных в теле запроса. Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен. Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Внимание Параметр user.country.value используется для выбора валюты для заказа. Если страна пользователя неизвестна, альтернативным вариантом является указание IP-адреса пользователя в X-User-Ip заголовке. Для корректной работы метода требуется один из этих двух вариантов. Выбранная валюта используется для оплаты в Pay Station. ## Заказ Используйте методы из этого раздела для получения информации о заказах. ### Получение заказа - [GET /v2/project/{project_id}/order/{order_id}](https://xsolla.redocly.app/ru/api/catalog/order/get-order.md): Получает указанный заказ. ### Получение списка заказов за указанный период - [POST /v3/project/{project_id}/admin/order/search](https://xsolla.redocly.app/ru/api/catalog/order/admin-order-search.md): Возвращает список заказов, упорядоченный по дате создания — от самой ранней до самой поздней. ## Бесплатные товары Используйте методы из этого подраздела для начисления бесплатных товаров пользователям. ### Создание заказа с помощью бесплатной корзины - [POST /v2/project/{project_id}/free/cart](https://xsolla.redocly.app/ru/api/catalog/free-item/create-free-order.md): Создает заказ со всеми товарами из бесплатной корзины. Созданному заказу будет присвоен статус заказа done. ### Создание заказа с помощью определенной бесплатной корзины - [POST /v2/project/{project_id}/free/cart/{cart_id}](https://xsolla.redocly.app/ru/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/ru/api/catalog/free-item/create-free-order-with-item.md): Создает заказ с указанным бесплатным товаром. Созданному заказу будет присвоен статус заказа done. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Управление ### Обновление всех лимитов на покупку для пользователя - [DELETE /v2/project/{project_id}/admin/user/limit/item/all](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/reset-all-user-items-limit.md): Обновляет все лимиты на покупку для всех товаров для указанного пользователя, чтобы он мог приобрести эти товары снова. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ### Обновление лимита на покупку - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/reset-user-item-limit.md): Обновляет лимит на покупку товара, чтобы пользователь мог купить его снова. Если параметр user равен null, этот метод обновляет лимит для всех пользователей. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ### Получение лимита доступных пользователю товаров - [GET /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/get-user-item-limit.md): Возвращает оставшееся количество товаров, доступных указанному пользователю, в пределах установленного лимита. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ### Увеличение лимита доступных пользователю товаров - [POST /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/add-user-item-limit.md): Увеличивает оставшееся количество товаров, доступных указанному пользователю, в пределах установленного ограничения. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ### Настройка лимита доступных пользователю товаров - [PUT /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/set-user-item-limit.md): Устанавливает количество товаров, которые указанный пользователь может купить в пределах ограничения, примененного после его увеличения или уменьшения. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ### Уменьшение лимита доступных пользователю товаров - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/remove-user-item-limit.md): Уменьшает оставшееся количество товаров, доступных указанному пользователю в пределах установленного лимита. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ## Admin ### Импорт товаров из JSON-файла - [POST /v1/projects/{project_id}/import/from_external_file](https://xsolla.redocly.app/ru/api/catalog/connector-admin/import-items-from-external-file.md): Импортирует товары в магазин из JSON-файла по указанному URL-адресу. Подробная информация об импорте из JSON-файла приведена в документации. ### Получение статуса импорта товаров - [GET /v1/admin/projects/{project_id}/connectors/import_items/import/status](https://xsolla.redocly.app/ru/api/catalog/connector-admin/get-items-import-status.md): Возвращает информацию о прогрессе импорта товаров в проект. Метод возвращает данные по последнему импорту,  выполненному через API или Личный кабинет. ## Предзаказы ### Получение информации о лимите предзаказа товара - [GET /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/common-pre-orders/get-pre-order-limit.md): Возвращает ограничение на предзаказ товара. Pre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Алиасы для данного эндпоинта: * /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/ru/api/catalog/common-pre-orders/add-pre-order-limit.md): Добавляет количество к ограничению на предзаказ товара. Pre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Алиасы для данного эндпоинта: * /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/ru/api/catalog/common-pre-orders/set-pre-order-limit.md): Устанавливает ограничение на количество товара для предварительного заказа. Pre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Алиасы для данного эндпоинта: * /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/ru/api/catalog/common-pre-orders/remove-pre-order-limit.md): Удаляет ограничение на количество предзаказа товара. Pre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Алиасы для данного эндпоинта: * /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/ru/api/catalog/common-pre-orders/toggle-pre-order-limit.md): Включает/отключает лимит предзаказа товара. Pre-Order limit 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/ru/api/catalog/common-pre-orders/remove-all-pre-order-limit.md): Удаляет все ограничения по количеству товара, предусмотренные для предварительного заказа. Pre-Order limit API позволяет вам продавать товар в ограниченном количестве. Для настройки самого предварительного заказа перейдите в раздел администратора модуля нужного товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Aliases для этой конечной точки: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all ## Продавец ### Получение проектов - [GET /v2/merchant/{merchant_id}/projects](https://xsolla.redocly.app/ru/api/catalog/common-merchant/get-projects.md): Получает список проектов мерчанта. Внимание Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах. ## Catalog Данный API позволяет получать продаваемые товары любого вида или конкретный товар. ### Получение списка продаваемых товаров - [GET /v2/project/{project_id}/items](https://xsolla.redocly.app/ru/api/catalog/common-catalog/get-sellable-items.md): Получает список продаваемых товаров для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение продаваемого товара по ID - [GET /v2/project/{project_id}/items/id/{item_id}](https://xsolla.redocly.app/ru/api/catalog/common-catalog/get-sellable-item-by-id.md): Получает продаваемый товар по его ID. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение продаваемого товара по артикулу - [GET /v2/project/{project_id}/items/sku/{sku}](https://xsolla.redocly.app/ru/api/catalog/common-catalog/get-sellable-item-by-sku.md): Получает продаваемый товар по артикулу для построения каталога. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка продаваемых товаров по указанной группе - [GET /v2/project/{project_id}/items/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/common-catalog/get-sellable-items-group.md): Получает список продаваемых товаров из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Общие регионы Региональные ограничения продаж позволяют управлять доступностью товаров в отдельных странах или группах стран. Например, можно продавать игру только в определенных странах из-за лицензионных ограничений. Для настройки ограничений используются регионы. Каждый из них объединяет одну или несколько стран под одним идентификатором `region_id`. Товар может быть привязан к одному или нескольким регионам. Доступность товара определяется следующим образом: * Если у товара не указаны регионы — он доступен для покупки во всех странах. * Если у товара указаны регионы, и страна пользователя входит в один из них — товар доступен для этого пользователя. * Если у товара указаны регионы, и страна пользователя не входит ни в один из них — товар недоступен для этого пользователя. Страна пользователя передается в параметре `country` при запросе каталога через методы подраздела **Catalog**. Если параметр не передан, страна будет определена на основе IP-адреса пользователя. Соответствие страны пользователя региону товара проверяется дважды: при запросе каталога и при создании заказа. Недоступные товары не попадают в ответ каталога, а заказ с таким товаром не будет создан. Используйте методы группы **Общие регионы** для создания, изменения и удаления регионов. Сценарий настройки региональных ограничений продаж: 1. Создайте регион с помощью метода API [Создание региона](https://developers.xsolla.com/ru/api/catalog/common-regions/admin-create-region/), указав список стран. Метод возвращает `region_id`, который понадобится на следующем шаге. 2. Привяжите виртуальный товар к региону, передав его `region_id` в массиве `regions` при [создании](https://developers.xsolla.com/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-item/) или [обновлении](https://developers.xsolla.com/ru/api/catalog/virtual-items-currency-admin/admin-update-virtual-item/) товара. 3. Отобразите пользователю каталог, используя методы подраздела **Catalog**, например с помощью метода API [Получение списка виртуальных предметов](https://developers.xsolla.com/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items). Страна пользователя определяется по параметру `country`, а если он не передан — по IP-адресу. Товары, недоступные в стране пользователя, не попадут в ответ каталога. 4. При переходе пользователя к оплате товара или корзины сформируйте заказ: * если товар был добавлен в корзину — с помощью метода API [Создание заказа со всеми товарами из определенной корзины](https://developers.xsolla.com/ru/api/catalog/payment-client-side/create-order) или [Создание заказа со всеми товарами из текущей корзины](https://developers.xsolla.com/ru/api/catalog/payment-client-side/create-order); * для быстрой покупки одного товара — с помощью метода API [Создание заказа с указанным товаром](https://developers.xsolla.com/ru/api/catalog/payment-client-side/create-order-with-item), передав артикул товара. В ответе вы получите токен для открытия платежного интерфейса.
Примечание

Xsolla проверяет, входит ли страна пользователя в регион, указанный у товара. Если страна не входит в регион товара, создание заказа будет недоступно.

5. Реализуйте открытие платежного интерфейса для оплаты заказа. ![Common regions](https://cdn.xsolla.net/developers/current/images/api_docs/api-regions.svg) ### Получение списка регионов - [GET /v2/project/{project_id}/admin/region](https://xsolla.redocly.app/ru/api/catalog/common-regions/admin-get-regions.md): Получает список регионов. Вы можете использовать регион для управления вашими региональными ограничениями. ### Создание региона - [POST /v2/project/{project_id}/admin/region](https://xsolla.redocly.app/ru/api/catalog/common-regions/admin-create-region.md): Создает регион. Вы можете использовать регион для управления вашими региональными ограничениями. ### Получение региона - [GET /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/ru/api/catalog/common-regions/admin-get-region.md): Получает определенный регион. Вы можете использовать регион для управления вашими региональными ограничениями. ### Обновление региона - [PUT /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/ru/api/catalog/common-regions/admin-update-region.md): Обновляет определенный регион. Вы можете использовать регион для управления вашими региональными ограничениями. ### Удаление региона - [DELETE /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/ru/api/catalog/common-regions/admin-delete-region.md): Удаляет определенный регион. ## Вебхуки ### Обновление версии вебхука - [PUT /v2/project/{project_id}/admin/webhook/version](https://xsolla.redocly.app/ru/api/catalog/common-webhooks/update-webhook-version.md): Обновляет версию вебхуков в проекте. Для версии 2 в массиве items появляются дополнительные параметры. Подробная информация о настройке вебхуков доступна в разделе Отслеживание статуса заказа. ## Admin ### Получение списка атрибутов (admin) - [GET /v2/project/{project_id}/admin/attribute](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-get-attribute-list.md): Получает список атрибутов из проекта для администрирования. ### Создание атрибута - [POST /v2/project/{project_id}/admin/attribute](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-create-attribute.md): Создает атрибут. ### Обновление атрибута - [PUT /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-update-attribute.md): Обновляет атрибут. ### Получение указанного атрибута - [GET /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-get-attribute.md): Получает указанный атрибут. ### Удаление атрибута - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/delete-attribute.md): Удаляет атрибут. ВниманиеЕсли вы удалите атрибут товара, все его данные и связи с товарами будут удалены. ### Создание значения атрибута - [POST /v2/project/{project_id}/admin/attribute/{external_id}/value](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-create-attribute-value.md): Создает значение атрибута. ВниманиеВсе проекты имеют ограничение на количество значений атрибута. Значение по умолчанию и максимальное значение — 20 значений для каждого атрибута. ### Удаление всех значений атрибута - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-delete-all-attribute-value.md): Удаляет все значения атрибута. ВниманиеЕсли вы удалите значение атрибута, связь атрибута с товарами будет потеряна. Чтобы изменить значение атрибута для товара, используйте метод Обновление значения атрибута вместо удаления значения и создания нового. ### Обновление значения атрибута - [PUT /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://xsolla.redocly.app/ru/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/ru/api/catalog/attribute-admin/admin-delete-attribute-value.md): Удаляет значение атрибута. ВниманиеЕсли вы удалите значение атрибута, связь атрибута с товарами будет потеряна. Чтобы изменить значение атрибута для товара, используйте метод Обновление значения атрибута вместо удаления значения и создания нового. ## Admin ### Получение списка групп товаров - [GET /v2/project/{project_id}/admin/items/groups](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-get-item-group-list.md): Возвращает полный список групп товаров в рамках проекта без пагинации. Предназначен для административных задач. ПримечаниеНе используйте этот метод для построения каталога магазина. Вместо этого используйте клиентский метод Получение списка групп товаров. ### Создание группы товаров - [POST /v2/project/{project_id}/admin/items/groups](https://xsolla.redocly.app/ru/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/ru/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/ru/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/ru/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/ru/api/catalog/item-groups-admin/admin-get-item-group-list-by-item-type.md): Возвращает список групп товаров с фильтрацией по типу товаров. Для групп подсчитывается только количество товаров, соответствующих заданному типу.Аналог метода Получение списка групп товаров 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/ru/api/catalog/item-groups-admin/admin-get-item-group-by-item-type.md): Возвращает группу товаров по внешнему ID. Для группы подсчитывается только количество товаров, соответствующих заданному типу. Аналог метода Получение списка групп товаров по внешнему ID с дополнительной фильтрацией товаров по типу при подсчете их количества. ### Изменение порядка групп товаров - [PUT /v2/project/{project_id}/admin/group/order](https://xsolla.redocly.app/ru/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/ru/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/ru/api/catalog/item-groups-admin/admin-reorder-items-in-group-by-id.md): Задает порядок отображения товаров в группе, определяемой ее внутренним числовым ID. Передайте массив товаров с новыми значениями порядка. ## Catalog ### Получение списка групп товаров - [GET /v2/project/{project_id}/items/groups](https://xsolla.redocly.app/ru/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.