# 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/pt/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](/pt/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. Alternativamente, você pode usar um [token para abrir a interface de pagamento](/pt/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](/pt/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](/pt/api/getting-started/#api_keys_overview). ## Authentication with guest access support O esquema de autenticação `AuthForCart` é utilizado para as compras de carrinhos e suporta dois modos: 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](/pt/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](/pt/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/pt/api/catalog/) - [Endpoint types](https://developers.xsolla.com/pt/api/catalog/) - [Errors handling](https://developers.xsolla.com/pt/api/catalog/) - [API keys](https://developers.xsolla.com/pt/api/catalog/) - [Webhooks](https://developers.xsolla.com/pt/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](/pt/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](/pt/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](/pt/api/catalog/virtual-items-currency-admin/admin-create-virtual-item) - [Create bundle](/pt/api/catalog/bundles-admin/admin-create-bundle) - [Create virtual currency](/pt/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](/pt/api/liveops/promotions-bonuses/create-bonus-promotion) - [Create daily reward](/pt/api/liveops/daily-chain-admin/admin-create-daily-chain) - [Create unique catalog offer promotion](/pt/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](/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items) - [Get item group list](/pt/api/catalog/virtual-items-currency-catalog/get-item-groups) - [Get list of bundles](/pt/api/catalog/bundles-catalog/get-bundle-list) - [Get sellable items list](/pt/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](/pt/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](/pt/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/pt/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](/pt/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](/pt/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](/pt/api/shop-builder/operation/put-item-by-cart-id/) API call. - To remove an item, use the [Delete cart item by cart ID](/pt/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](/pt/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](/pt/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](/pt/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](/pt/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](/pt/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking) - [short-polling](/pt/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](/pt/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](/pt/api/catalog/section/authentication) - [Payment testing](/pt/dev-resources/testing/general-info/#general_overview) - [Set up order status tracking](/pt/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?link=200-api#payments_integration_order_tracking) - [Webhooks](/pt/webhooks/overview) - [Rate limits](/pt/api/login/rate-limits) - [Errors handling](/pt/api/getting-started/#api_errors_handling) - [API keys](/pt/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](/pt/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](/pt/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 Chamadas do lado do servidor usam o esquema de autenticação `basicAuth`. Todas as solicitações para a API devem conter o cabeçalho `Authorization: Basic `, onde `your_authorization_basic_key` é o par `project_id:api_key` codificado de acordo com o padrão Base64. Você pode usar `merchant_id` em vez de `project_id` se precisar. Isso não afeta a funcionalidade. Vá para a [Conta de Distribuidor](https://publisher.xsolla.com/) para encontrar valores dos parâmetros: * `merchant_id` é mostrado: * Na seção **Configurações da empresa > Empresa** * No URL na barra de endereço do navegador em qualquer página da Conta de Distribuidor. O URL tem o seguinte formato: `https://publisher.xsolla.com/`. * `api_key` é mostrado na Conta de Distribuidor apenas uma vez quando é criado e deve ser armazenado do seu lado. Você pode criar uma nova chave na seguinte seção: * [Configurações da empresa > Chaves de API](https://publisher.xsolla.com/0/settings/api_key) * [Configurações do projeto > Chaves de API](https://publisher.xsolla.com/0/projects/0/edit/api_key) {% html name="div" attrs={"class": "notice"} %} **Aviso** Se uma chamada de API necessária não incluir o parâmetro de caminho `project_id`, use uma chave de API que seja válida em todos os projetos da empresa para autorização. {% /html %} * `project_id` é mostrado: * Na Conta de Distribuidor ao lado do nome do projeto. * No URL na barra de endereço do navegador ao trabalhar no projeto na Conta de Distribuidor. O URL tem o seguinte formato: `https://publisher.xsolla.com//projects/`. Para obter mais informações sobre como trabalhar com chaves API, consulte a [Referência de API](https://developers.xsolla.com/pt/api/getting-started/#api_keys_overview). Type: http Scheme: basic ### XsollaLoginUserJWT Chamadas do lado do cliente usam o esquema de autenticação `XsollaLoginUserJWT`. A solicitação deve incluir o JWT do usuário no cabeçalho `Authorization` no seguinte formato: Portador ``. O token identifica o usuário e fornece acesso a dados personalizados. Para mais detalhes sobre como criar um token, consulte a [documentação Xsolla Login API](/pt/api/login/authentication-schemes#getting-user-token). Alternativamente, você pode usar um [token para abrir a interface de pagamento](/pt/api/pay-station/token/create-token). Type: http Scheme: bearer Bearer Format: JWT ### AuthForCart O esquema de autenticação `AuthForCart` é utilizado para as compras de carrinhos e suporta dois modos: 1. Autenticação com o JWT de um usuário. O token é passado no cabeçalho de autorização no seguinte formato: `Authorization: Bearer `, onde `` é o token do usuário. O token identifica o usuário e fornece acesso a dados personalizados. Alternativamente, você pode usar um [token para abrir a interface de pagamento](/pt/api/pay-station/token/create-token). 2. Modo simplificado sem o cabeçalho `Authorization`. Esse modo é usado apenas para usuários não autorizados e pode ser aplicado apenas para [vender chaves de jogo](/pt/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Em vez de um token, a solicitação deve incluir os seguintes cabeçalhos: * `x-unauthorized-id` com um ID de solicitação * `x-user` com o endereço de e-mail do usuário codificado em Base64. Type: http Scheme: bearer ### basicMerchantAuth Chamadas do lado do servidor usam o esquema de autenticação `basicMerchantAuth`. Todas as solicitações para a API devem conter o cabeçalho `Authorization: Basic `, onde `your_authorization_basic_key` é o par `merchant_id:api_key` codificado de acordo com o padrão Base64. Vá para a [Conta de Distribuidor](https://publisher.xsolla.com/) para encontrar valores dos parâmetros: * `merchant_id` é mostrado: * Na seção **Configurações da empresa > Empresa** * No URL na barra de endereço do navegador em qualquer página da Conta de Distribuidor. O URL tem o seguinte formato: `https://publisher.xsolla.com/` * `api_key` é mostrado na Conta de Distribuidor apenas uma vez quando é criado e deve ser armazenado do seu lado. Você pode criar uma nova chave na seção [Configurações da empresa > Chaves de API](https://publisher.xsolla.com/0/settings/api_key). Para obter mais informações sobre como trabalhar com chaves API, consulte a [Referência de API](https://developers.xsolla.com/pt/api/getting-started/#api_keys_overview). Type: http Scheme: basic ## Download OpenAPI description [Catalog API](https://xsolla.redocly.app/_bundle/@l10n/pt/api/catalog/index.yaml) ## Admin ### Obter lista de itens virtuais - [GET /v2/project/{project_id}/admin/items/virtual_items](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list.md): Obtém a lista de itens virtuais dentro de um projeto para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Criar item virtual - [POST /v2/project/{project_id}/admin/items/virtual_items](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-create-virtual-item.md): Cria um item virtual. ### Obter lista de itens virtuais por ID de grupo especificado externo - [GET /v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-external-id.md): Obtém a lista de itens virtuais dentro de um grupo para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Obter lista de itens virtuais por ID de grupo especificado - [GET /v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-id.md): Obtém a lista de itens virtuais dentro de um grupo para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Obter item virtual - [GET /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-get-virtual-item.md): Obtém o item virtual dentro de um projeto para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Atualizar item virtual - [PUT /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-update-virtual-item.md): Atualiza um item virtual. ### Excluir item virtual - [DELETE /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-delete-virtual-item.md): Exclui um item virtual. ### Obter lista de moedas virtuais - [GET /v2/project/{project_id}/admin/items/virtual_currency](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-get-virtual-currencies-list.md): Obtém a lista de moedas virtuais dentro de um projeto para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Criar moeda virtual - [POST /v2/project/{project_id}/admin/items/virtual_currency](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency.md): Cria uma moeda virtual. ### Obter moeda virtual - [GET /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency.md): Obtém a moeda virtual dentro de um projeto para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Atualizar moeda virtual - [PUT /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency.md): Atualiza uma moeda virtual. ### Excluir moeda virtual - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency.md): Exclui uma moeda virtual. ### Obter lista de pacotes de moedas virtuais (admin) - [GET /v2/project/{project_id}/admin/items/virtual_currency/package](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-packages-list.md): Obtém a lista de pacotes de moedas virtuais dentro de um projeto para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Criar pacote de moedas virtuais - [POST /v2/project/{project_id}/admin/items/virtual_currency/package](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency-package.md): Cria um pacote de moedas virtuais. ### Atualizar pacote de moedas virtuais - [PUT /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency-package.md): Atualiza um pacote de moedas virtuais. ### Excluir pacote de moedas virtuais - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency-package.md): Exclui um pacote de moedas virtuais. ### Obter pacote de moedas virtuais - [GET /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-package.md): Obtém o pacote de moedas virtuais dentro de um projeto para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ## Catálogo ### Obter lista de itens virtuais - [GET /v2/project/{project_id}/items/virtual_items](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items.md): Recebe uma lista de itens virtuais para montar um catálogo. Aviso Todos os projetos têm a limitação do número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. Veja também: A chamada de API Obter lista de todos os itens virtuais para busca ou indexação no lado do cliente. ### Obter item virtual por SKU - [GET /v2/project/{project_id}/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items-sku.md): Obtém um item virtual por SKU para criar um catálogo. Aviso Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados de usuário personalizados, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, veja o bloco de Segurança para esta chamada. ### Obter toda a lista de itens virtuais - [GET /v2/project/{project_id}/items/virtual_items/all](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-catalog/get-all-virtual-items.md): Obtém uma lista de todos os itens virtuais para busca no lado do cliente. Aviso Retorna apenas SKU do item, nome, grupos e descrição. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. Veja também: A chamada de API Obter lista de itens virtuais para recuperar dados detalhados do item com paginação. ### Obter lista de moedas virtuais - [GET /v2/project/{project_id}/items/virtual_currency](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-catalog/get-virtual-currency.md): Recebe uma lista de moedas virtuais para montar um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter moeda virtual por SKU - [GET /v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-catalog/get-virtual-currency-sku.md): Obtém uma moeda virtual por SKU para criar um catálogo. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter lista de pacotes de moedas virtuais - [GET /v2/project/{project_id}/items/virtual_currency/package](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package.md): Recebe uma lista de pacotes de moedas virtuais para montar um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter pacote de moedas virtuais por SKU - [GET /v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-sku.md): Obtém pacotes de moedas virtuais por SKU para criar um catálogo. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter lista de itens por grupo especificado - [GET /v2/project/{project_id}/items/virtual_items/group/{external_id}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items-group.md): Obtém uma lista de itens do grupo especificado para criar um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter lista de moedas virtuais por grupos especificados - [GET /v2/project/{project_id}/items/virtual_currency/group/{external_id}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-catalog/get-virtual-currency-group.md): Recupera uma lista de moedas virtuais do grupo especificado para construir um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter lista de pacotes de moedas virtuais por grupo especificado - [GET /v2/project/{project_id}/items/virtual_currency/package/group/{external_id}](https://xsolla.redocly.app/pt/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-group.md): Recupera uma lista de pacotes de moedas virtuais do grupo especificado para construir um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ## Pagamento virtual ### Criar pedido com item especificado comprado por moeda virtual - [POST /v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}](https://xsolla.redocly.app/pt/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency.md): Cria compra de item usando moeda virtual. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ## Catálogo ### Obter lista de jogos - [GET /v2/project/{project_id}/items/game](https://xsolla.redocly.app/pt/api/catalog/game-keys-catalog/get-games-list.md): Recebe uma lista de jogos para montar um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter lista de jogos por grupo especificado - [GET /v2/project/{project_id}/items/game/group/{external_id}](https://xsolla.redocly.app/pt/api/catalog/game-keys-catalog/get-games-group.md): Recebe uma lista de jogos do grupo especificado para montar um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter jogo para catálogo - [GET /v2/project/{project_id}/items/game/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/game-keys-catalog/get-game-by-sku.md): Obtém um jogo para o catálogo. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter chave de jogo para catálogo - [GET /v2/project/{project_id}/items/game/key/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/game-keys-catalog/get-game-key-by-sku.md): Obtém uma chave de jogo para o catálogo. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter lista de chaves de jogo por grupo especificado - [GET /v2/project/{project_id}/items/game/key/group/{external_id}](https://xsolla.redocly.app/pt/api/catalog/game-keys-catalog/get-game-keys-group.md): Recebe uma lista de chaves de jogo do grupo especificado para montar um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter lista de DRM - [GET /v2/project/{project_id}/items/game/drm](https://xsolla.redocly.app/pt/api/catalog/game-keys-catalog/get-drm-list.md): Obtém a lista de DRMs disponíveis. ## Direito ### Obter lista de jogos de propriedade do usuário - [GET /v2/project/{project_id}/entitlement](https://xsolla.redocly.app/pt/api/catalog/game-keys-entitlement/get-user-games.md): Obtenha a lista de jogos de propriedade do usuário. A resposta conterá uma matriz de jogos de propriedade de um usuário específico. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Resgatar código de jogo por cliente - [POST /v2/project/{project_id}/entitlement/redeem](https://xsolla.redocly.app/pt/api/catalog/game-keys-entitlement/redeem-game-pin-code.md): Concede o direito por um código de jogo fornecido. Aviso Você pode resgatar códigos apenas para a plataforma sem DRM. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Direito à concessão (admin) - [POST /v2/project/{project_id}/admin/entitlement/grant](https://xsolla.redocly.app/pt/api/catalog/game-keys-entitlement/grant-entitlement-admin.md): Concede direito ao usuário. AtençãoCódigos de jogos ou jogos para plataformas sem DRM podem ser apenas concedidos. ### Revogar direito (admin) - [POST /v2/project/{project_id}/admin/entitlement/revoke](https://xsolla.redocly.app/pt/api/catalog/game-keys-entitlement/revoke-entitlement-admin.md): Revoga o direito do usuário. AtençãoCódigos de jogos ou jogos para plataformas sem DRM podem ser apenas revogados. ## Admin ### Criar jogo - [POST /v2/project/{project_id}/admin/items/game](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-create-game.md): Cria um jogo no projeto. ### Obter lista de jogos (admin) - [GET /v2/project/{project_id}/admin/items/game](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-get-game-list.md): Obtém a lista de jogos dentro de um projeto para administração. O jogo consiste em chaves de jogo que podem ser compradas por um usuário. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Obter jogo (admin) - [GET /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-get-game-by-sku.md): Recebe um jogo para administração. O jogo consiste em chaves de jogo que podem ser compradas por um usuário. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Atualizar jogo por SKU - [PUT /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-update-game-by-sku.md): Atualiza um jogo no projeto por SKU. ### Excluir jogo por SKU - [DELETE /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-delete-game-by-sku.md): Exclui um jogo no projeto por SKU. ### Obter jogo por ID (admin) - [GET /v2/project/{project_id}/admin/items/game/id/{item_id}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-get-game-by-id.md): Recebe um jogo para administração. O jogo consiste em chaves de jogo que podem ser compradas por um usuário. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Atualizar jogo por ID - [PUT /v2/project/{project_id}/admin/items/game/id/{item_id}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-update-game-by-id.md): Atualiza um jogo no projeto por ID. ### Excluir jogo por ID - [DELETE /v2/project/{project_id}/admin/items/game/id/{item_id}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-delete-game-by-id.md): Exclui um jogo no projeto por ID. ### Carregar códigos - [POST /v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-upload-codes-by-sku.md): Carrega códigos por SKU de chave de jogo. ### Carregar códigos por ID - [POST /v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-upload-codes-by-id.md): Carrega códigos por ID de chave de jogo. ### Obter códigos carregando informações da sessão - [GET /v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-get-codes-session.md): Obtém códigos carregando informações de sessão. ### Obter códigos - [GET /v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-get-codes-by-sku.md): Obtém um certo número de códigos por SKU de chave de jogo. ### Obter códigos por ID - [GET /v2/project/{project_id}/admin/items/game/key/request/id/{item_id}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-get-codes-by-id.md): Obtém um certo número de códigos por ID de chave de jogo. ### Excluir códigos - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-delete-codes-by-sku.md): Exclui todos os códigos por SKU de chave de jogo. ### Excluir códigos por ID - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}](https://xsolla.redocly.app/pt/api/catalog/game-keys-admin/admin-delete-codes-by-id.md): Exclui todos os códigos por ID de chave de jogo. ## Admin ### Obter lista de pacotes - [GET /v2/project/{project_id}/admin/items/bundle](https://xsolla.redocly.app/pt/api/catalog/bundles-admin/admin-get-bundle-list.md): Obtém a lista de pacotes dentro de um projeto para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Criar conjunto - [POST /v2/project/{project_id}/admin/items/bundle](https://xsolla.redocly.app/pt/api/catalog/bundles-admin/admin-create-bundle.md): Cria um conjunto — um conjunto de itens vendidos como uma única unidade. Um conjunto pode conter itens virtuais, pacotes de moedas virtuais, chaves de jogo e outros conjuntos. Para mais informações, consulte a seção Conjuntos. AvisoTodos os itens na matriz content devem ser criados no seu projeto antecipadamente. O sistema retorna um erro se o SKU especificado não existir. ### Obter lista de conjuntos por ID de grupo especificado - [GET /v2/project/{project_id}/admin/items/bundle/group/id/{group_id}](https://xsolla.redocly.app/pt/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-id.md): Obtém a lista de conjuntos dentro de um grupo para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Obter lista de conjuntos por ID de grupo externo especificado - [GET /v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}](https://xsolla.redocly.app/pt/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-external-id.md): Obtém a lista de conjuntos dentro de um grupo para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Conjunto de atualização - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/pt/api/catalog/bundles-admin/admin-update-bundle.md): Atualiza um conjunto. Essa chamada substitui totalmente o conjunto — passe todos os campos necessários no corpo da solicitação, não somente os campos que deseja alterar. Para mais informações, consulte a seção Conjuntos. AvisoTodos os itens na matriz content devem ser criados no seu projeto antecipadamente. O sistema retorna um erro se o SKU especificado não existir. ### Excluir conjunto - [DELETE /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/pt/api/catalog/bundles-admin/admin-delete-bundle.md): Exclui um conjunto. ### Obter conjunto - [GET /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/pt/api/catalog/bundles-admin/admin-get-bundle.md): Obtém o conjunto dentro de um projeto para administração. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. ### Mostrar conjunto no catálogo - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/show](https://xsolla.redocly.app/pt/api/catalog/bundles-admin/admin-show-bundle.md): Mostra um conjunto em um catálogo. ### Ocultar conjunto no catálogo - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide](https://xsolla.redocly.app/pt/api/catalog/bundles-admin/admin-hide-bundle.md): Oculta um conjunto em um catálogo. ## Catálogo ### Obter lista de pacotes - [GET /v2/project/{project_id}/items/bundle](https://xsolla.redocly.app/pt/api/catalog/bundles-catalog/get-bundle-list.md): Recebe uma lista de conjuntos para montar um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter pacote especificado - [GET /v2/project/{project_id}/items/bundle/sku/{sku}](https://xsolla.redocly.app/pt/api/catalog/bundles-catalog/get-bundle.md): Obtém um conjunto especificado. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter lista de pacotes por grupo especificado - [GET /v2/project/{project_id}/items/bundle/group/{external_id}](https://xsolla.redocly.app/pt/api/catalog/bundles-catalog/get-bundle-list-in-group.md): Recebe uma lista de conjuntos dentro de um grupo para montar um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ## Carrinho (lado do cliente) Use chamadas desta seção para gerenciar o carrinho no lado do cliente. ### Obter carrinho por ID de carrinho - [GET /v2/project/{project_id}/cart/{cart_id}](https://xsolla.redocly.app/pt/api/catalog/cart-client-side/get-cart-by-id.md): Devolve o carrinho do utilizador pelo ID de carrinho. ### Obter o carrinho do usuário atual - [GET /v2/project/{project_id}/cart](https://xsolla.redocly.app/pt/api/catalog/cart-client-side/get-user-cart.md): Retorna o carrinho do usuário atual. ### Excluir todos os itens do carrinho pelo ID de carrinho - [PUT /v2/project/{project_id}/cart/{cart_id}/clear](https://xsolla.redocly.app/pt/api/catalog/cart-client-side/cart-clear-by-id.md): Exclui todos os itens do carrinho. ### Excluir todos os itens do carrinho atual - [PUT /v2/project/{project_id}/cart/clear](https://xsolla.redocly.app/pt/api/catalog/cart-client-side/cart-clear.md): Exclui todos os itens do carrinho. ### Preencher o carrinho com itens - [PUT /v2/project/{project_id}/cart/fill](https://xsolla.redocly.app/pt/api/catalog/cart-client-side/cart-fill.md): Preenche o carrinho de itens. Se o carrinho já tiver um item com o mesmo SKU, o item existente será substituído pelo valor passado. ### Preencha o carrinho específico com itens - [PUT /v2/project/{project_id}/cart/{cart_id}/fill](https://xsolla.redocly.app/pt/api/catalog/cart-client-side/cart-fill-by-id.md): Preenche o carrinho específico com itens. Se o carrinho já tiver um item com o mesmo SKU, a posição do item existente será substituída pelo valor passado. ### Atualizar item do carrinho por ID de carrinho - [PUT /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/cart-client-side/put-item-by-cart-id.md): Atualiza um item de carrinho existente ou cria o item no carrinho. ### Excluir item de carrinho por ID de carrinho - [DELETE /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/cart-client-side/delete-item-by-cart-id.md): Remove um item do carrinho. ### Atualizar item do carrinho do carrinho atual - [PUT /v2/project/{project_id}/cart/item/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/cart-client-side/put-item.md): Atualiza um item de carrinho existente ou cria o item no carrinho. ### Excluir item do carrinho atual - [DELETE /v2/project/{project_id}/cart/item/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/cart-client-side/delete-item.md): Remove um item do carrinho. ## Carrinho (lado do servidor) Use chamadas desta seção para gerenciar o carrinho no lado do servidor. ### Preencher o carrinho com itens - [PUT /v2/admin/project/{project_id}/cart/fill](https://xsolla.redocly.app/pt/api/catalog/cart-server-side/admin-cart-fill.md): Preenche o carrinho atual com itens. Se o carrinho já tiver um item com o mesmo SKU, o item existente será substituído pelo valor passado. ### Preencha o ID do carrinho pelo carrinho com itens - [PUT /v2/admin/project/{project_id}/cart/{cart_id}/fill](https://xsolla.redocly.app/pt/api/catalog/cart-server-side/admin-fill-cart-by-id.md): Preenche o carrinho por ID de carrinho com itens. Se o carrinho já tiver um item com o mesmo SKU, o item existente será substituído pelo valor passado. ## Pagamento (lado do cliente) Use chamadas desta seção para criar um token de pagamento no lado do cliente. ### Criar pedido com todos os itens de um carrinho específico - [POST /v2/project/{project_id}/payment/cart/{cart_id}](https://xsolla.redocly.app/pt/api/catalog/payment-client-side/create-order-by-cart-id.md): Usado para a integração cliente-servidor. Cria um pedido com todos os itens do carrinho em particular e gera um token de pagamento para ele. O pedido criado obtém o status do pedido new. O IP do cliente é usado para determinar o país do usuário, que é usado para aplicar a moeda correspondente e os métodos de pagamento disponíveis para o pedido. Para abrir a interface de pagamento em uma nova janela, use o seguinte link: https://secure.xsolla.com/paystation4/?token={token}, onde {token} é o token recebido. Para fins de teste, use este URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Aviso Como esse método usa o IP para determinar o país do usuário e selecionar uma moeda para o pedido, é importante usar esse método apenas do lado do cliente e não do lado do servidor. Usar esse método do lado do servidor pode causar determinação incorreta da moeda e afetar os métodos de pagamento no Pay Station. ### Criar pedido com todos os itens do carrinho atual - [POST /v2/project/{project_id}/payment/cart](https://xsolla.redocly.app/pt/api/catalog/payment-client-side/create-order.md): Usado para a integração cliente-servidor. Cria um pedido com todos os itens do carrinho e gera um token de pagamento para ele. O pedido criado obtém o status do pedido new. O IP do cliente é usado para determinar o país do usuário, que é usado para aplicar a moeda correspondente e os métodos de pagamento disponíveis para o pedido. Para abrir a interface de pagamento em uma nova janela, use o seguinte link: https://secure.xsolla.com/paystation4/?token={token}, onde {token} é o token recebido. Para fins de teste, use este URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Aviso Como esse método usa o IP para determinar o país do usuário e selecionar uma moeda para o pedido, é importante usar esse método apenas do lado do cliente e não do lado do servidor. Usar esse método do lado do servidor pode causar determinação incorreta da moeda e afetar os métodos de pagamento no Pay Station. ### Criar pedido com item especificado - [POST /v2/project/{project_id}/payment/item/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/payment-client-side/create-order-with-item.md): Usado para a integração cliente-servidor. Cria um pedido com um item especificado e gera um token de pagamento para ele. O pedido criado recebe o status de pedido new. O IP do cliente é usado para determinar o país do usuário, que é usado para aplicar a moeda correspondente e os métodos de pagamento disponíveis para o pedido. Para abrir a interface de pagamento em uma nova janela, use o seguinte link: https://secure.xsolla.com/paystation4/?token={token}, onde {token} é o token recebido. Para fins de teste, use este URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Aviso Como esse método usa o IP para determinar o país do usuário e selecionar uma moeda para o pedido, é importante usar esse método apenas do lado do cliente e não do lado do servidor. Usar esse método do lado do servidor pode causar determinação incorreta da moeda e afetar os métodos de pagamento no Pay Station. Aviso Esta chamada de API usa um JWT de usuário para autorização. Inclua o token no cabeçalho Authorization no seguinte formato: Bearer <user_JWT>. Para mais informações sobre o JWT de usuário, veja o bloco Segurança para esta chamada. ## Pagamento (lado do servidor) Use chamadas desta seção para criar um token de pagamento no lado do servidor. ### Criar token de pagamento para compra - [POST /v3/project/{project_id}/admin/payment/token](https://xsolla.redocly.app/pt/api/catalog/payment-server-side/admin-create-payment-token.md): Gera um pedido e um token de pagamento para ele. O pedido é gerado com base nos itens passados no corpo da solicitação. Para abrir a interface de pagamento em uma nova janela, use o seguinte link: https://secure.xsolla.com/paystation4/?token={token}, onde {token} é o token recebido. Para fins de teste, use este URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Aviso O parâmetro user.country.value é usado para selecionar uma moeda para o pedido. Se o país do usuário é desconhecido, fornecer o IP do usuário no cabeçalho X-User-Ip é uma opção alternativa. Uma dessas duas opções é necessária para o trabalho correto desse método. A moeda selecionada é usada para métodos de pagamento no Pay Station. ## Pedido Use chamadas desta seção para obter informações sobre pedidos. ### Obter pedido - [GET /v2/project/{project_id}/order/{order_id}](https://xsolla.redocly.app/pt/api/catalog/order/get-order.md): Recupera uma ordem especificada. ### Obter lista de pedidos para o período especificado - [POST /v3/project/{project_id}/admin/order/search](https://xsolla.redocly.app/pt/api/catalog/order/admin-order-search.md): Recupera a lista de pedidos, organizada da data de criação mais antiga para a mais recente. ## Itens gratuitos Use calls from this section to grant free items to users. ### Criar pedido com carrinho grátis - [POST /v2/project/{project_id}/free/cart](https://xsolla.redocly.app/pt/api/catalog/free-item/create-free-order.md): Cria um pedido com todos os itens do carrinho gratuito. O pedido criado receberá um status de pedido done. ### Criar pedido com carrinho gratuito específico - [POST /v2/project/{project_id}/free/cart/{cart_id}](https://xsolla.redocly.app/pt/api/catalog/free-item/create-free-order-by-cart-id.md): Cria um pedido com todos os itens do carrinho gratuito específico. O pedido criado receberá um status de pedido done. ### Criar pedido com item gratuito especificado - [POST /v2/project/{project_id}/free/item/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/free-item/create-free-order-with-item.md): Cria um pedido com um item gratuito especificado. O pedido criado terá o status de pedido done. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ## Gestão ### Atualizar todos os limites de compra para o usuário especificado - [DELETE /v2/project/{project_id}/admin/user/limit/item/all](https://xsolla.redocly.app/pt/api/catalog/user-limits-admin/reset-all-user-items-limit.md): Atualiza todos os limites de compra em todos os itens para um usuário especificado para que ele possa comprar esses itens novamente. A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos ### Atualizar limite de compra - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all](https://xsolla.redocly.app/pt/api/catalog/user-limits-admin/reset-user-item-limit.md): Atualiza o limite de compra de um item para que um usuário possa comprá-lo novamente. Se o parâmetro user for null, essa chamada atualizará esse limite para todos os usuários. A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos ### Obtenha o número de itens disponíveis para o usuário especificado - [GET /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/user-limits-admin/get-user-item-limit.md): Obtém o número restante de itens disponíveis para o usuário especificado dentro do limite aplicado. A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos ### Aumente o número de itens disponíveis para o usuário especificado - [POST /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/user-limits-admin/add-user-item-limit.md): Aumenta o número restante de itens disponíveis para o usuário especificado dentro do limite aplicado. A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos ### Defina o número de itens disponíveis para o usuário especificado - [PUT /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/user-limits-admin/set-user-item-limit.md): Define o número de itens que o usuário especificado pode comprar dentro do limite aplicado depois que ele foi aumentado ou diminuído. A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos ### Diminuir o número de itens disponíveis para o usuário especificado - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/user-limits-admin/remove-user-item-limit.md): Diminui o número restante de itens disponíveis para o usuário especificado dentro do limite aplicado. A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos ## Admin ### Importar itens via arquivo JSON - [POST /v1/projects/{project_id}/import/from_external_file](https://xsolla.redocly.app/pt/api/catalog/connector-admin/import-items-from-external-file.md): Importa itens para a Store a partir de um arquivo JSON por meio da URL especificada. Consulte a documentação para obter mais informações sobre a importação de um arquivo JSON. ### Obter status da importação de itens - [GET /v1/admin/projects/{project_id}/connectors/import_items/import/status](https://xsolla.redocly.app/pt/api/catalog/connector-admin/get-items-import-status.md): Recupera informações sobre o andamento da importação de itens para o projeto. Essa chamada de API recupera dados da última importação realizada por meio da Conta de Distribuidor ou da API. ## Reservas ### Obter informações sobre o limite de pré-venda de itens - [GET /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/common-pre-orders/get-pre-order-limit.md): Obtenha o limite de pré-venda do item. A API Pre-Order limit permite que você venda um item em uma quantidade limitada. Para configurar a pré-venda em si, vá para a seção Admin do módulo do item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos Aliases para este ponto de extremidade: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### Adicionar quantidade ao limite de pré-venda do item - [POST /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/common-pre-orders/add-pre-order-limit.md): Adicione a quantidade ao limite de pré-venda do item. A API Pre-Order limit permite que você venda um item em uma quantidade limitada. Para configurar a pré-venda em si, vá para a seção Admin do módulo do item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos Aliases para este ponto de extremidade: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### Definir o limite de pré-venda da quantidade de item - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/common-pre-orders/set-pre-order-limit.md): Defina a quantidade do limite de pré-venda do item. A API Pre-Order limit permite que você venda um item em uma quantidade limitada. Para configurar a pré-venda em si, vá para a seção Admin do módulo do item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos Aliases para este ponto de extremidade: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### Remover a quantidade de limite de pré-venda do item - [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://xsolla.redocly.app/pt/api/catalog/common-pre-orders/remove-pre-order-limit.md): Remova a quantidade do limite de pré-venda do item. A API Pre-Order limit permite que você venda um item em uma quantidade limitada. Para configurar a pré-venda em si, vá para a seção Admin do módulo do item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos Aliases para este ponto de extremidade: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### Alternar o limite de pré-venda do item - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle](https://xsolla.redocly.app/pt/api/catalog/common-pre-orders/toggle-pre-order-limit.md): Ativar/desativar limite de pré-venda do item. A API Pre-Order limit permite que você venda um item em uma quantidade limitada. Para configurar a pré-venda em si, vá para a seção admin do módulo do item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos Aliases para este ponto de extremidade: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/toggle ### Remover toda a quantidade de limite de pré-venda do item - [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all](https://xsolla.redocly.app/pt/api/catalog/common-pre-orders/remove-all-pre-order-limit.md): Remova o limite de pré-venda do item. A API Pre-Order limit permite que você venda um item em uma quantidade limitada. Para configurar a pré-venda em si, vá para a seção admin do módulo do item desejado: * Chaves de Jogo * Itens e Moedas Virtuais * Conjuntos Aliases para este ponto de extremidade: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all ## Comerciante ### Obter projetos - [GET /v2/merchant/{merchant_id}/projects](https://xsolla.redocly.app/pt/api/catalog/common-merchant/get-projects.md): Obtém a lista de projetos do comerciante. AvisoEssa chamada de API não contém o trajeto de parâmetro project_id, portanto, você precisa usar a chave API que é válida em todos os projetos da empresa para configurar a autorização. ## Catálogo Esta API permite obter qualquer tipo de itens vendáveis ou itens específicos. ### Obter lista de itens vendáveis - [GET /v2/project/{project_id}/items](https://xsolla.redocly.app/pt/api/catalog/common-catalog/get-sellable-items.md): Recebe uma lista de itens vendáveis para montar um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter item vendável por ID - [GET /v2/project/{project_id}/items/id/{item_id}](https://xsolla.redocly.app/pt/api/catalog/common-catalog/get-sellable-item-by-id.md): Obtém um item comercializável por seu ID. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter item vendável por SKU - [GET /v2/project/{project_id}/items/sku/{sku}](https://xsolla.redocly.app/pt/api/catalog/common-catalog/get-sellable-item-by-sku.md): Obtém um item vendável por SKU para criar um catálogo. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ### Obter lista de itens vendáveis por grupo especificado - [GET /v2/project/{project_id}/items/group/{external_id}](https://xsolla.redocly.app/pt/api/catalog/common-catalog/get-sellable-items-group.md): Recebe uma lista de itens vendáveis do grupo especificado para montar um catálogo. Atenção Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset. Nota Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho Authorization. Para mais informações sobre o JWT do usuário, consulte o bloco Segurança para esta chamada. ## Regiões comuns As restrições regionais de vendas permitem gerenciar a disponibilidade de itens em países ou grupos de países específicos. Por exemplo, você pode vender um jogo apenas em determinados países devido a restrições de licenciamento. As restrições são configuradas utilizando regiões. Cada região agrupa um ou mais países sob um único identificador `region_id`. Você pode vincular um item a uma ou mais regiões. A disponibilidade de itens é determinada conforme segue: * Se nenhuma região for especificada para o item, ele estará disponível para compra em todos os países. * Se regiões forem especificadas para o item e o país do usuário estiver incluído em uma delas, o item estará disponível para esse usuário. * Se regiões forem especificadas para o item e o país do usuário não estiver incluído em nenhuma delas, o item não estará disponível para esse usuário. O país do usuário é informado no parâmetro `country` ao solicitar o catálogo por meio de chamadas de API na subseção **Catalog**. Se o parâmetro não for informado, o país será determinado com base no endereço IP do usuário. A compatibilidade entre o país do usuário e as regiões do item é verificada em dois momentos: na solicitação do catálogo e na criação do pedido. Itens indisponíveis não são incluídos na resposta do catálogo, e pedidos contendo tais itens não serão criados. Utilize chamadas de API do grupo **Common regions** para criar, atualizar e excluir regiões. Fluxo de configuração de restrições regionais de venda: 1. Crie uma região usando a chamada de API [Criar região](https://developers.xsolla.com/pt/api/catalog/common-regions/admin-create-region/), especificando a lista de países. A resposta retorna um `region_id` que é necessário na etapa seguinte. 2. Associe um item virtual à região informando o `region_id` correspondente na matriz `regions` ao [criar](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-admin/admin-create-virtual-item/) ou [atualizar](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-admin/admin-update-virtual-item/) o item. 3. Exiba o catálogo para o usuário utilizando chamadas de API da subseção **Catalog**, como, por exemplo, a chamada [Obter lista de itens virtuais](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items). O país do usuário é determinado pelo parâmetro `country` ou, caso este não seja fornecido, com base no endereço IP do usuário. Itens indisponíveis no país do usuário não são incluídos na resposta do catálogo. 4. Quando o usuário prosseguir para pagar um item ou o carrinho, crie um pedido: * Se o item tiver sido adicionado ao carrinho — utilizando a chamada de API [Criar pedido com todos os itens de um carrinho específico](https://developers.xsolla.com/pt/api/catalog/payment-client-side/create-order) ou [Criar pedido com todos os itens do carrinho atual](https://developers.xsolla.com/pt/api/catalog/payment-client-side/create-order). * Para uma compra rápida de um único item — utilizando a chamada de API [Criar pedido com item específico](https://developers.xsolla.com/pt/api/catalog/payment-client-side/create-order-with-item) e passando o SKU do item. A resposta contém um token para abrir a interface de pagamento.
Observação

