# 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. You can try this call using the following test token: ``` eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI ``` Alternatively, you can use a [token for opening the payment UI](/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 The `AuthForCart` authentication scheme is used for cart purchases and supports two modes: 1. **Authentication with a user's JWT.** The token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token: ``` eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI ``` Alternatively, you can use a [token for opening the payment UI](/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/) # 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` — payment 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" } } ``` # 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 ### AuthForCart The `AuthForCart` authentication scheme is used for cart purchases and supports two modes: 1. Authentication with a user's JWT. The token is passed in the Authorization header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token:`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`. 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 [selling game keys](/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. Type: http Scheme: bearer ### XsollaLoginUserJWT Client-side calls use the `XsollaLoginUserJWT` authentication scheme. The request must include the user's JWT in the `Authorization` header in the following format: Bearer ``. The token identifies the user and provides access to personalized data. For details on how to create a token, refer to the [Xsolla Login API documentation](/pt/api/login/authentication-schemes#getting-user-token). You can try this call using the following test token: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`. Alternatively, you can use a [token for opening the payment UI](/pt/api/pay-station/token/create-token). Type: http Scheme: bearer Bearer Format: JWT ### basicAuth Server-side calls use the `basicAuth` authentication scheme. All requests to API must contain the `Authorization: Basic ` header, where `your_authorization_basic_key` is the `project_id:api_key` pair encoded according to the Base64 standard. You can use `merchant_id` instead of `project_id` if you need. It doesn't affect functionality. Go to [Publisher Account](https://publisher.xsolla.com/) to find values of the parameters: * `merchant_id` is shown: * In the **Company settings > Company** section * In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`. * `api_key` is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the following section: * [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key) * [Project settings > API keys](https://publisher.xsolla.com/0/projects/0/edit/api_key) {% html name="div" attrs={"class": "notice"} %} **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. {% /html %} * `project_id` is shown: * In Publisher Account next to the name of the project. * In the URL in the browser address bar when working on project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com//projects/`. For more information about working with API keys, see the [API reference](https://developers.xsolla.com/pt/api/getting-started/#api_keys_overview). Type: http Scheme: basic ### basicMerchantAuth Server-side calls use the `basicMerchantAuth` authentication scheme. All requests to API must contain the `Authorization: Basic ` header, where `your_authorization_basic_key` is the `merchant_id:api_key` pair encoded according to the Base64 standard. Go to [Publisher Account](https://publisher.xsolla.com/) to find values of the parameters: * `merchant_id` is shown: * In the **Company settings > Company** section * In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/` * `api_key` is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key) section. For more information about working with API keys, see the [API reference](https://developers.xsolla.com/pt/api/getting-started/#api_keys_overview). Type: http Scheme: basic ## Download OpenAPI description [Catalog API](https://developers.xsolla.com/_bundle/@l10n/pt/api/catalog/index.yaml) ## Admin ### Obter lista de moedas virtuais - [GET /v2/project/{project_id}/admin/items/virtual_currency](https://developers.xsolla.com/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://developers.xsolla.com/pt/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency.md): Cria uma moeda virtual. ### Obter lista de pacotes de moedas virtuais (admin) - [GET /v2/project/{project_id}/admin/items/virtual_currency/package](https://developers.xsolla.com/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://developers.xsolla.com/pt/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency-package.md): Cria um pacote de moedas virtuais. ### Excluir pacote de moedas virtuais - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/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://developers.xsolla.com/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. ### Atualizar pacote de moedas virtuais - [PUT /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency-package.md): Atualiza um pacote de moedas virtuais. ### Excluir moeda virtual - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency.md): Exclui uma moeda virtual. ### Obter moeda virtual - [GET /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/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://developers.xsolla.com/pt/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency.md): Atualiza uma moeda virtual. ### Obter lista de itens virtuais - [GET /v2/project/{project_id}/admin/items/virtual_items](https://developers.xsolla.com/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://developers.xsolla.com/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://developers.xsolla.com/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://developers.xsolla.com/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. ### Excluir item virtual - [DELETE /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-admin/admin-delete-virtual-item.md): Exclui um item virtual. ### Obter item virtual - [GET /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/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://developers.xsolla.com/pt/api/catalog/virtual-items-currency-admin/admin-update-virtual-item.md): Atualiza um item virtual. ## Catálogo ### Obter lista de moedas virtuais - [GET /v2/project/{project_id}/items/virtual_currency](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-catalog/get-virtual-currency.md): Gets a virtual currency list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter lista de pacotes de moedas virtuais - [GET /v2/project/{project_id}/items/virtual_currency/package](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package.md): Gets a virtual currency packages list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter pacote de moedas virtuais por SKU - [GET /v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-sku.md): Gets a virtual currency packages by SKU for building a catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter moeda virtual por SKU - [GET /v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-catalog/get-virtual-currency-sku.md): Gets a virtual currency by SKU for building a catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter lista de itens virtuais - [GET /v2/project/{project_id}/items/virtual_items](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items.md): Gets a virtual items list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter toda a lista de itens virtuais - [GET /v2/project/{project_id}/items/virtual_items/all](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-catalog/get-all-virtual-items.md): Gets a list of all virtual items for searching on client-side. Notice Returns only item SKU, name, groups and description. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter lista de itens por grupo especificado - [GET /v2/project/{project_id}/items/virtual_items/group/{external_id}](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items-group.md): Gets an items list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter item virtual por SKU - [GET /v2/project/{project_id}/items/virtual_items/sku/{item_sku}](https://developers.xsolla.com/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items-sku.md): Gets a virtual item by SKU for building a catalog. Notice This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## 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://developers.xsolla.com/pt/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency.md): Creates item purchase using virtual currency. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## Catálogo ### Obter lista de jogos - [GET /v2/project/{project_id}/items/game](https://developers.xsolla.com/pt/api/catalog/game-keys-catalog/get-games-list.md): Gets a games list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter lista de DRM - [GET /v2/project/{project_id}/items/game/drm](https://developers.xsolla.com/pt/api/catalog/game-keys-catalog/get-drm-list.md): Obtém a lista de DRMs disponíveis. ### Obter lista de jogos por grupo especificado - [GET /v2/project/{project_id}/items/game/group/{external_id}](https://developers.xsolla.com/pt/api/catalog/game-keys-catalog/get-games-group.md): Gets a games list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter lista de chaves de jogo por grupo especificado - [GET /v2/project/{project_id}/items/game/key/group/{external_id}](https://developers.xsolla.com/pt/api/catalog/game-keys-catalog/get-game-keys-group.md): Gets a game key list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter chave de jogo para catálogo - [GET /v2/project/{project_id}/items/game/key/sku/{item_sku}](https://developers.xsolla.com/pt/api/catalog/game-keys-catalog/get-game-key-by-sku.md): Gets a game key for the catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter jogo para catálogo - [GET /v2/project/{project_id}/items/game/sku/{item_sku}](https://developers.xsolla.com/pt/api/catalog/game-keys-catalog/get-game-by-sku.md): Gets a game for the catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## Direito ### Direito à concessão (admin) - [POST /v2/project/{project_id}/admin/entitlement/grant](https://developers.xsolla.com/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://developers.xsolla.com/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. ### Obter lista de jogos de propriedade do usuário - [GET /v2/project/{project_id}/entitlement](https://developers.xsolla.com/pt/api/catalog/game-keys-entitlement/get-user-games.md): Get the list of games owned by the user. The response will contain an array of games owned by a particular user. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Resgatar código de jogo por cliente - [POST /v2/project/{project_id}/entitlement/redeem](https://developers.xsolla.com/pt/api/catalog/game-keys-entitlement/redeem-game-pin-code.md): Grants entitlement by a provided game code. Notice You can redeem codes only for the DRM-free platform. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## Admin ### Obter lista de jogos (admin) - [GET /v2/project/{project_id}/admin/items/game](https://developers.xsolla.com/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 armazenamento. ### Criar jogo - [POST /v2/project/{project_id}/admin/items/game](https://developers.xsolla.com/pt/api/catalog/game-keys-admin/admin-create-game.md): Cria um jogo no projeto. ### Excluir jogo por ID - [DELETE /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/pt/api/catalog/game-keys-admin/admin-delete-game-by-id.md): Exclui um jogo no projeto por ID. ### Obter jogo por ID (admin) - [GET /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/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 armazenamento. ### Atualizar jogo por ID - [PUT /v2/project/{project_id}/admin/items/game/id/{item_id}](https://developers.xsolla.com/pt/api/catalog/game-keys-admin/admin-update-game-by-id.md): Atualiza um jogo no projeto por ID. ### Excluir códigos por ID - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}](https://developers.xsolla.com/pt/api/catalog/game-keys-admin/admin-delete-codes-by-id.md): Exclui todos os 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://developers.xsolla.com/pt/api/catalog/game-keys-admin/admin-delete-codes-by-sku.md): Exclui todos os 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://developers.xsolla.com/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. ### Obter códigos - [GET /v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}](https://developers.xsolla.com/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. ### Carregar códigos por ID - [POST /v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}](https://developers.xsolla.com/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://developers.xsolla.com/pt/api/catalog/game-keys-admin/admin-get-codes-session.md): Obtém códigos carregando informações de sessão. ### Carregar códigos - [POST /v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}](https://developers.xsolla.com/pt/api/catalog/game-keys-admin/admin-upload-codes-by-sku.md): Carrega códigos por SKU de chave de jogo. ### Excluir jogo por SKU - [DELETE /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/pt/api/catalog/game-keys-admin/admin-delete-game-by-sku.md): Exclui um jogo no projeto por SKU. ### Obter jogo (admin) - [GET /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/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 armazenamento. ### Atualizar jogo por SKU - [PUT /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://developers.xsolla.com/pt/api/catalog/game-keys-admin/admin-update-game-by-sku.md): Atualiza um jogo no projeto por SKU. ## Admin ### Obter lista de pacotes - [GET /v2/project/{project_id}/admin/items/bundle](https://developers.xsolla.com/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 armazenamento. ### Criar conjunto - [POST /v2/project/{project_id}/admin/items/bundle](https://developers.xsolla.com/pt/api/catalog/bundles-admin/admin-create-bundle.md): Cria um conjunto. ### Obter lista de conjuntos por ID de grupo externo especificado - [GET /v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}](https://developers.xsolla.com/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. ### Obter lista de conjuntos por ID de grupo especificado - [GET /v2/project/{project_id}/admin/items/bundle/group/id/{group_id}](https://developers.xsolla.com/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. ### Excluir conjunto - [DELETE /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/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://developers.xsolla.com/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. ### Conjunto de atualização - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://developers.xsolla.com/pt/api/catalog/bundles-admin/admin-update-bundle.md): Atualiza um conjunto. ### Ocultar conjunto no catálogo - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide](https://developers.xsolla.com/pt/api/catalog/bundles-admin/admin-hide-bundle.md): Oculta um conjunto em um catálogo. ### Mostrar conjunto no catálogo - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/show](https://developers.xsolla.com/pt/api/catalog/bundles-admin/admin-show-bundle.md): Mostra um conjunto em um catálogo. ## Catálogo ### Obter lista de pacotes - [GET /v2/project/{project_id}/items/bundle](https://developers.xsolla.com/pt/api/catalog/bundles-catalog/get-bundle-list.md): Gets a list of bundles for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter lista de pacotes por grupo especificado - [GET /v2/project/{project_id}/items/bundle/group/{external_id}](https://developers.xsolla.com/pt/api/catalog/bundles-catalog/get-bundle-list-in-group.md): Gets a list of bundles within a group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter pacote especificado - [GET /v2/project/{project_id}/items/bundle/sku/{sku}](https://developers.xsolla.com/pt/api/catalog/bundles-catalog/get-bundle.md): Gets a specified bundle. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## Carrinho (lado do cliente) ### Obter o carrinho do usuário atual - [GET /v2/project/{project_id}/cart](https://developers.xsolla.com/pt/api/catalog/cart-client-side/get-user-cart.md): Retorna o carrinho do usuário atual. ### Excluir todos os itens do carrinho atual - [PUT /v2/project/{project_id}/cart/clear](https://developers.xsolla.com/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://developers.xsolla.com/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. ### Excluir item do carrinho atual - [DELETE /v2/project/{project_id}/cart/item/{item_sku}](https://developers.xsolla.com/pt/api/catalog/cart-client-side/delete-item.md): Remove um item do carrinho. ### Atualizar item do carrinho do carrinho atual - [PUT /v2/project/{project_id}/cart/item/{item_sku}](https://developers.xsolla.com/pt/api/catalog/cart-client-side/put-item.md): Atualiza um item de carrinho existente ou cria o item no carrinho. ### Obter carrinho por ID de carrinho - [GET /v2/project/{project_id}/cart/{cart_id}](https://developers.xsolla.com/pt/api/catalog/cart-client-side/get-cart-by-id.md): Devolve o carrinho do utilizador pelo ID de carrinho. ### Excluir todos os itens do carrinho pelo ID de carrinho - [PUT /v2/project/{project_id}/cart/{cart_id}/clear](https://developers.xsolla.com/pt/api/catalog/cart-client-side/cart-clear-by-id.md): Exclui todos os itens do carrinho. ### Preencha o carrinho específico com itens - [PUT /v2/project/{project_id}/cart/{cart_id}/fill](https://developers.xsolla.com/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. ### Excluir item de carrinho por ID de carrinho - [DELETE /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://developers.xsolla.com/pt/api/catalog/cart-client-side/delete-item-by-cart-id.md): Remove um item do carrinho. ### Atualizar item do carrinho por ID de carrinho - [PUT /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://developers.xsolla.com/pt/api/catalog/cart-client-side/put-item-by-cart-id.md): Atualiza um item de carrinho existente ou cria o item no carrinho. ## Carrinho (lado do servidor) ### Preencher o carrinho com itens - [PUT /v2/admin/project/{project_id}/cart/fill](https://developers.xsolla.com/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://developers.xsolla.com/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) ### Criar pedido com todos os itens do carrinho atual - [POST /v2/project/{project_id}/payment/cart](https://developers.xsolla.com/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 todos os itens de um carrinho específico - [POST /v2/project/{project_id}/payment/cart/{cart_id}](https://developers.xsolla.com/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 item especificado - [POST /v2/project/{project_id}/payment/item/{item_sku}](https://developers.xsolla.com/pt/api/catalog/payment-client-side/create-order-with-item.md): Used for client-to-server integration. Creates an order with a specified item and generates a payment token for it. The created order gets the new order status. The client IP is used to determine the user’s country, which is then used to apply the corresponding currency and available payment methods for the order. To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation4/?token={token}, where {token} is the received token. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Notice As this method uses the IP to determine the user’s country and select a currency for the order, it is important to only use this method from the client side and not from the server side. Using this method from the server side may cause incorrect currency determination and affect payment methods in Pay Station. Notice This API call uses a user JWT for authorization. Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call. ## Pagamento (lado do servidor) ### Criar token de pagamento para compra - [POST /v3/project/{project_id}/admin/payment/token](https://developers.xsolla.com/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 propósitos 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 ### Obter pedido - [GET /v2/project/{project_id}/order/{order_id}](https://developers.xsolla.com/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://developers.xsolla.com/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 ### Criar pedido com carrinho grátis - [POST /v2/project/{project_id}/free/cart](https://developers.xsolla.com/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://developers.xsolla.com/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://developers.xsolla.com/pt/api/catalog/free-item/create-free-order-with-item.md): Creates an order with a specified free item. The created order will get a done order status. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## Gestão ### Atualizar todos os limites de compra para o usuário especificado - [DELETE /v2/project/{project_id}/admin/user/limit/item/all](https://developers.xsolla.com/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 ### 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://developers.xsolla.com/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 ### 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://developers.xsolla.com/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://developers.xsolla.com/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://developers.xsolla.com/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 ### Atualizar limite de compra - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all](https://developers.xsolla.com/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 ## Admin ### Obter status da importação de itens - [GET /v1/admin/projects/{project_id}/connectors/import_items/import/status](https://developers.xsolla.com/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. ### Importar itens via arquivo JSON - [POST /v1/projects/{project_id}/import/from_external_file](https://developers.xsolla.com/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. ## Reservas ### 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://developers.xsolla.com/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} ### 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://developers.xsolla.com/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://developers.xsolla.com/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://developers.xsolla.com/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 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://developers.xsolla.com/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 ### Alternar o limite de pré-venda do item - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle](https://developers.xsolla.com/pt/api/catalog/common-pre-orders/toggle-pre-order-limit.md): Ative/desative 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}/toggle ## Comerciante ### Obter projetos - [GET /v2/merchant/{merchant_id}/projects](https://developers.xsolla.com/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://developers.xsolla.com/pt/api/catalog/common-catalog/get-sellable-items.md): Gets a sellable items list for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter lista de itens vendáveis por grupo especificado - [GET /v2/project/{project_id}/items/group/{external_id}](https://developers.xsolla.com/pt/api/catalog/common-catalog/get-sellable-items-group.md): Gets a sellable items list from the specified group for building a catalog. Attention All projects have the limitation to the number of items that you can get in the response. The default and maximum value is 50 items per response. To get more data page by page, use limit and offset fields. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter item vendável por ID - [GET /v2/project/{project_id}/items/id/{item_id}](https://developers.xsolla.com/pt/api/catalog/common-catalog/get-sellable-item-by-id.md): Gets a sellable item by its ID. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ### Obter item vendável por SKU - [GET /v2/project/{project_id}/items/sku/{sku}](https://developers.xsolla.com/pt/api/catalog/common-catalog/get-sellable-item-by-sku.md): Gets a sellable item by SKU for building a catalog. Note This API call returns generic item catalog data when used without authorization. Use authorization to retrieve personalized user data, such as limits and promotions associated with the item. To do this, pass the user JWT in the Authorization header. For more information about user JWT, see the Security block for this call. ## Regiões comuns ### Obter lista de regiões - [GET /v2/project/{project_id}/admin/region](https://developers.xsolla.com/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://developers.xsolla.com/pt/api/catalog/common-regions/admin-create-region.md): Cria região. 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://developers.xsolla.com/pt/api/catalog/common-regions/admin-delete-region.md): Exclui uma região específica. ### Obter região - [GET /v2/project/{project_id}/admin/region/{region_id}](https://developers.xsolla.com/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://developers.xsolla.com/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. ## Admin ### Obter lista de atributos (admin) - [GET /v2/project/{project_id}/admin/attribute](https://developers.xsolla.com/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://developers.xsolla.com/pt/api/catalog/attribute-admin/admin-create-attribute.md): Cria um atributo. ### Excluir atributo - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/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. ### Obter atributo especificado - [GET /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/pt/api/catalog/attribute-admin/admin-get-attribute.md): Obtém um atributo especificado. ### Atualizar atributo - [PUT /v2/project/{project_id}/admin/attribute/{external_id}](https://developers.xsolla.com/pt/api/catalog/attribute-admin/admin-update-attribute.md): Atualiza um atributo. ### Excluir todos os valores do atributo - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value](https://developers.xsolla.com/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. ### Criar valor de atributo - [POST /v2/project/{project_id}/admin/attribute/{external_id}/value](https://developers.xsolla.com/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 valor de atributo - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://developers.xsolla.com/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. ### Atualizar valor do atributo - [PUT /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://developers.xsolla.com/pt/api/catalog/attribute-admin/admin-update-attribute-value.md): Atualiza os valores de um atributo. ## Admin ### Reorder items within a group (by ID) - [PUT /v2/project/{project_id}/admin/group/id/{id}/order/item](https://developers.xsolla.com/pt/api/catalog/item-groups-admin/admin-reorder-items-in-group-by-id.md): Sets the display order of items within a group identified by its internal numeric ID. Pass an array of items with their new order values. ### Reorder item groups - [PUT /v2/project/{project_id}/admin/group/order](https://developers.xsolla.com/pt/api/catalog/item-groups-admin/admin-reorder-item-groups.md): Sets the display order for item groups within a project. Pass an array of groups with their new order values. ### Reorder items within a group (by external ID) - [PUT /v2/project/{project_id}/admin/group/{external_id}/order/item](https://developers.xsolla.com/pt/api/catalog/item-groups-admin/admin-reorder-items-in-group.md): Sets the display order of items within a group identified by its external ID. Pass an array of items with their new order values. ### Obter lista de grupo de itens - [GET /v2/project/{project_id}/admin/items/groups](https://developers.xsolla.com/pt/api/catalog/item-groups-admin/admin-get-item-group-list.md): Retrieves the full list of item groups within a project without pagination. For administrative purposes. NoteDo not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead. ### Create item group - [POST /v2/project/{project_id}/admin/items/groups](https://developers.xsolla.com/pt/api/catalog/item-groups-admin/admin-create-item-group.md): Creates an item group within a project. To retrieve item groups for building a catalog, use the Get item group list client-side endpoint. ### Delete item group - [DELETE /v2/project/{project_id}/admin/items/groups/{external_id}](https://developers.xsolla.com/pt/api/catalog/item-groups-admin/admin-delete-item-group.md): Deletes an item group by its external ID. ### Get item group by external ID - [GET /v2/project/{project_id}/admin/items/groups/{external_id}](https://developers.xsolla.com/pt/api/catalog/item-groups-admin/admin-get-item-group.md): Retrieves an item group by its external ID for administrative purposes. NoteDo not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead. ### Update item group - [PUT /v2/project/{project_id}/admin/items/groups/{external_id}](https://developers.xsolla.com/pt/api/catalog/item-groups-admin/admin-update-item-group.md): Updates an item group by its external ID. ### Get item group list filtered by item type - [GET /v2/project/{project_id}/admin/items/{item_type}/groups](https://developers.xsolla.com/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. ### Get item group by external ID filtered by item type - [GET /v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}](https://developers.xsolla.com/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. ## Catálogo ### Obter lista de grupo de itens - [GET /v2/project/{project_id}/items/groups](https://developers.xsolla.com/pt/api/catalog/item-groups-catalog/get-item-groups.md): Retrieves an item group list for building a catalog without pagination. NoteThe use of the item catalog API calls is available without authorization, but to get a personalized catalog, you must pass the user JWT in the Authorization header.