A Xsolla verifica se o país do usuário foi incluído na região especificada do item. Se o país não tiver sido incluído na região do item, o pedido não poderá ser criado.

5. Implemente a abertura da interface de pagamento para efetuar o pagamento do pedido. ![Regiões comuns](https://cdn.xsolla.net/developers/current/images/api_docs/api-regions.svg) ### Obter lista de regiões - [GET /v2/project/{project_id}/admin/region](https://xsolla.redocly.app/pt/api/catalog/common-regions/admin-get-regions.md): Obtém lista de regiões. Você pode usar uma região para gerenciar suas restrições regionais. ### Criar região - [POST /v2/project/{project_id}/admin/region](https://xsolla.redocly.app/pt/api/catalog/common-regions/admin-create-region.md): Cria região. Você pode usar uma região para gerenciar suas restrições regionais. ### Obter região - [GET /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/pt/api/catalog/common-regions/admin-get-region.md): Obtém região específica. Você pode usar uma região para gerenciar suas restrições regionais. ### Atualizar região - [PUT /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/pt/api/catalog/common-regions/admin-update-region.md): Atualiza uma região específica. Você pode usar uma região para gerenciar suas restrições regionais. ### Excluir região - [DELETE /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/pt/api/catalog/common-regions/admin-delete-region.md): Exclui uma região específica. ## Webhooks ### Atualizar versão de webhook - [PUT /v2/project/{project_id}/admin/webhook/version](https://xsolla.redocly.app/pt/api/catalog/common-webhooks/update-webhook-version.md): Atualiza a versão do webhook do projeto. Na versão 2, parâmetros adicionais são incluídos na matriz items. Para mais informações sobre webhooks, veja Configurar rastreamento de status do pedido. ## Admin ### Obter lista de atributos (admin) - [GET /v2/project/{project_id}/admin/attribute](https://xsolla.redocly.app/pt/api/catalog/attribute-admin/admin-get-attribute-list.md): Obtém a lista de atributos de um projeto para administração. ### Criar atributo - [POST /v2/project/{project_id}/admin/attribute](https://xsolla.redocly.app/pt/api/catalog/attribute-admin/admin-create-attribute.md): Cria um atributo. ### Atualizar atributo - [PUT /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/pt/api/catalog/attribute-admin/admin-update-attribute.md): Atualiza um atributo. ### Obter atributo especificado - [GET /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/pt/api/catalog/attribute-admin/admin-get-attribute.md): Obtém um atributo especificado. ### Excluir atributo - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/pt/api/catalog/attribute-admin/delete-attribute.md): Exclui um atributo. AvisoSe você excluir um atributo de item, todos os seus dados e conexões com itens serão perdidos. ### Criar valor de atributo - [POST /v2/project/{project_id}/admin/attribute/{external_id}/value](https://xsolla.redocly.app/pt/api/catalog/attribute-admin/admin-create-attribute-value.md): Cria um valor de atributo. AtençãoTodos os projetos têm a limitação do número de valores de atributo. O valor padrão e máximo é de 20 valores por atributo. ### Excluir todos os valores do atributo - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value](https://xsolla.redocly.app/pt/api/catalog/attribute-admin/admin-delete-all-attribute-value.md): Exclui todos os valores do atributo. AvisoSe você excluir o valor de um atributo, todas as conexões entre o atributo e os itens serão perdidas. Para alterar o valor do atributo de um item, use a chamada de API Atualizar valor do atributo em vez de excluir o valor e criar um novo. ### Atualizar valor do atributo - [PUT /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://xsolla.redocly.app/pt/api/catalog/attribute-admin/admin-update-attribute-value.md): Atualiza os valores de um atributo. ### Excluir valor de atributo - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://xsolla.redocly.app/pt/api/catalog/attribute-admin/admin-delete-attribute-value.md): Exclui um valor de atributo. AvisoSe você excluir o valor de um atributo, todas as conexões entre o atributo e os itens serão perdidas. Para alterar o valor do atributo de um item, use a chamada de API Atualizar valor do atributo em vez de excluir o valor e criar um novo. ## Admin ### Obter lista de grupo de itens - [GET /v2/project/{project_id}/admin/items/groups](https://xsolla.redocly.app/pt/api/catalog/item-groups-admin/admin-get-item-group-list.md): Recupera a lista completa de grupos de itens dentro de um projeto sem paginação para fins administrativos. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. Em vez disso, use o ponto de extremidade do lado do cliente Obter lista de grupos de itens. ### Criar grupo de itens - [POST /v2/project/{project_id}/admin/items/groups](https://xsolla.redocly.app/pt/api/catalog/item-groups-admin/admin-create-item-group.md): Cria um grupo de itens dentro de um projeto. Para recuperar grupos de itens para a construção de um catálogo, use o ponto de extremidade do lado do cliente Obter lista de grupos de itens. ### Obter grupo de itens por ID externo - [GET /v2/project/{project_id}/admin/items/groups/{external_id}](https://xsolla.redocly.app/pt/api/catalog/item-groups-admin/admin-get-item-group.md): Recupera um grupo de itens por seu ID externo para fins administrativos. ObservaçãoNão use esse ponto de extremidade para criar um catálogo de loja. Em vez disso, use o ponto de extremidade do lado do cliente Obter lista de grupos de itens. ### Atualizar grupo de itens - [PUT /v2/project/{project_id}/admin/items/groups/{external_id}](https://xsolla.redocly.app/pt/api/catalog/item-groups-admin/admin-update-item-group.md): Atualiza um grupo de itens por seu ID externo. ### Excluir grupo de itens - [DELETE /v2/project/{project_id}/admin/items/groups/{external_id}](https://xsolla.redocly.app/pt/api/catalog/item-groups-admin/admin-delete-item-group.md): Exclui um grupo de itens por seu ID externo. ### Obter lista de grupos de itens filtrada por tipo de item - [GET /v2/project/{project_id}/admin/items/{item_type}/groups](https://xsolla.redocly.app/pt/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. ### Obter grupo de itens por ID externo filtrado por tipo de item - [GET /v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}](https://xsolla.redocly.app/pt/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. ### Reordenar grupos de itens - [PUT /v2/project/{project_id}/admin/group/order](https://xsolla.redocly.app/pt/api/catalog/item-groups-admin/admin-reorder-item-groups.md): Define a ordem de exibição para grupos de itens dentro de um projeto. Passe uma matriz de grupos com seus novos valores de ordem. ### Reordenar itens dentro de um grupo (por ID externo) - [PUT /v2/project/{project_id}/admin/group/{external_id}/order/item](https://xsolla.redocly.app/pt/api/catalog/item-groups-admin/admin-reorder-items-in-group.md): Define a ordem de exibição de itens dentro de um grupo identificado por seu ID externo. Passe uma matriz de itens com seus novos valores de ordem. ### Reordenar itens dentro de um grupo (por ID) - [PUT /v2/project/{project_id}/admin/group/id/{id}/order/item](https://xsolla.redocly.app/pt/api/catalog/item-groups-admin/admin-reorder-items-in-group-by-id.md): Define a ordem de exibição de itens dentro de um grupo identificado por seu ID numérico interno. Passe uma matriz de itens com seus novos valores de ordem. ## Catálogo ### Obter lista de grupo de itens - [GET /v2/project/{project_id}/items/groups](https://xsolla.redocly.app/pt/api/catalog/item-groups-catalog/get-item-groups.md): Recupera uma lista de grupos de itens para montar um catálogo sem paginação. NoteIn general, the use of catalog of items is available without authorization. Only authorized users can get a personalized catalog.