` is the user token. The token identifies the user and provides access to personalized data.\nAlternatively, you can use a [token for opening the payment UI](/pt/api/pay-station/token/create-token).\n\n2. **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:\n - `x-unauthorized-id` with a request ID\n - `x-user` with the user's email address encoded in Base64\n\n## Useful links\n\n- [API calls by interaction model](https://developers.xsolla.com/pt/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/pt/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/pt/api/catalog/)\n- [API keys](https://developers.xsolla.com/pt/api/catalog/)\n- [Webhooks](https://developers.xsolla.com/pt/api/catalog/)\n\n# Core entity structure\n\nItems 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.\n\nNote
Some calls may include additional fields but they don't change the basic structure.
\n\n**Identification**\n\n- `merchant_id` — company ID in [Publisher Account](https://publisher.xsolla.com/)\n- `project_id` — project ID in Publisher Account\n- `sku` — item SKU, unique within the project\n\n**Store display**\n\n- `name` — item name\n- `description` — item description\n- `image_url` — image URL\n- `is_enabled` — item availability\n- `is_show_in_store` — whether the item is displayed in the catalog\n\nFor more information about managing item availability in the catalog, see the [documentation](/pt/items-catalog/catalog-features/items-availability/).\n\n**Organization**\n\n- `type` — item type, for example, a virtual item (`virtual_item`) or bundle (`bundle`)\n- `groups` — groups the item belongs to\n- `order` — display order in the catalog\n\n**Sale conditions**\n\n- `prices` — prices in real or virtual currency\n- `limits` — purchase limits\n- `periods` — availability periods\n- `regions` — regional restrictions\n\n**Example of core entity structure:**\n\n```json\n{\n \"attributes\": [],\n \"bundle_type\": \"virtual_currency_package\",\n \"content\": [\n {\n \"description\": {\n \"en\": \"Main in-game currency\"\n },\n \"image_url\": \"https://.../image.png\",\n \"name\": {\n \"en\": \"Crystals\",\n \"de\": \"Kristalle\"\n },\n \"quantity\": 500,\n \"sku\": \"com.xsolla.crystal_2\",\n \"type\": \"virtual_currency\"\n }\n ],\n \"description\": {\n \"en\": \"Crystals x500\"\n },\n \"groups\": [],\n \"image_url\": \"https://.../image.png\",\n \"is_enabled\": true,\n \"is_free\": false,\n \"is_show_in_store\": true,\n \"limits\": {\n \"per_item\": null,\n \"per_user\": null,\n \"recurrent_schedule\": null\n },\n \"long_description\": null,\n \"media_list\": [],\n \"name\": {\n \"en\": \"Medium crystal pack\"\n },\n \"order\": 1,\n \"periods\": [\n {\n \"date_from\": null,\n \"date_until\": \"2020-08-11T20:00:00+03:00\"\n }\n ],\n \"prices\": [\n {\n \"amount\": 20,\n \"country_iso\": \"US\",\n \"currency\": \"USD\",\n \"is_default\": true,\n \"is_enabled\": true\n }\n ],\n \"regions\": [],\n \"sku\": \"com.xsolla.crystal_pack_2\",\n \"type\": \"bundle\",\n \"vc_prices\": []\n}\n```\n\n# Basic purchase flow\n\nThe 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).\n\nThe following example shows a basic flow for setting up and operating a store, from item creation to purchase.\n\n## Create items and groups (Admin)\n\nCreate an item catalog for your store, such as virtual items, bundles, or virtual currency.\n\nExample API calls:\n- [Create virtual item](/pt/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/pt/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/pt/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n\n## Set up promotions, chains, and limits (Admin)\n\nConfigure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains.\n\nExample API calls:\n- [Create bonus promotion](/pt/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/pt/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/pt/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer)\n\n## Get item information (Client)\n\nConfigure item display in your application.\n\n\n
Notice\n 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.\n
\n\nExample API calls:\n- [Get virtual items list](/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/pt/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/pt/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/pt/api/catalog/common-catalog/get-sellable-items)\n\n\n Note
\n 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.\n
\n\n## Sell items\n\nYou can sell items using the following methods:\n- Fast purchase — sell one SKU multiple times.\n- Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order.\n\nIf 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.\n\nFor 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.\n\n### Fast purchase\n\nUse 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.\n\n\n Note
\n Discount information is available to the user only in the payment UI. Promo codes are not supported.\n
\n\n### Cart purchase\n\nCart setup and purchase can be performed on the client or on the server side.\n\n**Set up and purchase a cart on the client**\n\nImplement 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.\n\nImplement the following cart logic:\n1. 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).\n2. Update the cart contents based on user actions:\n - 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.\n - To remove an item, use the [Delete cart item by cart ID](/pt/api/shop-builder/operation/delete-item-by-cart-id/) API call.\n\n\n Note
\n To get the current status of the cart, use the Get current user's cart API call.\n
\n\n3. 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.\n\n**Set up and purchase a cart on the server**\n\nThis setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls.\n\nImplement the following cart logic:\n1. 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).\n2. 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.\n\n## Open payment UI\n\nUse 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).\n\n| Action | Endpoint |\n|:--------------------------------|:--------------------------------------------------------------------------|\n| Open in production environment. | https://secure.xsolla.com/paystation4/?token={token} |\n| Open in sandbox mode. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |\n\n\n
Note\n Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use
test bank cards.\n\n 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).\n\n 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.\n
\n - In client-side API calls,\n the country is determined by the IP address of the request.
\n - In server-side API calls,\n the country is determined by the value of the
user.country.value parameter or by the user's IP address\n from the X-User-Ip header. If both are passed, the user.country.value parameter takes precedence. \n
\n\n\n
Note\n Only
IPv4 addresses are supported for country determination.\n Passing an
IPv6 address may result in incorrect country\n and currency detection. If you use the server-side API call and cannot provide the user's IPv4 address,\n pass the country in the
user.country.value parameter.\n
\n Aviso
\n Não use chamadas de API da subseção Admin para construir um catálogo de loja.\n
\n\n
\n\n\n
Nota\n A chamada de API
Obter lista de itens virtuais retorna dados detalhados dos itens, incluindo preços e atributos, e suporta paginação. Use-a para exibir páginas de catálogo na vitrine.\n
\n A chamada de API
Obter lista de todos os itens virtuais retorna o SKU do item, nome, descrição, bem como ID e nome do grupo sem paginação. Use-a para busca ou indexação do lado do cliente.\n
\n\nPara compras com moedas virtuais, use a chamada de API [Criar pedido com item especificado comprado por moeda virtual](/pt/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency). A interface de pagamento não é necessária — a cobrança é processada quando a chamada de API é executada.\n\nExemplo de fluxo de compra com moeda virtual:\n\n"
},
{
"name": "virtual-items-currency-admin",
"x-displayName": "Admin"
},
{
"name": "virtual-items-currency-catalog",
"x-displayName": "Catálogo"
},
{
"name": "virtual-payment",
"x-displayName": "Pagamento virtual"
},
{
"name": "game-keys-overview",
"x-displayName": "Visão geral",
"description": "Chaves de jogo são códigos alfanuméricos exclusivos de uso único que concedem acesso a um jogo ou DLC em plataformas de jogos para usuários. Você pode vender chaves de jogo via [link direto](/pt/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_game_keys_selling_via_direct_link), pela [interface da loja](/pt/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_game_keys_selling_via_store_ui), ou via [widget](/pt/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_items_develop_buttons). Você também pode [configurar restrições regionais](/pt/items-catalog/catalog-features/regional-restrictions/) para vender chaves de jogo em países específicos. Para obter informações detalhadas, consulte a seção [pacotes de chaves de jogo](https://developers.xsolla.com/pt/items-catalog/items-type/set-up-modules/).\n\nNão é necessário estar autenticado para vender chaves de jogo — as chaves são enviadas ao e-mail que o usuário especifica na compra. Você pode configurar a autenticação para habilitar cenários adicionais: [personalização](/pt/liveops/liveops-management/personalization-tutorial/), [limites de compra](/pt/items-catalog/catalog-features/items-catalog-number-limits/), ou um [sistema de direitos](/pt/sell-games/how-to/entitlement-system/). Para obter informações mais detalhadas, consulte a seção [Como configurar a autenticação ao vender chaves de jogo](/pt/sell-games/how-to/set-up-authentication/).\n\nFluxo de venda de chaves de jogo:\n\n1. Crie um jogo usando a chamada de API [Criar jogo](/pt/api/catalog/game-keys-admin/admin-create-game) API call.\n2. Configure restrições regionais.\n3. Envie chaves a um pacote de chaves de jogo usando a chamada de API [Enviar códigos](/pt/api/catalog/game-keys-admin/admin-upload-codes-by-sku) para torná-las disponíveis para compra.\n4. Exiba o catálogo de jogos com preços para a região do usuário usando a chamada de API [Obter lista de jogos](/pt/api/catalog/game-keys-catalog/get-games-list) API call.\n5. Crie um pedido. Para criar uma compra rápida, você pode usar a chamada de API [Criar pedido com todos os itens do carrinho atual](/pt/api/catalog/payment-client-side/create-order-with-item), passando o SKU da chave de jogo. A resposta retorna um token para abrir a interface de pagamento.\n6. Implemente a abertura da interface de pagamento para pagar pelo pedido.\n\nPara receber notificações sobre pagamentos bem-sucedidos e entregar itens ao usuário, configure o rastreamento do status de pedidos, por exemplo, usando [webhooks](/pt/webhooks/section/osnovnye-polozheniya). As chaves são enviadas ao e-mail especificado pelo usuário na compra, e o pedido transita para o status `done`.\n\n"
},
{
"name": "game-keys-catalog",
"x-displayName": "Catálogo"
},
{
"name": "game-keys-entitlement",
"x-displayName": "Direito"
},
{
"name": "game-keys-admin",
"x-displayName": "Admin"
},
{
"name": "bundles-overview",
"x-displayName": "Visão geral",
"description": "Conjuntos são grupos de itens vendidos como uma unidade única. Um conjunto pode incluir itens virtuais, moedas virtuais, pacotes de moedas virtuais, chaves de jogo, e outros conjuntos. Use conjuntos para criar pacotes de iniciantes, ofertas sazonais e ofertas especiais.\n\nUse os seguintes grupos de chamada de API com conjuntos:\n\n* Use chamadas de API da subseção Admin para criar, atualizar, excluir conjuntos e gerenciar sua visibilidade.\n* Use chamadas de API da subseção Catálogo para recuperar conjuntos.\n\nOs limites de compra são configurados pelo objeto `limits` ao criar ou atualizar um conjunto. Para mais informações, consulte a visão geral de [limites](/pt/api/catalog/limits-overview). Você também pode configurar [restrições regionais](https://developers.xsolla.com/pt/items-catalog/catalog-features/regional-restrictions/) para vender itens em países específicos.\n\n\n
Nota\n Para mais informações sobre a configuração de conjuntos, consulte a seção
Conjuntos.\n
\n\nCenário de gestão de conjuntos:\n\n1. Crie um conjunto usando a chamada de API [Criar conjunto](/pt/api/catalog/bundles-admin/admin-create-bundle). Para verificar o conjunto criado, use a chamada de API [Obter conjunto](/pt/api/catalog/bundles-admin/admin-get-bundle). Para recuperar todos os conjuntos no projeto, use a chamada de API [Obter lista de conjuntos](/pt/api/catalog/bundles-admin/admin-get-bundle-list).\n2. Se necessário, use a chamada de API [Atualizar conjunto](/pt/api/catalog/bundles-admin/admin-update-bundle) para modificar o conteúdo do conjunto ou as configurações.\n3. Implemente a lógica de exibição do conjunto na sua vitrine usando as chamadas de API [Obter lista de conjuntos](/pt/api/catalog/bundles-catalog/get-bundle-list), [Obter conjunto específico](/pt/api/catalog/bundles-catalog/get-bundle), ou [Obter lista de conjuntos por grupo especificado](/pt/api/catalog/bundles-catalog/get-bundle-list-in-group).\n4. Crie um pedido usando a seção [Carrinho e pagamento](/pt/api/catalog/cart-and-payment-overview). Por exemplo, para uma compra rápida, você pode usar a chamada de API [Criar pedido com o item especificado](/pt/api/catalog/payment-client-side/create-order-with-item), passando o SKU do conjunto. A resposta contém um token para abrir a interface de pagamento.\n5. Implemente usando a interface de pagamento para pagar pelo pedido.\n6. Configure o rastreamento de status de pedidos, por exemplo, usando [webhooks](https://developers.xsolla.com/pt/webhooks/overview) para receber dados sobre itens pagos com sucesso prontamente e concedê-los ao usuário.\n\n"
},
{
"name": "bundles-admin",
"x-displayName": "Admin"
},
{
"name": "bundles-catalog",
"x-displayName": "Catálogo"
},
{
"name": "cart-and-payment-overview",
"x-displayName": "Visão geral",
"description": "O carrinho é um mecanismo de compra que permite combinar vários itens em um único pedido. Um usuário pode comprar itens de qualquer tipo em qualquer quantidade com moedas reais, assim como usar [códigos promocionais](https://developers.xsolla.com/pt/api/liveops/promotions-promo-codes).\n\nO carrinho é armazenado no lado da Xsolla. O salvamento do carrinho entre sessões depende do usuário estar autorizado ou não:\n * Para usuários autorizados, o carrinho é vinculado a um usuário específico e é salvo entre as sessões, desde que as solicitações sejam enviadas em nome do mesmo usuário.\n\n * Para [usuários não autorizados](/pt/api/catalog/section/authentication/authentication-with-guest-access-support), salvar o carrinho depende se o cabeçalho `x-unauthorized-id` é passado. Para salvar o carrinho de um usuário não autorizado entre sessões, passe o mesmo `x-unauthorized-id` em toda solicitação. Essa opção só está disponível para a venda de chaves de jogo.\n\nVocê pode identificar o carrinho de duas maneiras: automaticamente pelo [JWT do usuário](https://developers.xsolla.com/pt/api/catalog/section/authentication/authentication-using-user's-jwt) ou por ID do carrinho (`cart_id`).\n\nA gestão do carrinho está disponível tanto no lado do cliente quanto no lado do servidor.\n\nNo lado do servidor, você pode preencher o carrinho com itens, por exemplo, ao restaurar uma sessão de usuário. As seguintes ações estão disponíveis no lado do cliente:\n\n* recuperar o carrinho do usuário atual ou um carrinho por ID\n* preencher o carrinho\n* atualizar itens no carrinho\n* excluir itens do carrinho\n\nPara comprar itens do carrinho, são usadas chamadas do cliente e do servidor para criação de pedidos.\n\nO tempo de vida (TTL) do carrinho é de 72 horas por padrão. Se o conteúdo for alterado, por exemplo, quando um novo item é adicionado, o TTL é estendido.\n\nApós um pagamento bem-sucedido, o carrinho não é esvaziado automaticamente. Para limpar o carrinho, use as chamadas de API do lado do cliente:\n * [Excluir todos os itens do carrinho por ID do carrinho](/pt/api/catalog/cart-client-side/cart-clear-by-id).\n\n * [Excluir todos os itens do carrinho atual](/pt/api/catalog/cart-client-side/cart-clear).\n\n * [Excluir item do carrinho por ID do carrinho](/pt/api/catalog/cart-client-side/delete-item-by-cart-id) e [Excluir item do carrinho atual](/pt/api/catalog/cart-client-side/delete-item) — o carrinho é limpo ao excluir o último item dele.\n\nCenário de uso do carrinho:\n\n1. Implemente uma interface de loja onde o usuário selecionará os itens.\n\n2. Quando o usuário seleciona itens na loja, adicione-os ao carrinho, por exemplo, usando a chamada [Preenchar carrinho com itens](https://developers.xsolla.com/pt/api/catalog/cart-client-side/cart-fill). Na matriz de itens, você deve passar os SKUs e a quantidade necessária dos itens.\n\n3. Implemente a interface de visualização do carrinho. Quando o usuário navega ao carrinho, exiba seus conteúdos usando a chamada [Obter carrinho do usuário atual](https://developers.xsolla.com/pt/api/catalog/cart-client-side/get-user-cart). A resposta retornará informações sobre o peço final dos itens, incluindo descontos e promoções aplicadas.\n\n4. Implemente a abertura da interface de pagamento para pagar pelo pedido. Por exemplo, você pode usar a chamada [Criar pedido com todos os itens de um carrinho em particular](https://developers.xsolla.com/pt/api/catalog/payment-client-side/create-order-by-cart-id). A resposta retorna um token para abrir a interface de pagamento.\n\n5. Configure o rastreamento de status de pedidos, por exemplo, usando [webhooks](https://developers.xsolla.com/pt/webhooks/) para receber dados sobre itens pagos com sucesso prontamente e concedê-los ao usuário.\n\n\n
Nota
\n
Para implementar a venda de itens no jogo e online, consulte o guia de integração.
\n
\n \n \n | Status | \n Descrição | \n Observações | \n
\n \n \n \n new | \n O pedido é criado. O sistema aguarda pela confirmação do pagamento. | \n As descrições dos status de transação podem ser encontrados na documentação Pay Station API. | \n
\n \n paid | \n O pedido é pago (a transação mudou para o status done), e o item pode ser concedido ao usuário. | \n O pedido permanece no status new até que o pagamento seja confirmado. | \n
\n \n done | \n O item é concedido ao usuário. | \n — | \n
\n \n canceled | \n O pagamento foi reembolsado. | \n O pedido muda para esse status quando o status da transação muda para refunded. | \n
\n \n expired | \n Criar um novo pedido para um item, código promocional ou promoção limitados move qualquer pedido não pago contendo o item para o status expired. Apenas o pedido mais recente pode ser pago. | \n Se um usuário tentar pagar por um pedido expirado, a interface de pagamento exibirá um erro 2002, e o pagamento falhará. | \n
\n \n
\n\n\n\n\n
Nota
\n
Quando o pedido muda para o status expired enquanto o usuário conclui o pagamento, mas o pagamento é bem-sucedido, o pedido muda do status expired para paid. Isso só se aplica se o limite de compra para o item do pedido não será excedido pelo pagamento.
\n
\n Observação
\nA 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.\n
\n\n
\n\n5. Implemente a abertura da interface de pagamento para efetuar o pagamento do pedido.\n\n"
},
{
"name": "attribute-admin",
"x-displayName": "Admin"
},
{
"name": "item-groups-admin",
"x-displayName": "Admin"
},
{
"name": "item-groups-catalog",
"x-displayName": "Catálogo"
},
{
"name": "common-webhooks",
"x-displayName": "Webhooks"
}
],
"paths": {
"/v2/project/{project_id}/admin/items/virtual_items": {
"get": {
"summary": "Obter lista de itens virtuais",
"description": "Obtém a lista de itens virtuais dentro de um projeto para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Criar item virtual",
"description": "Cria um item virtual.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"description": "\n Nota
\n O schema do corpo de solicitação inclui parâmetros opcionais para casos de uso avançados, tais como a configuração de precificação regional, limites de compra, e disponibilidade por tempo limitado. Para criar um item básico, forneça os parâmetros sku, name e description. Para definir preços na moeda real, forneça o parâmetro prices, para moedas virtuais — vc_prices. Para tornar o item gratuito, defina is_free: true.\n
\n\n
",
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}": {
"get": {
"summary": "Obter lista de itens virtuais por ID de grupo especificado externo",
"description": "Obtém a lista de itens virtuais dentro de um grupo para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list-by-group-external-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}": {
"get": {
"summary": "Obter lista de itens virtuais por ID de grupo especificado",
"description": "Obtém a lista de itens virtuais dentro de um grupo para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/group_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list-by-group-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}": {
"get": {
"summary": "Obter item virtual",
"description": "Obtém o item virtual dentro de um projeto para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"operationId": "admin-get-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-item"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"put": {
"summary": "Atualizar item virtual",
"description": "Atualiza um item virtual.",
"operationId": "admin-update-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"description": "\n Nota
\n O schema do corpo de solicitação inclui parâmetros opcionais para casos de uso avançados, tais como a configuração de precificação regional, limites de compra, e disponibilidade por tempo limitado.\n
\n\n
\n\n\n Aviso
\n Passe todos os parâmetros de item, incluindo os que não precisam ser atualizados. Os parâmetros omitidos da solicitação serão removidos.\n
\n\n
",
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item"
},
"responses": {
"204": {
"description": "O item virtual foi atualizado com sucesso.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Excluir item virtual",
"description": "Exclui um item virtual.",
"operationId": "admin-delete-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "O item virtual foi excluído com sucesso.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency": {
"get": {
"summary": "Obter lista de moedas virtuais",
"description": "Obtém a lista de moedas virtuais dentro de um projeto para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-currencies-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currencies"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Criar moeda virtual",
"operationId": "admin-create-virtual-currency",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"description": "Cria uma moeda virtual.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}": {
"get": {
"summary": "Obter moeda virtual",
"description": "Obtém a moeda virtual dentro de um projeto para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"operationId": "admin-get-virtual-currency",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"virtual-items-currency-admin"
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Virtual-Items-Currency_404-item"
}
}
},
"put": {
"summary": "Atualizar moeda virtual",
"description": "Atualiza uma moeda virtual.",
"operationId": "admin-update-virtual-currency",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency"
},
"responses": {
"204": {
"description": "Moeda virtual atualizada com sucesso.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Excluir moeda virtual",
"description": "Exclui uma moeda virtual.",
"operationId": "admin-delete-virtual-currency",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "A moeda virtual foi excluída com sucesso.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/package": {
"get": {
"summary": "Obter lista de pacotes de moedas virtuais (admin)",
"description": "Obtém a lista de pacotes de moedas virtuais dentro de um projeto para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-currency-packages-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-packages"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Criar pacote de moedas virtuais",
"description": "Cria um pacote de moedas virtuais.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}": {
"put": {
"summary": "Atualizar pacote de moedas virtuais",
"description": "Atualiza um pacote de moedas virtuais.",
"operationId": "admin-update-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package"
},
"responses": {
"204": {
"description": "O item virtual foi atualizado com sucesso."
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Excluir pacote de moedas virtuais",
"description": "Exclui um pacote de moedas virtuais.",
"operationId": "admin-delete-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "O pacote de moedas virtuais foi atualizado com sucesso."
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"get": {
"summary": "Obter pacote de moedas virtuais",
"description": "Obtém o pacote de moedas virtuais dentro de um projeto para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"operationId": "admin-get-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-package"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/items/virtual_items": {
"get": {
"summary": "Obter lista de itens virtuais",
"description": "Recebe uma lista de itens virtuais para montar um catálogo.\n\n\n Aviso
\n Todos os projetos têm a limitação do número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
Veja também: A chamada de API Obter lista de todos os itens virtuais para busca ou indexação no lado do cliente.",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"operationId": "get-virtual-items",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional_fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
},
{
"$ref": "#/components/parameters/show_inactive_time_limited_items-query-param"
}
],
"tags": [
"virtual-items-currency-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-list"
}
}
}
},
"/v2/project/{project_id}/items/virtual_items/sku/{item_sku}": {
"get": {
"summary": "Obter item virtual por SKU",
"description": "Obtém um item virtual por SKU para criar um catálogo.\n\n\n
Aviso\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar\n dados de usuário
personalizados, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, veja o
bloco de Segurança\n para esta chamada.\n
\n Aviso
\n Retorna apenas SKU do item, nome, grupos e descrição.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
Veja também: A chamada de API Obter lista de itens virtuais para recuperar dados detalhados do item com paginação.",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"operationId": "get-all-virtual-items",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"virtual-items-currency-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-all-items-list"
}
}
}
},
"/v2/project/{project_id}/items/virtual_currency": {
"get": {
"summary": "Obter lista de moedas virtuais",
"description": "Recebe uma lista de moedas virtuais para montar um catálogo.\n\n\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
NoteIn general, the use of catalog of items is available without authorization.
Only authorized users can get
a personalized catalog. ",
"operationId": "get-item-groups",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"security": [],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/with_geo-query-param"
}
],
"tags": [
"item-groups-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-groups"
}
}
}
},
"/v2/project/{project_id}/admin/items/groups": {
"get": {
"summary": "Obter lista de grupo de itens",
"description": "Recupera a lista completa de grupos de itens dentro de um projeto sem paginação para fins administrativos.\n\nObservaçã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.
",
"operationId": "admin-get-item-group-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-list"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Criar grupo de itens",
"description": "Cria um grupo de itens dentro de um projeto.\nPara 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.",
"operationId": "admin-create-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_create"
},
"responses": {
"201": {
"$ref": "#/components/responses/ItemGroup_201-admin-create-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-create-update"
}
}
}
},
"/v2/project/{project_id}/admin/items/groups/{external_id}": {
"get": {
"summary": "Obter grupo de itens por ID externo",
"description": "Recupera um grupo de itens por seu ID externo para fins administrativos.\n\nObservaçã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.
",
"operationId": "admin-get-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
}
}
},
"put": {
"summary": "Atualizar grupo de itens",
"description": "Atualiza um grupo de itens por seu ID externo.",
"operationId": "admin-update-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_update"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-update-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-create-update"
}
}
},
"delete": {
"summary": "Excluir grupo de itens",
"description": "Exclui um grupo de itens por seu ID externo.",
"operationId": "admin-delete-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-delete-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-delete"
}
}
}
},
"/v2/project/{project_id}/admin/items/{item_type}/groups": {
"get": {
"summary": "Obter lista de grupos de itens filtrada por tipo de item",
"description": "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](/pt/api/catalog/item-groups-admin/admin-get-item-group-list) endpoint, with additional filtering of items by type when counting them.",
"operationId": "admin-get-item-group-list-by-item-type",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_type-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-list-by-item-type"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}": {
"get": {
"summary": "Obter grupo de itens por ID externo filtrado por tipo de item",
"description": "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](/pt/api/catalog/item-groups-admin/admin-get-item-group) endpoint, with additional filtering of items by type when counting them.",
"operationId": "admin-get-item-group-by-item-type",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_type-group-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-by-item-type"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
}
}
}
},
"/v2/project/{project_id}/admin/group/order": {
"put": {
"summary": "Reordenar grupos de itens",
"description": "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.",
"operationId": "admin-reorder-item-groups",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-groups"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-groups-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/admin/group/{external_id}/order/item": {
"put": {
"summary": "Reordenar itens dentro de um grupo (por ID externo)",
"description": "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.",
"operationId": "admin-reorder-items-in-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_item_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-items"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-items-by-external-id-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/admin/group/id/{id}/order/item": {
"put": {
"summary": "Reordenar itens dentro de um grupo (por ID)",
"description": "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.",
"operationId": "admin-reorder-items-in-group-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_item_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-items"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-items-by-id-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}": {
"post": {
"summary": "Criar pedido com item especificado comprado por moeda virtual",
"description": "Cria compra de item usando moeda virtual.
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
Observação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"operationId": "admin-get-game-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-games-list"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/sku/{item_sku}": {
"get": {
"summary": "Obter jogo (admin)",
"description": "Recebe um jogo para administração.\nO jogo consiste em chaves de jogo que podem ser compradas por um usuário.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"operationId": "admin-get-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Jogo não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
},
"put": {
"summary": "Atualizar jogo por SKU",
"description": "Atualiza um jogo no projeto por SKU.",
"operationId": "admin-update-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Game-Keys_create-update-game-model"
},
"responses": {
"201": {
"description": "O jogo foi atualizado com sucesso."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Jogo não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
},
"422": {
"$ref": "#/components/responses/Game-Keys_422-invalid-request"
}
}
},
"delete": {
"summary": "Excluir jogo por SKU",
"description": "Exclui um jogo no projeto por SKU.",
"operationId": "admin-delete-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Jogo excluído com sucesso."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/id/{item_id}": {
"get": {
"summary": "Obter jogo por ID (admin)",
"description": "Recebe um jogo para administração.\nO jogo consiste em chaves de jogo que podem ser compradas por um usuário.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"operationId": "admin-get-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Jogo não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 1 not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with id = 1 not found"
}
}
}
}
}
}
}
},
"put": {
"summary": "Atualizar jogo por ID",
"description": "Atualiza um jogo no projeto por ID.",
"operationId": "admin-update-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Game-Keys_create-update-game-model"
},
"responses": {
"201": {
"description": "O jogo foi atualizado com sucesso."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Jogo não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 1 not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with id = 1 not found"
}
}
}
}
}
},
"422": {
"$ref": "#/components/responses/Game-Keys_422-invalid-request"
}
}
},
"delete": {
"summary": "Excluir jogo por ID",
"description": "Exclui um jogo no projeto por ID.",
"operationId": "admin-delete-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Jogo excluído com sucesso."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}": {
"post": {
"summary": "Carregar códigos",
"description": "Carrega códigos por SKU de chave de jogo.",
"operationId": "admin-upload-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File with codes."
},
"region_id": {
"type": "integer",
"description": "ID de região."
}
},
"required": [
"file"
],
"example": {
"file": "keys.txt",
"region_id": 1
}
}
}
},
"required": true
},
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Chave de jogo ou região não encontrada.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}": {
"post": {
"summary": "Carregar códigos por ID",
"description": "Carrega códigos por ID de chave de jogo.",
"operationId": "admin-upload-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File with codes."
},
"region_id": {
"type": "integer",
"description": "ID de região."
}
},
"required": [
"file"
],
"example": {
"file": "keys.txt",
"region_id": 1
}
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Chave de jogo ou região não encontrada.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}": {
"get": {
"summary": "Obter códigos carregando informações da sessão",
"description": "Obtém códigos carregando informações de sessão.",
"operationId": "admin-get-codes-session",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"name": "session_id",
"in": "path",
"required": true,
"description": "ID da sessão.",
"schema": {
"type": "string",
"default": "fc7105b6e8ee01339582970b37697242"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Sessão de carregamento de códigos não encontrada."
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}": {
"get": {
"summary": "Obter códigos",
"description": "Obtém um certo número de códigos por SKU de chave de jogo.",
"operationId": "admin-get-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/quantity-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Chave de jogo ou região não encontrada.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/request/id/{item_id}": {
"get": {
"summary": "Obter códigos por ID",
"description": "Obtém um certo número de códigos por ID de chave de jogo.",
"operationId": "admin-get-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/quantity-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Chave de jogo ou região não encontrada.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}": {
"delete": {
"summary": "Excluir códigos",
"description": "Exclui todos os códigos por SKU de chave de jogo.",
"operationId": "admin-delete-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Chave de jogo ou região não encontrada.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}": {
"delete": {
"summary": "Excluir códigos por ID",
"description": "Exclui todos os códigos por ID de chave de jogo.",
"operationId": "admin-delete-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Chave de jogo ou região não encontrada.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/entitlement": {
"get": {
"tags": [
"game-keys-entitlement"
],
"operationId": "get-user-games",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/sandbox-query-param"
},
{
"$ref": "#/components/parameters/additional_fields-entitlement-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-user-entitlement-list"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
},
"summary": "Obter lista de jogos de propriedade do usuário",
"description": "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.\n\n\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n Aviso
\n Você pode resgatar códigos apenas para a plataforma sem DRM.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
Atenção
Códigos de jogos ou jogos para plataformas sem DRM podem ser apenas concedidos.
",
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_external_id",
"game",
"drm",
"mode"
],
"properties": {
"user_external_id": {
"type": "string",
"example": "user-external-id",
"description": "Unique user identifier."
},
"game": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
}
},
"example": {
"game": {
"sku": "com.xsolla.game_1"
}
},
"description": "Object with game properties."
},
"drm": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
}
},
"example": {
"drm": {
"sku": "com.xsolla.key_1"
}
},
"description": "Object with DRM properties."
},
"code": {
"type": [
"string",
"null"
],
"example": "AAAA-BBBB-CCCC-DDDD",
"description": "Game code of the game."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "What type of entitlements should be granted. If the parameter is set to `sandbox`, the entitlement will be granted to the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be granted to the user in the live mode."
},
"user_country": {
"type": [
"string",
"null"
],
"example": "US",
"description": "User's country."
}
},
"example": {
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"code": "AAAA-BBBB-CCCC-DDDD",
"mode": "default",
"user_country": "US"
}
}
}
},
"required": true
}
}
},
"/v2/project/{project_id}/admin/entitlement/revoke": {
"post": {
"tags": [
"game-keys-entitlement"
],
"operationId": "revoke-entitlement-admin",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"204": {
"description": "Revogação bem-sucedida."
},
"403": {
"$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent"
},
"422": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 5103
},
"errorMessage": {
"type": "string",
"example": "[0401-5103]: Selected drm is not drmfree."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"type": "object"
},
"examples": {
"DRM is not DRM free": {
"value": {
"statusCode": 422,
"errorCode": 5103,
"errorMessage": "[0401-5103]: Selected drm is not drmfree.",
"transactionId": "transaction id"
}
}
}
}
}
}
},
"summary": "Revogar direito (admin)",
"description": "Revoga o direito do usuário.\n\nAtenção
Códigos de jogos ou jogos para plataformas sem DRM podem ser apenas revogados.
",
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_external_id",
"game",
"drm",
"mode"
],
"properties": {
"user_external_id": {
"type": "string",
"example": "user-external-id",
"description": "Unique user identifier."
},
"game": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
}
},
"example": {
"game": {
"sku": "com.xsolla.game_1"
}
},
"description": "Object with game properties."
},
"drm": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
}
},
"example": {
"drm": {
"sku": "com.xsolla.key_1"
}
},
"description": "Object with DRM properties."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "What type of entitlements should be revoked. If the parameter is set to `sandbox`, the entitlement will be revoked from the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be revoked from the user in the live mode."
}
},
"example": {
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"mode": "default"
}
}
}
},
"required": true
}
}
},
"/v2/project/{project_id}/admin/items/bundle": {
"get": {
"summary": "Obter lista de pacotes",
"description": "Obtém a lista de pacotes dentro de um projeto para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"operationId": "admin-get-bundle-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Criar conjunto",
"description": "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](https://developers.xsolla.com/pt/items-catalog/items-type/bundles/).\n\nAviso
Todos os itens na matriz content devem ser criados no seu projeto antecipadamente. O sistema retorna um erro se o SKU especificado não existir.
",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"bundles-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Bundles_bundle"
},
"responses": {
"201": {
"$ref": "#/components/responses/Bundles_201-admin-create-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Bundles_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}": {
"get": {
"summary": "Obter lista de conjuntos por ID de grupo especificado",
"description": "Obtém a lista de conjuntos dentro de um grupo para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"operationId": "admin-get-bundle-list-in-group-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/group_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}": {
"get": {
"summary": "Obter lista de conjuntos por ID de grupo externo especificado",
"description": "Obtém a lista de conjuntos dentro de um grupo para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"operationId": "admin-get-bundle-list-in-group-by-external-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}": {
"put": {
"summary": "Conjunto de atualização",
"description": "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](https://developers.xsolla.com/pt/items-catalog/items-type/bundles/).\n\nAviso
Todos os itens na matriz content devem ser criados no seu projeto antecipadamente. O sistema retorna um erro se o SKU especificado não existir.
",
"operationId": "admin-update-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Bundles_bundle"
},
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-update-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Bundles_422-invalid-request"
}
}
},
"delete": {
"summary": "Excluir conjunto",
"description": "Exclui um conjunto.",
"operationId": "admin-delete-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-delete-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
},
"get": {
"summary": "Obter conjunto",
"description": "Obtém o conjunto dentro de um projeto para administração.\n\nObservação
Não use esse ponto de extremidade para criar um catálogo de loja.
",
"operationId": "admin-get-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}/show": {
"put": {
"summary": "Mostrar conjunto no catálogo",
"description": "Mostra um conjunto em um catálogo.",
"operationId": "admin-show-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-show-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide": {
"put": {
"summary": "Ocultar conjunto no catálogo",
"description": "Oculta um conjunto em um catálogo.",
"operationId": "admin-hide-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-hide-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/items/bundle": {
"get": {
"summary": "Obter lista de pacotes",
"description": "Recebe uma lista de conjuntos para montar um catálogo.\n\n\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
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.
",
"operationId": "create-order-by-cart-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/payment/cart": {
"post": {
"summary": "Criar pedido com todos os itens do carrinho atual",
"description": "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`.\n\nO 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.\n\nPara 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.\n\nPara fins de teste, use este URL: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\nAviso 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.
",
"operationId": "create-order",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}": {
"post": {
"summary": "Criar pedido com item especificado",
"description": "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`.\n\nO 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.\n\nPara 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.\n\nPara fins de teste, use este URL: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\nAviso 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.
\n\n
\n\n\n Aviso
\n Esta chamada de API usa um JWT de usuário para autorização.
\n 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.\n
",
"operationId": "create-order-with-item",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"XsollaLoginUserJWT": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-with-specified-item-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-create-order-with-item-not-found-errors"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-create-order-with-item-invalid"
}
}
}
},
"/v2/project/{project_id}/free/cart": {
"post": {
"summary": "Criar pedido com carrinho grátis",
"description": "Cria um pedido com todos os itens do carrinho gratuito. O pedido criado receberá um status de pedido `done`.",
"operationId": "create-free-order",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"free-item"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Free_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/free/cart/{cart_id}": {
"post": {
"summary": "Criar pedido com carrinho gratuito específico",
"description": "Cria um pedido com todos os itens do carrinho gratuito específico. O pedido criado receberá um status de pedido `done`.",
"operationId": "create-free-order-by-cart-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
}
],
"tags": [
"free-item"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Free_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/free/item/{item_sku}": {
"post": {
"summary": "Criar pedido com item gratuito especificado",
"description": "Cria um pedido com um item gratuito especificado. O pedido criado terá o status de pedido `done`.
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
Aviso\n
\n O parâmetro
user.country.value é usado para selecionar uma moeda para o pedido. Se o país do usuário é desconhecido,\nfornecer 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.\n
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"payment-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-create-payment-token"
},
"responses": {
"201": {
"$ref": "#/components/responses/Cart-Payment_201-admin-create-payment-token"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-admin-create-payment-token"
}
}
}
},
"/v2/admin/project/{project_id}/cart/fill": {
"put": {
"summary": "Preencher o carrinho com itens",
"description": "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.",
"operationId": "admin-cart-fill",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/x-user-for-header"
},
{
"$ref": "#/components/parameters/x-user-id-header"
}
],
"tags": [
"cart-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-user"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/admin/project/{project_id}/cart/{cart_id}/fill": {
"put": {
"summary": "Preencha o ID do carrinho pelo carrinho com itens",
"description": "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.",
"operationId": "admin-fill-cart-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/x-user-for-header"
},
{
"$ref": "#/components/parameters/x-user-id-header"
}
],
"tags": [
"cart-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-user"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-all-user-items-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Atualizar todos os limites de compra para o usuário especificado",
"description": "Atualiza todos os limites de compra em todos os itens para um usuário especificado para que ele possa comprar esses itens novamente.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"description": "O limite foi atualizado com sucesso."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"User not found": {
"value": {
"statusCode": 404,
"errorCode": 5008,
"errorMessage": "[0401-5008]: Could not find User"
}
}
}
}
}
},
"422": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"value": {
"statusCode": 404,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"errorMessageExtended": [
{
"property": "user_external_id",
"message": "Must be at least 1 characters long"
},
{
"property": "user_external_id",
"message": "Does not match the regex pattern ^\\S+$"
}
]
}
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits"
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Atualizar limite de compra",
"description": "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.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"description": "O limite foi atualizado com sucesso."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits-flexible"
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}": {
"get": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"summary": "Obtenha o número de itens disponíveis para o usuário especificado",
"description": "Obtém o número restante de itens disponíveis para o usuário especificado dentro do limite aplicado.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
}
},
"post": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Aumente o número de itens disponíveis para o usuário especificado",
"description": "Aumenta o número restante de itens disponíveis para o usuário especificado dentro do limite aplicado.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
},
"Available item limit is out of range": {
"$ref": "#/components/examples/422-item-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
},
"put": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Defina o número de itens disponíveis para o usuário especificado",
"description": "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.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-flexible"
}
},
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Diminuir o número de itens disponíveis para o usuário especificado",
"description": "Diminui o número restante de itens disponíveis para o usuário especificado dentro do limite aplicado.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
},
"Available item limit is out of range": {
"$ref": "#/components/examples/422-item-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
}
},
"/v1/projects/{project_id}/import/from_external_file": {
"post": {
"tags": [
"connector-admin"
],
"operationId": "import-items-from-external-file",
"summary": "Importar itens via arquivo JSON",
"description": "Importa itens para a Store a partir de um arquivo JSON por meio da URL especificada. Consulte a [documentação](https://developers.xsolla.com/pt/doc/shop-builder/how-to/json-import/) para obter mais informações sobre a importação de um arquivo JSON.",
"servers": [
{
"url": "https://connector.xsolla.com"
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"responses": {
"201": {
"description": "O arquivo foi importado com sucesso e será processado agora.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"import_id": {
"type": "string",
"example": "af9f3638a16e11ef880da2cd677d2d24",
"description": "Import operation ID. If you encounter difficulties importing the JSON file, report this ID to your Customer Success Manager or send an email to csm@xsolla.com."
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/connector-422-validation-failed"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/connector-import-items-body"
}
}
},
"/v1/admin/projects/{project_id}/connectors/import_items/import/status": {
"get": {
"tags": [
"connector-admin"
],
"operationId": "get-items-import-status",
"summary": "Obter status da importação de itens",
"description": "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.",
"servers": [
{
"url": "https://connector.xsolla.com"
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-items-import-status-model"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
]
}
},
"/v2/project/{project_id}/admin/webhook/version": {
"put": {
"tags": [
"common-webhooks"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "update-webhook-version",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Atualizar versão de webhook",
"description": "Atualiza a versão do webhook do projeto. Na versão 2, parâmetros adicionais são incluídos na matriz `items`.\n\nPara mais informações sobre webhooks, veja [Configurar rastreamento de status do pedido](https://developers.xsolla.com/pt/doc/shop-builder/integration-guide/set-up-webhooks/).",
"responses": {
"204": {
"description": "Versão do webhook atualizada com sucesso."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"422": {
"description": "Erro de validação de solicitação.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request-extended"
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"errorMessageExtended": [
{
"property": "version",
"message": "Must have a minimum value of 1"
}
],
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
}
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Webhook version. Version 1 is used by default. In version 2, the `items` array includes the following parameters: `is_free`, `is_bonus`, and `is_bundle_content` parameters.",
"enum": [
1,
2
],
"example": 2
}
},
"required": [
"version"
]
},
"example": {
"version": 2
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}": {
"get": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Obter informações sobre o limite de pré-venda de itens",
"description": "Obtenha o limite de pré-venda do item.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliases para este ponto de extremidade:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"200": {
"description": "As informações sobre o limite de pré-venda do item foram recebidas com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 1
},
"sku": {
"type": "string",
"example": "com.xsolla.item_1"
},
"is_pre_order_limit_enabled": {
"type": "boolean",
"example": true
},
"available": {
"type": "integer",
"example": 431
},
"reserved": {
"type": "integer",
"example": 13
},
"sold": {
"type": "integer",
"example": 556
}
}
},
"examples": {
"response": {
"value": {
"item_id": 1,
"sku": "com.xsolla.item_1",
"is_pre_order_limit_enabled": true,
"available": 431,
"reserved": 13,
"sold": 556
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado."
}
}
},
"post": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Adicionar quantidade ao limite de pré-venda do item",
"description": "Adicione a quantidade ao limite de pré-venda do item.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliases para este ponto de extremidade:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"201": {
"description": "A quantidade a ser limitada foi adicionada com sucesso."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to add."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
},
"put": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Definir o limite de pré-venda da quantidade de item",
"description": "Defina a quantidade do limite de pré-venda do item.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliases para este ponto de extremidade:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "A quantidade a ser limitada foi definida com sucesso."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to set."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
},
"delete": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Remover a quantidade de limite de pré-venda do item",
"description": "Remova a quantidade do limite de pré-venda do item.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliases para este ponto de extremidade:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "A quantidade a ser limitada foi removida com sucesso."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to remove."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle": {
"put": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "toggle-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Alternar o limite de pré-venda do item",
"description": "Ativar/desativar limite de pré-venda do item.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliases para este ponto de extremidade:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/toggle",
"responses": {
"204": {
"description": "O limite foi desabilitado/habilitado."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"is_pre_order_limit_enabled": {
"type": "boolean"
}
},
"required": [
"is_pre_order_limit_enabled"
]
},
"example": {
"is_pre_order_limit_enabled": true
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all": {
"delete": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-all-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Remover toda a quantidade de limite de pré-venda do item",
"description": "Remova o limite de pré-venda do item.\n\nA 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:\n* [Chaves de Jogo](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-game/)\n* [Itens e Moedas Virtuais](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Conjuntos](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliases para este ponto de extremidade:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all",
"responses": {
"204": {
"description": "O limite foi removido com êxito."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Item não encontrado."
}
}
}
},
"/v2/merchant/{merchant_id}/projects": {
"get": {
"tags": [
"common-merchant"
],
"operationId": "get-projects",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicMerchantAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/merchant_id-path-param"
}
],
"summary": "Obter projetos",
"description": "Obtém a lista de projetos do comerciante.\n\n\n
Aviso
Essa 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.
\n
\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
\n Atenção
\n Todos os projetos têm uma limitação no número de itens que você pode\n obter na resposta. O valor padrão e máximo é 50 itens\n por resposta. Para obter mais dados página por página, use os campos limit\n e offset.\n
\n\n
\n\n\n
Nota\n Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem\n autorização. Use a autorização para recuperar\n
dados personalizados\n do usuário, como limites e promoções associadas ao item.\n Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.\n Para mais informações sobre o JWT do usuário, consulte o bloco
Segurança\n para esta chamada.\n
Aviso
Se você excluir um atributo de item, todos os seus dados e conexões com itens serão perdidos.
",
"operationId": "delete-attribute",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Atributo excluído com sucesso."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/attribute/{external_id}/value": {
"post": {
"summary": "Criar valor de atributo",
"description": "Cria um valor de atributo.\n\nAtenção
Todos 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.
",
"operationId": "admin-create-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-update-attribute-value"
},
"tags": [
"attribute-admin"
],
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-attribute-value"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
},
"404": {
"$ref": "#/components/responses/404-attribute-not-found"
},
"422": {
"$ref": "#/components/responses/422-create-update-attribute-value"
}
}
},
"delete": {
"summary": "Excluir todos os valores do atributo",
"description": "Exclui todos os valores do atributo.\n\nAvisoSe 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.
",
"operationId": "admin-delete-all-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Os valores de atributo foram excluídos com sucesso."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
},
"/v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}": {
"put": {
"summary": "Atualizar valor do atributo",
"description": "Atualiza os valores de um atributo.",
"operationId": "admin-update-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_external_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-update-attribute-value"
},
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "O valor do atributo foi atualizado com sucesso."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
},
"404": {
"$ref": "#/components/responses/404-attribute-value-not-found"
},
"422": {
"$ref": "#/components/responses/422-create-update-attribute-value"
}
}
},
"delete": {
"summary": "Excluir valor de atributo",
"description": "Exclui um valor de atributo.\n\nAvisoSe 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.
",
"operationId": "admin-delete-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_external_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "O valor do atributo foi excluído com sucesso."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
}
},
"components": {
"securitySchemes": {
"basicAuth": {
"type": "http",
"description": "Chamadas do lado do servidor usam o esquema de autenticação `basicAuth`. Todas as solicitações para a API devem\nconter o cabeçalho `Authorization: Basic `,\nonde `your_authorization_basic_key` é o par `project_id:api_key`\ncodificado de acordo com o padrão Base64.\n\nVocê pode usar `merchant_id` em vez de `project_id` se precisar. Isso não afeta a funcionalidade.\n\nVá para a [Conta de Distribuidor](https://publisher.xsolla.com/) para encontrar valores dos parâmetros:\n\n* `merchant_id` é mostrado:\n * Na seção **Configurações da empresa > Empresa**\n * 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/`.\n* `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:\n * [Configurações da empresa > Chaves de API](https://publisher.xsolla.com/0/settings/api_key)\n * [Configurações do projeto > Chaves de API](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n{% html name=\"div\" attrs={\"class\": \"notice\"} %}\n**Aviso**\n\nSe 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.\n{% /html %}\n\n* `project_id` é mostrado:\n * Na Conta de Distribuidor ao lado do nome do projeto.\n * 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/`.\n\nPara 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).",
"scheme": "basic"
},
"XsollaLoginUserJWT": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "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).\n\nAlternativamente, você pode usar um [token para abrir a interface de pagamento](/pt/api/pay-station/token/create-token)."
},
"AuthForCart": {
"type": "http",
"scheme": "bearer",
"description": "O esquema de autenticação `AuthForCart` é utilizado para as compras de carrinhos e suporta dois modos:\n\n1. 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.\n\nAlternativamente, você pode usar um [token para abrir a interface de pagamento](/pt/api/pay-station/token/create-token).\n\n2. 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:\n* `x-unauthorized-id` com um ID de solicitação\n* `x-user` com o endereço de e-mail do usuário codificado em Base64."
},
"basicMerchantAuth": {
"type": "http",
"description": "Chamadas do lado do servidor usam o esquema de autenticação `basicMerchantAuth`. Todas as solicitações para a API devem\nconter o cabeçalho `Authorization: Basic `,\nonde `your_authorization_basic_key` é o par `merchant_id:api_key`\ncodificado de acordo com o padrão Base64.\n\nVá para a [Conta de Distribuidor](https://publisher.xsolla.com/) para encontrar valores dos parâmetros:\n\n* `merchant_id` é mostrado:\n * Na seção **Configurações da empresa > Empresa**\n * 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/`\n* `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).\n\nPara 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).",
"scheme": "basic"
}
},
"parameters": {
"project_id-path-param": {
"name": "project_id",
"in": "path",
"required": true,
"description": "ID de projeto. Você pode encontrar esse parâmetro na sua [Conta de Distribuidor](https://publisher.xsolla.com/0/projects/0/), próximo ao nome do projeto e na barra de endereços do navegador ao trabalhar com um projeto. O URL tem o seguinte formato: `https://publisher.xsolla.com//projects/`.",
"schema": {
"type": "integer",
"example": 44056
}
},
"limit-query-param": {
"name": "limit",
"in": "query",
"example": 50,
"required": false,
"description": "Limite da quantidade de elementos na página.",
"schema": {
"type": "integer",
"example": 50,
"minimum": 1
}
},
"offset-query-param": {
"name": "offset",
"in": "query",
"required": false,
"example": 0,
"description": "Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).",
"schema": {
"type": "integer",
"example": 0,
"minimum": 0
}
},
"external_id-group-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "[ID de grupo de itens externo](/pt/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id) especificado durante a criação.",
"schema": {
"type": "string",
"example": "weapons"
}
},
"group_id-path-param": {
"name": "group_id",
"in": "path",
"required": true,
"description": "ID do grupo.",
"schema": {
"type": "integer",
"example": 10
}
},
"item_sku-path-param": {
"name": "item_sku",
"in": "path",
"required": true,
"description": "SKU do item.",
"schema": {
"type": "string",
"example": "booster_mega_1"
}
},
"virtual_currency_sku-path-param": {
"name": "virtual_currency_sku",
"in": "path",
"required": true,
"description": "SKU de moeda virtual.",
"schema": {
"type": "string",
"example": "crystal"
}
},
"locale-query-param": {
"name": "locale",
"in": "query",
"required": false,
"description": "Idioma de resposta. Código de idioma de duas letras minúsculas, de acordo com o padrão ISO 639-1 (por exemplo, `en`). Códigos de localização de cinco caracteres (por exemplo, `en-US`) são suportados nos campos de tradução, tais como `name` e `description`, mas são normalizados a códigos de duas letras nas respostas. Você pode encontrar a lista completa de idiomas suportados na [documentação](https://developers.xsolla.com/pt/doc/shop-builder/references/supported-languages/).",
"schema": {
"type": "string",
"default": "en"
}
},
"additional_fields-query-param": {
"name": "additional_fields[]",
"in": "query",
"required": false,
"description": "Campos adicionais para incluir na resposta. Por padrão, esses campos não são retornados. Passe os valores necessários para incluí-los.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"media_list",
"order",
"long_description",
"custom_attributes",
"item_order_in_group"
]
}
}
},
"country-query-param": {
"name": "country",
"in": "query",
"required": false,
"description": "Código de país de duas letras maiúsculas de acordo com o padrão [ISO 3166-1 alfa-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Verifique a documentação para obter informações detalhadas sobre [os países suportados pela Xsolla](https://developers.xsolla.com/pt/doc/shop-builder/references/supported-countries/) e [o processo de determinação do país](https://developers.xsolla.com/pt/doc/shop-builder/features/pricing-policy/#pricing_policy_country_determination).",
"schema": {
"type": "string",
"example": "US"
}
},
"promo_code-query-param": {
"name": "promo_code",
"in": "query",
"required": false,
"description": "Código exclusivo que diferencia maiúsculas de minúsculas. Contém letras e números.",
"schema": {
"type": "string",
"example": "WINTER2021",
"minLength": 1,
"maxLength": 128
}
},
"show_inactive_time_limited_items-query-param": {
"name": "show_inactive_time_limited_items",
"in": "query",
"required": false,
"description": "Exibe itens de tempo limitado que não estão disponíveis para o usuário. O prazo de validade desses itens não começou ou já expirou.",
"schema": {
"type": "integer",
"example": 1,
"default": 0
}
},
"virtual_currency_package_sku-path-param": {
"name": "virtual_currency_package_sku",
"in": "path",
"required": true,
"description": "SKU de pacote de moedas virtuais.",
"schema": {
"type": "string",
"example": "crystal-pack"
}
},
"with_geo-query-param": {
"name": "with_geo",
"in": "query",
"required": false,
"description": "Se a informação de país e localização do usuário deve ser retornada nos cabeçalhos de resposta ou não. Se for `true`, a resposta incluirá os cabeçalhos `X-User-Locale-Code` e `X-User-Country-Code`.",
"schema": {
"type": "boolean",
"default": false
}
},
"item_type-group-path-param": {
"name": "item_type",
"in": "path",
"required": true,
"description": "Tipo de item usado para filtrar grupos. Determina quais itens são inclusos na `items_count`. Valores contendo `/` (por exemplo, `virtual_currency/package` ou `game/key`) devem ter codificação de URL (por exemplo, `virtual_currency%2Fpackage`).",
"schema": {
"type": "string",
"enum": [
"virtual_items",
"virtual_currency",
"virtual_currency/package",
"game/key",
"bundle",
"game",
"value_points",
"subscription_plans"
],
"example": "virtual_items"
}
},
"id-group-path-param": {
"name": "id",
"in": "path",
"required": true,
"description": "ID de grupo de itens atribuído pela Xsolla.",
"schema": {
"type": "integer",
"example": 1
}
},
"platform-query-param": {
"name": "platform",
"in": "query",
"required": false,
"description": "Plataforma de distribuição na qual o usuário joga: `xsolla` (padrão), `playstation_network`, `xbox_live`, `pc_standalone`, `nintendo_shop`, `google_play`, `app_store_ios`, `android_standalone`, `ios_standalone`, `android_other`, `ios_other`, `pc_other`.",
"schema": {
"type": "string",
"enum": [
"playstation_network",
"xbox_live",
"xsolla",
"pc_standalone",
"nintendo_shop",
"google_play",
"app_store_ios",
"android_standalone",
"ios_standalone",
"android_other",
"ios_other",
"pc_other"
],
"default": "xsolla"
}
},
"item_id-path-param": {
"name": "item_id",
"in": "path",
"required": true,
"description": "ID do item.",
"schema": {
"type": "string",
"example": "656"
}
},
"user_email-query-param": {
"name": "user_email",
"in": "query",
"required": true,
"description": "E-mail do usuário.",
"schema": {
"type": "string",
"example": "email@email.com"
}
},
"quantity-query-param": {
"name": "quantity",
"in": "query",
"required": true,
"description": "Quantidade de códigos.",
"schema": {
"type": "integer",
"example": 100
}
},
"reason-query-param": {
"name": "reason",
"in": "query",
"required": true,
"description": "Razão de recebimento de códigos.",
"schema": {
"type": "string",
"example": "Very important"
}
},
"region_id-query-param": {
"name": "region_id",
"in": "query",
"required": false,
"description": "ID de região.",
"schema": {
"type": "integer",
"default": 1
}
},
"sandbox-query-param": {
"name": "sandbox",
"in": "query",
"required": false,
"description": "Que tipo de direitos devem ser devolvidos. Se o parâmetro for definido como 1, apenas os direitos recebidos pelo usuário no modo sandbox serão retornados. Se o parâmetro não for passado ou estiver definido como 0, apenas os direitos recebidos pelo usuário no modo ativo serão retornados.",
"schema": {
"type": "integer",
"default": 0
}
},
"additional_fields-entitlement-query-param": {
"name": "additional_fields[]",
"in": "query",
"required": false,
"description": "A lista de campos adicionais. Esses campos estarão na resposta se você enviá-los em sua solicitação. `attributes` de campos disponíveis.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"sku-path-param": {
"name": "sku",
"in": "path",
"required": true,
"description": "SKU de conjunto.",
"schema": {
"type": "string",
"example": "kg_1"
}
},
"cart_id-path-param": {
"name": "cart_id",
"in": "path",
"required": true,
"description": "ID do carrinho.",
"schema": {
"type": "string",
"example": "custom_id"
}
},
"currency-query-param": {
"name": "currency",
"in": "query",
"required": false,
"description": "A moeda do preço do item exibida no carrinho. Código de moeda de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/).",
"schema": {
"type": "string",
"default": "USD"
}
},
"order_id-path-param": {
"name": "order_id",
"in": "path",
"required": true,
"description": "ID de pedido.",
"schema": {
"type": "string",
"example": "656"
}
},
"x-user-for-header": {
"in": "header",
"name": "x-user-for",
"example": "ACCESS_TOKEN/LOGIN_JWT",
"schema": {
"type": "string"
},
"required": false,
"description": "O identificador do usuário pode ser transferido usando o Xsolla Login User JWT ou o [token de acesso Pay Station](https://developers.xsolla.com/pt/pay-station-api/current/token/create-token)."
},
"x-user-id-header": {
"in": "header",
"name": "x-user-id",
"example": "UNIQUE_ID",
"schema": {
"maxLength": 32,
"type": "string"
},
"required": false,
"description": "Você pode usar seu próprio ID de usuário ao vender um carrinho com jogos."
},
"user_external_id-query-param": {
"name": "user_external_id",
"in": "query",
"required": true,
"description": "ID externo de usuário",
"schema": {
"type": "string",
"example": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
},
"merchant_id-path-param": {
"name": "merchant_id",
"in": "path",
"required": true,
"description": "ID de comerciante.",
"schema": {
"type": "integer",
"example": 121212
}
},
"project_id_59080-path-param": {
"name": "project_id",
"in": "path",
"required": true,
"description": "ID do projeto. Você pode encontrar esse parâmetro em sua [Conta de Distribuidor](https://publisher.xsolla.com/) ao lado do nome do projeto.",
"schema": {
"type": "integer",
"example": 59080
}
},
"item_id_59080-path-param": {
"name": "item_id",
"in": "path",
"required": true,
"description": "ID do item.",
"schema": {
"type": "string",
"example": "259774"
}
},
"item_sku_59080-path-param": {
"name": "sku",
"in": "path",
"required": true,
"description": "SKU do item.",
"schema": {
"type": "string",
"example": "electric_shield"
}
},
"external_id_59080-group-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "ID externo de grupo.",
"schema": {
"type": "string",
"default": "armour"
}
},
"region_id-path-param": {
"name": "region_id",
"in": "path",
"required": true,
"description": "ID de região. Identificador de região exclusivo dentro do projeto.",
"schema": {
"type": "integer",
"example": 42
}
},
"external_id-attr-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "ID externo de atributo.",
"schema": {
"type": "string",
"example": "attribute_id"
}
},
"value_external_id-path-param": {
"name": "value_external_id",
"in": "path",
"required": true,
"description": "Valor de atributo de ID externo.",
"schema": {
"type": "string",
"pattern": "^[-_\\.\\d\\w]+$",
"example": "value_id"
}
}
},
"schemas": {
"Virtual-Items-Currency_sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "booster_mega_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "ID de atributo exclusivo. O `external_id` só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados."
},
"admin-attribute-name": {
"type": "object",
"description": "Objeto com localizações para o nome do atributo. As chaves são especificadas no formato ISO 3166-1.",
"additionalProperties": {
"type": "string"
},
"example": {
"en": "Genre",
"de": "Genre"
},
"default": {
"en": "Genre",
"de": "Genre"
}
},
"value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "ID de valor exclusivo para um atributo. O `external_id` pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados."
},
"value-name": {
"type": "object",
"description": "Objeto com traduções do nome do valor. As chaves são especificadas no formato ISO 3166-1.",
"additionalProperties": {
"type": "string"
},
"example": {
"en": "Strategy",
"de": "Strategie"
},
"default": {
"en": "Strategy",
"de": "Strategie"
}
},
"attribute-value": {
"type": "object",
"required": [
"value",
"external_id"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"$ref": "#/components/schemas/value-name"
}
},
"example": {
"external_id": "value_external_id",
"name": {
"en": "Value 1",
"de": "Wert 1"
}
}
},
"attribute": {
"type": "object",
"required": [
"external_id",
"values"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attribute-value"
},
"example": [
{
"external_id": "strategy",
"value": {
"en": "Strategy",
"de": "Strategie"
}
},
{
"external_id": "action",
"value": {
"en": "Action",
"de": "Aktion"
}
}
]
}
},
"example": {
"external_id": "attribute_external_id",
"name": {
"en": "Attribute name",
"de": "Attributname"
},
"values": [
{
"external_id": "value_1",
"name": {
"en": "value 1",
"de": "wert 1"
}
},
{
"external_id": "value_2",
"name": {
"en": "value 2",
"de": "wert 2"
}
}
]
}
},
"Virtual-Items-Currency_schemas-admin-attributes": {
"type": "array",
"description": "Lista de atributos.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Virtual-Items-Currency_admin-attributes": {
"allOf": [
{
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-attributes"
},
{
"description": "Lista de atributos."
}
]
},
"two-letter-locale": {
"type": [
"object",
"null"
],
"description": "Códigos de idioma minúsculos de duas letras.",
"title": "duas letras",
"properties": {
"en": {
"type": [
"string",
"null"
],
"description": "Inglês"
},
"ar": {
"type": [
"string",
"null"
],
"description": "Árabe"
},
"bg": {
"type": [
"string",
"null"
],
"description": "Búlgaro"
},
"cn": {
"type": [
"string",
"null"
],
"description": "Chinês (Simplificado)"
},
"cs": {
"type": [
"string",
"null"
],
"description": "Tcheco"
},
"de": {
"type": [
"string",
"null"
],
"description": "Alemão"
},
"es": {
"type": [
"string",
"null"
],
"description": "Espanhol (Espanha)"
},
"fr": {
"type": [
"string",
"null"
],
"description": "Francês"
},
"he": {
"type": [
"string",
"null"
],
"description": "Hebraico"
},
"it": {
"type": [
"string",
"null"
],
"description": "Italiano"
},
"ja": {
"type": [
"string",
"null"
],
"description": "Japonês"
},
"ko": {
"type": [
"string",
"null"
],
"description": "Coreano"
},
"pl": {
"type": [
"string",
"null"
],
"description": "Polonês"
},
"pt": {
"type": [
"string",
"null"
],
"description": "Português"
},
"ro": {
"type": [
"string",
"null"
],
"description": "Romeno"
},
"ru": {
"type": [
"string",
"null"
],
"description": "Russo"
},
"th": {
"type": [
"string",
"null"
],
"description": "Tailandês"
},
"tr": {
"type": [
"string",
"null"
],
"description": "Turco"
},
"tw": {
"type": [
"string",
"null"
],
"description": "Chinês (Tradicional)"
},
"vi": {
"type": [
"string",
"null"
],
"description": "Vietnamita"
},
"km": {
"type": [
"string",
"null"
],
"description": "Khmer"
},
"id": {
"type": [
"string",
"null"
],
"description": "Indonésio"
},
"lo": {
"type": [
"string",
"null"
],
"description": "Lao"
},
"my": {
"type": [
"string",
"null"
],
"description": "Birmanês"
},
"ph": {
"type": [
"string",
"null"
],
"description": "Filipino"
},
"ne": {
"type": [
"string",
"null"
],
"description": "Nepalês"
}
}
},
"five-letter-locale": {
"type": [
"object",
"null"
],
"description": "Códigos de localidade de cinco caracteres.",
"title": "cinco letras",
"properties": {
"en-US": {
"type": [
"string",
"null"
],
"description": "Inglês"
},
"ar-AE": {
"type": [
"string",
"null"
],
"description": "Árabe"
},
"bg-BG": {
"type": [
"string",
"null"
],
"description": "Búlgaro"
},
"zh-CN": {
"type": [
"string",
"null"
],
"description": "Chinês (Simplificado)"
},
"cs-CZ": {
"type": [
"string",
"null"
],
"description": "Tcheco"
},
"de-DE": {
"type": [
"string",
"null"
],
"description": "Alemão"
},
"es-ES": {
"type": [
"string",
"null"
],
"description": "Espanhol (Espanha)"
},
"fr-FR": {
"type": [
"string",
"null"
],
"description": "Francês"
},
"he-IL": {
"type": [
"string",
"null"
],
"description": "Hebraico"
},
"it-IT": {
"type": [
"string",
"null"
],
"description": "Italiano"
},
"ja-JP": {
"type": [
"string",
"null"
],
"description": "Japonês"
},
"ko-KR": {
"type": [
"string",
"null"
],
"description": "Coreano"
},
"pl-PL": {
"type": [
"string",
"null"
],
"description": "Polonês"
},
"pt-BR": {
"type": [
"string",
"null"
],
"description": "Português (Brasil)"
},
"ro-RO": {
"type": [
"string",
"null"
],
"description": "Romeno"
},
"ru-RU": {
"type": [
"string",
"null"
],
"description": "Russo"
},
"th-TH": {
"type": [
"string",
"null"
],
"description": "Tailandês"
},
"tr-TR": {
"type": [
"string",
"null"
],
"description": "Turco"
},
"zh-TW": {
"type": [
"string",
"null"
],
"description": "Chinês (Tradicional)"
},
"vi-VN": {
"type": [
"string",
"null"
],
"description": "Vietnamita"
},
"km-KH": {
"type": [
"string",
"null"
],
"description": "Khmer"
},
"id-ID": {
"type": [
"string",
"null"
],
"description": "Indonésio"
},
"lo-LA": {
"type": [
"string",
"null"
],
"description": "Lao"
},
"my-MM": {
"type": [
"string",
"null"
],
"description": "Birmanês"
},
"ph-PH": {
"type": [
"string",
"null"
],
"description": "Filipino"
},
"ne-NP": {
"type": [
"string",
"null"
],
"description": "Nepalês"
}
}
},
"name-localization-object": {
"type": [
"object",
"null"
],
"description": "Objeto com traduções para o nome do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, `en`) ou códigos de idioma de cinco caracteres (por exemplo, `en-US`). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, `en` e `en-US`), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na [documentação](/pt/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"description-localization-object": {
"type": [
"object",
"null"
],
"description": "Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, `en`) ou códigos de localidade de cinco caracteres (por exemplo, `en-US`). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, `en` e `en-US`), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na [documentação](/pt/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"long-description-localization-object": {
"type": [
"object",
"null"
],
"description": "Objeto com traduções para a descrição longa do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, `en`) ou códigos de localidade de cinco caracteres (por exemplo, `en-US`). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as variantes para o mesmo idioma são fornecidas (por exemplo, `en` e `en-US`), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na [documentação](/pt/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"Virtual-Items-Currency_admin-groups-response": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"default": [],
"description": "Grupo aos quais o item pertence.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"description": "Nome do item. Deve conter pares chave/valor\nonde chave é uma localização com o formato \"^[a-z]{2}\", e o valor é uma cadeia de caracteres.",
"example": {
"en": "Horror",
"de": "Horror"
},
"default": {
"en": "Horror"
},
"additionalProperties": {
"type": "string"
}
}
}
}
},
"Virtual-Items-Currency_admin-media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Recursos adicionais do item, como capturas de tela, vídeos de jogabilidade e assim por diante.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Tipo de mídia: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Arquivo de recurso."
}
}
}
},
"Virtual-Items-Currency_type": {
"type": "string",
"description": "Tipo de item:`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`."
},
"Virtual-Items_admin-prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"description": "Quantidade.",
"type": "number",
"exclusiveMinimum": 0
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
},
"country_iso": {
"type": "string",
"description": "Código de país de duas letras maiúsculas de acordo com o padrão [ISO 3166-1 alfa-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Verifique a documentação para obter informações detalhadas sobre [os países suportados pela Xsolla](https://developers.xsolla.com/pt/doc/shop-builder/references/supported-countries/).
Exemplo: `country=US`",
"example": "US"
},
"is_default": {
"type": "boolean",
"default": false
},
"is_enabled": {
"type": "boolean",
"default": true
}
},
"example": {
"currency": "USD",
"amount": 10.5,
"is_default": true,
"is_enabled": true
}
}
},
"Virtual-Items-Currency_schemas-sku": {
"type": "string",
"example": "bundle_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"Virtual-Items-Currency_admin-get-vc_prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"sku",
"amount"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku"
},
"amount": {
"description": "Quantidade.",
"type": "number",
"exclusiveMinimum": 0
},
"is_default": {
"type": "boolean",
"default": false
}
},
"example": {
"sku": "com.xsolla.gold_1",
"amount": 10,
"is_default": true
}
}
},
"Virtual-Items-Currency_admin-image_url": {
"type": "string",
"description": "URL da imagem. Para que a imagem seja exibida corretamente e carregue rapidamente na interface de pagamento, confira as nossas diretrizes de imagens e URLs:- Formatos suportados: WebP (recomendado), PNG, JPG.
- Tamanho do arquivo: ≤ 50 KB (para WebP) ou ≤ 150 KB (para PNG e JPG).
- Tamanho da imagem: 280 x 280 px.
- Espaço de cores: sRGB.
- Protocolo: HTTPS com cache de longa duração para URLs versionados.
"
},
"value-is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Se o item é gratuito ou não."
},
"value-is_paid_randomized_reward": {
"type": "boolean",
"example": false,
"default": false,
"description": "Se o item é uma recompensa paga randomizada, como uma loot box."
},
"Virtual-Items-Currency_order": {
"type": "integer",
"example": 1,
"default": 1,
"description": "Ordem de exibição de itens no catálogo. Quanto maior o valor, menor o item aparece na lista.\nSe os valores forem os mesmos, os itens serão organizados por data de criação, com os itens mais novos sendo exibidos mais alto."
},
"Virtual-Items-Currency_is_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "Se o item está disponível ou não. Se for `false`, o item não poderá ser comprado na loja ou obtido como parte de um conjunto ou dentro de uma campanha de marketing. Consulte a nossa [documentação](https://developers.xsolla.com/pt/items-catalog/catalog-features/items-availability/) para obter informações detalhadas sobre a disponibilidade do item."
},
"Virtual-Items-Currency_is_show_in_store": {
"type": "boolean",
"example": true,
"default": false,
"description": "Se o item é exibido no catálogo ou não. Se for `false` e `is_enabled: true`, o item não é visível no catálogo, mas pode ser obtido como parte de um conjunto ou dentro de campanhas de marketing. Consulte a nossa [documentação](https://developers.xsolla.com/pt/items-catalog/catalog-features/items-availability/) para obter informações detalhadas sobre a disponibilidade do item."
},
"Virtual-Items-Currency_admin-regions": {
"description": "Matriz de regiões onde o item está disponível. Se a matriz estiver vazia ou não for passada, o item está disponível em todas as regiões.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"example": 1,
"description": "ID de regiõa dentro do projeto.\n\nConsulte a [documentação de restrição de vendas regionais](https://developers.xsolla.com/pt/items-catalog/catalog-features/regional-restrictions/) e as [chamadas de API de gestão de regiões](https://developers.xsolla.com/pt/api/catalog/common-regions) para obter informações detalhadas."
}
}
}
},
"limit_exceeded_visibility": {
"type": "string",
"example": "show",
"enum": [
"show",
"hide"
],
"description": "Determina a visibilidade do item no catálogo após o limite de compra ser atingido, até o próximo limite ser redefinido.\n\nAplica-se a itens para os quais redefinições recorrentes de limite estão configurados na matriz `recurrent_schedule`.\n\nSe os limites redefinidos não forem configurados, o item não aparecerá no catálogo após o limite de compra ser atingido,\nindependentemente do valor `limit_exceeded_visibility`.\n\nPossíveis valores:\n- `show` — O item é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido. Nas chamadas API\nde recuperação de catálogo, quando o limite for atingido, o item será retornado com a marcação `can_be_bought: false`. A próxima\ndata de redefinição é retornada em `reset_next_date`.\n- `hide` — O item não é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido, até\no limite ser redefinido.",
"default": "show"
},
"admin_recurrent_schedule_response": {
"type": [
"object",
"null"
],
"description": "Limite o período de atualização.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Período de atualização do limite do usuário.",
"oneOf": [
{
"type": "object",
"title": "interval_type = diariamente",
"description": "Tipo diário de atualização de limites de usuário.",
"properties": {
"interval_type": {
"type": "string",
"description": "Tipo de período de atualização recorrente.",
"enum": [
"daily"
]
},
"time": {
"type": "string",
"description": "Tempo de atualização do limite no fuso horário desejado (arredondamento para horas).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Data e hora em que os limites são atualizados (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Data e hora da primeira atualização de limite (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Data e hora em que os limites devem ser redefinidos (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = semanalmente",
"description": "Tipo semanal de atualização de limites de usuário.",
"properties": {
"interval_type": {
"type": "string",
"description": "Tipo de período de atualização recorrente.",
"enum": [
"weekly"
]
},
"day_of_week": {
"type": [
"integer",
"null"
],
"description": "Dia da semana em que os limites se atualizam. Onde 1 é segunda-feira e 7 é domingo. Não `null` apenas para o tipo de período de atualização de limite `weekly`.",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "Tempo de atualização do limite no fuso horário desejado (arredondamento para horas).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Data e hora em que os limites são atualizados (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Data e hora da primeira atualização de limite (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Data e hora em que os limites devem ser redefinidos (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = mensalmente",
"description": "Tipo mensal de atualização dos limites de usuário.",
"properties": {
"interval_type": {
"type": "string",
"description": "Tipo de período de atualização recorrente.",
"enum": [
"monthly"
]
},
"day_of_month": {
"type": [
"integer",
"null"
],
"description": "Dia do mês em que os limites são atualizados. Se não houver um dia selecionado do mês por ser mais curto, a atualização ocorrerá no último dia do mês. Não `null` apenas para o tipo de período de atualização de limite `monthly`.",
"minimum": 1,
"maximum": 31
},
"time": {
"type": "string",
"description": "Tempo de atualização do limite no fuso horário desejado (arredondamento para horas).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Data e hora em que os limites são atualizados (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Data e hora da primeira atualização de limite (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Data e hora em que os limites devem ser redefinidos (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = a cada hora",
"description": "Redefinição dos limites do usuário realizada em um intervalo de tempo especificado em horas.",
"properties": {
"interval_type": {
"type": "string",
"description": "Tipo de período de atualização recorrente.",
"enum": [
"hourly"
]
},
"hours_interval": {
"type": "integer",
"description": "Intervalo em horas, após o qual o limite é atualizado.
A contagem regressiva começa no momento em que o item é exibido pela primeira vez na loja, conforme especificado no parâmetro date_from.
Por exemplo, se `date_from = \"2025-11-15T18:15:00+05:00\"` e `hours_interval = 2`, o limite de compra deste item é atualizado a cada 2 horas, começando a partir de `\"2025-11-15T20:15:00+05:00\"`.",
"minimum": 1,
"maximum": 10000
},
"reset_next_date": {
"type": "integer",
"description": "Data e hora em que os limites são atualizados (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Data e hora da primeira atualização de limite (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Data e hora em que os limites devem ser redefinidos (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
}
]
}
}
},
"admin-item-limit-response": {
"type": [
"object",
"null"
],
"description": "Limites de itens.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Limitação de item para um usuário separado.",
"properties": {
"total": {
"type": "integer",
"description": "Quantidade máxima de itens que o usuário atual pode comprar."
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Limitação global de itens.",
"properties": {
"total": {
"type": "integer",
"description": "Quantidade máxima de itens que todos os usuários podem comprar."
},
"available": {
"type": "integer",
"description": "Quantidade restante de itens que todos os usuários podem comprar."
},
"reserved": {
"type": "integer"
},
"sold": {
"type": "integer"
}
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/admin_recurrent_schedule_response"
}
}
},
"item-periods-response": {
"type": "array",
"description": "Período de venda de itens.",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Data em que o item especificado estará disponível para venda."
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "Data em que o item especificado ficará indisponível para venda. Pode ser `null`."
}
}
}
},
"item-custom-attributes-response": {
"type": "object",
"description": "Um objeto JSON que contém atributos e valores de item.",
"format": "json"
},
"Virtual-Items-Currency_admin-virtual-item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
}
}
},
"Virtual-Items-Currency_schemas-admin-image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL da imagem. Para que a imagem seja exibida corretamente e carregue rapidamente na interface de pagamento, confira as nossas diretrizes de imagens e URLs:- Formatos suportados: WebP (recomendado), PNG, JPG.
- Tamanho do arquivo: ≤ 50 KB (para WebP) ou ≤ 150 KB (para PNG e JPG).
- Tamanho da imagem: 280 x 280 px.
- Espaço de cores: sRGB.
- Protocolo: HTTPS com cache de longa duração para URLs versionados.
"
},
"Virtual-Items-Currency_admin-groups-create": {
"type": "array",
"description": "Lista de [IDs externos de grupos](/pt/api/catalog/item-groups-admin/admin-get-item-group-list/#!path=groups/external_id&t=response) aos quais o item pertence.\n\nExemplo: [\"terror\", \"ação\"]",
"items": {
"type": "string",
"properties": {
"external_id": {
"type": "string",
"example": "accessory"
},
"name": {
"type": "string",
"example": "Accessory"
}
}
}
},
"admin-post-put-attribute-item": {
"type": "object",
"required": [
"external_id",
"values"
],
"maxItems": 6,
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
},
"values": {
"type": "array",
"description": "Atenção. Não é possível criar mais de 6 valores para cada atributo. Qualquer tentativa de exceder o limite resulta em um erro.
",
"items": {
"$ref": "#/components/schemas/attribute-value"
},
"example": [
{
"external_id": "strategy",
"value": {
"en": "Strategy",
"de": "Strategie"
}
},
{
"external_id": "action",
"value": {
"en": "Action",
"de": "Aktion"
}
}
]
}
}
},
"Virtual-Items-Currency_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Lista de atributos.\n\nAtenção. Não é possível especificar mais de 20 atributos para o item. Qualquer tentativa de exceder o limite resulta em um erro.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"Virtual-Items-Currency_admin-create-vc_prices": {
"description": "Matriz de preços em moedas virtuais.",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku"
},
"amount": {
"type": "integer",
"description": "Preço do item em moeda virtual."
},
"is_default": {
"type": "boolean",
"default": false,
"description": "Se o preço padrão é definido em uma moeda virtual ou não."
},
"is_enabled": {
"type": "boolean",
"default": true,
"description": "Se esse preço é utilizado para exibir no catálogo e para comprar o item. Se for `false`, o preço não é usado."
}
},
"required": [
"amount",
"sku",
"is_default",
"is_enabled"
],
"example": {
"sku": "com.xsolla.gold_1",
"amount": 10,
"is_default": true,
"is_enabled": true
}
}
},
"limit_per_user": {
"description": "Limitação de item para um usuário separado.",
"anyOf": [
{
"type": "null",
"description": "Sem limite de compra do item por usuário."
},
{
"type": "integer",
"description": "Quantidade máxima de itens que o usuário atual pode comprar.",
"example": 5
},
{
"type": "object",
"description": "Configuração detalhada do limite de compras.",
"properties": {
"total": {
"type": "integer",
"description": "Quantidade máxima de itens que o usuário atual pode comprar.",
"example": 5
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
}
]
},
"limit_per_item": {
"type": [
"integer",
"null"
],
"description": "Limitação global de itens.",
"example": 10
},
"per_user_daily": {
"type": "object",
"title": "interval_type = diariamente",
"description": "Tipo diário de atualização de limites de usuário.",
"properties": {
"interval_type": {
"type": "string",
"description": "Período de atualização recorrente.",
"enum": [
"daily"
]
},
"time": {
"type": "string",
"description": "Tempo de atualização do limite no fuso horário desejado (arredondamento para horas).",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "02:00:00+03:00"
}
},
"required": [
"interval_type",
"time"
]
},
"per_user_weekly": {
"type": "object",
"title": "interval_type = semanalmente",
"description": "Tipo semanal de atualização de limites de usuário.",
"properties": {
"interval_type": {
"type": "string",
"description": "Período de atualização recorrente.",
"enum": [
"weekly"
]
},
"day_of_week": {
"type": "integer",
"description": "Dia da semana em que os limites se atualizam. Onde 1 é segunda-feira e 7 é domingo.",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "Tempo de atualização do limite no fuso horário desejado (arredondamento para horas).",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "11:00:00+03:00"
}
}
},
"per_user_monthly": {
"type": "object",
"title": "interval_type = mensalmente",
"description": "Tipo mensal de atualização dos limites de usuário.",
"properties": {
"interval_type": {
"type": "string",
"description": "Período de atualização recorrente.",
"enum": [
"monthly"
]
},
"day_of_month": {
"type": "integer",
"description": "Dia do mês em que os limites são atualizados. Se não houver um dia selecionado do mês por ser mais curto, a atualização ocorrerá no último dia do mês.",
"minimum": 1,
"maximum": 31
},
"time": {
"type": "string",
"description": "Tempo de atualização do limite no fuso horário desejado (arredondamento para horas).",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "23:00:00+03:00"
}
},
"required": [
"interval_type",
"time",
"day_of_month"
]
},
"interval_type_hourly": {
"type": "string",
"description": "Período de atualização recorrente.",
"enum": [
"hourly"
]
},
"hours_interval": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"per_user_hourly_vi": {
"type": "object",
"title": "interval_type = a cada hora",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Intervalo em horas, após o qual o limite é redefinido.
A contagem começa a partir do parâmetro date_from.
Por exemplo, se `date_start = \"2025-11-15T18:15:00+05:00\"` e `hours_interval = 2`, o limite de compra para esse item será redefinido a cada 2 horas começando a partir de `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_item_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Limite o período de atualização.",
"properties": {
"per_user": {
"description": "Redefinição do limite de compra realizado no intervalo de tempo especificado em horas.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vi"
}
]
}
}
},
"Virtual-Item-item-limit": {
"type": "object",
"description": "Limites de itens.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_item_recurrent_schedule"
}
}
},
"item-periods": {
"type": [
"array",
"null"
],
"description": "Período de venda de itens.",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": "string",
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Data em que o item especificado estará disponível para venda."
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "Data em que o item especificado ficará indisponível para venda. Pode ser `null`."
}
}
}
},
"item-custom-attributes": {
"type": "object",
"description": "Um objeto JSON que contém atributos e valores de item. Os atributos permitem que você adicione mais informações a itens como o nível necessário do jogador para usar o item. Os atributos enriquecem a lógica interna do seu jogo e são acessíveis através de métodos GET e webhooks dedicados.",
"format": "json",
"maxLength": 500
},
"Virtual-Items-Currency_admin-create-virtual-item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Item-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Virtual-Items-Currency_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": "array"
}
}
},
"Virtual-Items-Currency_admin-prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
},
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"example": 10.5,
"description": "Preço do item em moeda real."
},
"is_default": {
"type": "boolean",
"default": false,
"description": "Se esse é o preço padrão em moeda real ou não. Consulte a nossa [documentação](https://developers.xsolla.com/pt/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination) para obter informações detalhadas sobre as configurações de preço."
},
"is_enabled": {
"type": "boolean",
"default": true,
"example": true,
"description": "Se esse preço é utilizado para exibir no catálogo e para comprar o item. Se for `false`, o preço não é usado e outro preço é aplicado. Consulte a nossa [documentação](https://developers.xsolla.com/pt/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination) para obter informações detalhadas sobre as configurações de preço."
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "País onde este preço está disponível. Código de duas letras de acordo com o padrão [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
},
"example": {
"currency": "USD",
"amount": 10.5,
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
}
},
"Virtual-Items-Currency_admin-virtual-currency": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
}
}
},
"per_user_hourly_vc": {
"type": "object",
"title": "interval_type = a cada hora",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Intervalo em horas, após o qual o limite é redefinido.
A contagem começa a partir do parâmetro date_from.
Por exemplo, se `date_start = \"2025-11-15T18:15:00+05:00\"` e `hours_interval = 2`, o limite de compra para esse item será redefinido a cada 2 horas começando a partir de `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_currency_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Limite o período de atualização.",
"properties": {
"per_user": {
"description": "Redefinição do limite de compra realizado no intervalo de tempo especificado em horas.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vc"
}
]
}
}
},
"Virtual-Currency-item-limit": {
"type": "object",
"description": "Limites de itens.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_currency_recurrent_schedule"
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency": {
"type": "object",
"required": [
"sku",
"name"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Currency-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Virtual-Items-Currency_admin-virtual-currency-package": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"bundle_type": {
"type": "string",
"default": "virtual_currency_package",
"example": "virtual_currency_package"
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"quantity": {
"type": "integer"
}
}
}
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"per_user_hourly_vcp": {
"type": "object",
"title": "interval_type = a cada hora",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Intervalo em horas, após o qual o limite é redefinido.
A contagem começa a partir do parâmetro date_from.
Por exemplo, se `date_start = \"2025-11-15T18:15:00+05:00\"` e `hours_interval = 2`, o limite de compra para esse item será redefinido a cada 2 horas começando a partir de `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_currency_package_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Limite o período de atualização.",
"properties": {
"per_user": {
"description": "Redefinição do limite de compra realizado no intervalo de tempo especificado em horas.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vcp"
}
]
}
}
},
"Virtual-Currency-Package-item-limit": {
"type": "object",
"description": "Limites de itens.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_currency_package_recurrent_schedule"
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency-package": {
"type": "object",
"required": [
"sku",
"name",
"description",
"content"
],
"anyOf": [
{
"required": [
"prices"
]
},
{
"required": [
"vc_prices"
]
}
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"content": {
"type": "array",
"minLength": 1,
"maxLength": 1,
"description": "O pacote de moedas virtuais deve conter apenas 1 posição de moeda virtual.",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"quantity": {
"type": "integer"
}
}
}
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Currency-Package-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Pagination_has-more": {
"type": "boolean",
"example": true,
"description": "Usado como um indicador de que há mais páginas."
},
"items_client_groups_response": {
"type": "array",
"example": [
{
"external_id": "exclusive",
"name": "Exclusive"
}
],
"default": [],
"description": "Grupo aos quais o item pertence.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "[ID de grupo de itens externo](/pt/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id) especificado durante a criação.",
"example": "exclusive"
},
"name": {
"type": "string",
"description": "Nome do grupo.",
"example": "Exclusive"
},
"item_order_in_group": {
"type": "integer",
"description": "A posição do item dentro do grupo que determina sua ordem de exibição.\nRetornado somente se solicitado pelo parâmetro de pesquisa `additional_fields[]`",
"example": 1
}
}
}
},
"Virtual-Items-Currency_client-attributes": {
"type": "array",
"description": "Lista de atributos e seus valores correspondentes ao item. Pode ser usado para a filtragem de catálogos.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "object",
"description": "Nome do atributo.",
"example": "Genre",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Valor do atributo.",
"example": "Strategy"
}
}
}
}
}
}
},
"client_virtual_prices_response": {
"type": "array",
"description": "Preços virtuais.",
"items": {
"type": "object",
"description": "Preço virtual.",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "Preço do item em moeda virtual."
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "Preço do item em moedas virtuais sem desconto. Sempre igual a `amount` já que descontos não são aplicados a preços em moedas virtuais."
},
"sku": {
"type": "string",
"example": "vc_gold",
"description": "SKU de moeda virtual."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Se o preço padrão é definido em uma moeda virtual ou não."
},
"image_url": {
"type": [
"string",
"null"
],
"example": "http://image.png",
"description": "URL de imagem da moeda virtual"
},
"name": {
"type": "string",
"example": "Gold",
"description": "Nome da moeda virtual."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Tipo de item. Para moedas virtuais, é `virtual_currency`."
},
"description": {
"type": [
"string",
"null"
],
"example": "In-game currency used to purchase weapons and upgrades",
"description": "Descrição da moeda virtual."
}
}
}
},
"Can_be_bought": {
"type": "boolean",
"example": true,
"description": "Se `true`, o usuário pode comprar um item."
},
"Catalog_item_promotions": {
"type": "array",
"description": "Promoções aplicadas a itens específicos no carrinho. A matriz é retornada nos seguintes casos:\n\n* Uma promoção de desconto é configurada para um item específico.\n\n* Um código promocional com a configuração **Desconto em itens selecionados** é aplicado.\n\nSe nenhuma promoção no nível do item for aplicada, é retornada uma matriz vazia.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"date_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"type": [
"string",
"null"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"bonus": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"type": "string",
"description": "Tipo de item bônus.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"physical_good",
"game_key",
"nft"
]
},
"name": {
"type": "string",
"description": "Nome do item bônus. Indisponível para o tipo de item bônus `physical_good`."
},
"image_url": {
"type": "string",
"description": "URL da imagem do item bônus. Indisponível para o tipo de item bônus `physical_good`."
},
"bundle_type": {
"type": "string",
"description": "Tipo de item de pacote de bônus. Disponível apenas para o tipo de item bônus `bundle`.",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
},
"limits": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"available": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
}
}
}
}
}
},
"catalog_recurrent_schedule_client_response": {
"type": [
"object",
"null"
],
"description": "O item limita o período de atualização recorrente para um usuário.",
"oneOf": [
{
"type": "object",
"title": "interval_type = diariamente",
"description": "Tipo diário de atualização de limites de usuário.",
"properties": {
"interval_type": {
"type": "string",
"description": "Tipo de período de atualização recorrente.",
"enum": [
"daily"
]
},
"reset_next_date": {
"type": "integer",
"description": "Tipo de período de atualização recorrente.",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = semanalmente",
"description": "Tipo semanal de atualização de limites de usuário.",
"properties": {
"interval_type": {
"type": "string",
"description": "Tipo de período de atualização recorrente.",
"enum": [
"weekly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Tipo de período de atualização recorrente.",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = mensalmente",
"description": "Tipo mensal de atualização dos limites de usuário.",
"properties": {
"interval_type": {
"type": "string",
"description": "Tipo de período de atualização recorrente.",
"enum": [
"monthly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Tipo de período de atualização recorrente.",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = a cada hora",
"description": "Redefinição dos limites do usuário realizada em um intervalo de tempo especificado em horas.",
"properties": {
"interval_type": {
"type": "string",
"description": "Tipo de período de atualização recorrente.",
"enum": [
"hourly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Tipo de período de atualização recorrente.",
"example": 1677553200
}
}
}
]
},
"client-item-limit-response": {
"type": [
"object",
"null"
],
"description": "Limites de itens.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Limitação de item para um usuário separado.",
"properties": {
"total": {
"type": "integer",
"description": "Quantidade máxima de itens que o usuário atual pode comprar."
},
"available": {
"type": "integer",
"description": "Quantidade restante de itens que o usuário atual pode comprar."
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Limitação global de itens.",
"properties": {
"total": {
"type": "integer",
"description": "Quantidade máxima de itens que todos os usuários podem comprar."
},
"available": {
"type": "integer",
"description": "Quantidade restante de itens que todos os usuários podem comprar."
}
}
}
}
},
"item_id": {
"type": "integer",
"example": 1,
"description": "ID de item exclusivo interno."
},
"value-point-sku": {
"type": "string",
"description": "ID de ponto de valor exclusivo."
},
"value-point-amount": {
"type": "integer",
"description": "Quantidade de pontos de valor."
},
"value-point-name": {
"type": "string",
"description": "Nome do ponto de valor."
},
"Common_admin-image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL da imagem."
},
"is_clan": {
"type": "boolean",
"description": "Se o ponto de valor é usado em cadeias de recompensa de clã ou não.",
"example": true
},
"client-item-value-point-reward": {
"type": "array",
"description": "Lista de recompensas de pontos de valor para o item.",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/value-point-sku"
},
"amount": {
"$ref": "#/components/schemas/value-point-amount"
},
"name": {
"$ref": "#/components/schemas/value-point-name"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
}
},
"Virtual-Items-Currency_item": {
"type": "object",
"properties": {
"item_id": {
"type": "number",
"description": "ID do item."
},
"sku": {
"type": "string",
"example": "big_rocket",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "object",
"example": "Big Rocket",
"description": "Nome do item.",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "object",
"example": "Big Rocket - description",
"description": "Descrição do item.",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "URL da imagem."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": [
"object",
"null"
],
"description": "Preços dos itens.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Preço do item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Tipo de item virtual.\n\nPossíveis valores:\n- `consumable` — Um item que desaparece do inventário após o uso (ex.: munição)..\n- `non_consumable` — Um item que permanece no inventário por um tempo ilimitado.\n- `non_renewing_subscription` — Item de tempo limitado que pode representar acesso a serviços ou conteúdos por um período específico.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/client-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Virtual-Items-Currency_item-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item"
}
}
}
},
"Catalog_item_limits": {
"description": "Limites de itens.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Limites de item para um usuário.",
"properties": {
"total": {
"type": "integer",
"description": "Quantidade máxima de itens que o usuário atual pode comprar.",
"example": 5
},
"available": {
"type": "integer",
"description": "Quantidade restante de itens que o usuário atual pode comprar.",
"example": 3
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Limites de item para um item.",
"properties": {
"total": {
"type": "integer",
"description": "Quantidade máxima de itens que todos os usuários podem comprar.",
"example": 5
},
"available": {
"type": "integer",
"description": "Quantidade restante de itens que todos os usuários podem comprar.",
"example": 3
}
}
}
},
"type": [
"object",
"null"
]
},
"Virtual-Items-Currency_virtual-currency": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "ID de item único atribuído pela Xsolla."
},
"sku": {
"type": "string",
"example": "crystal",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Crystals",
"description": "Nome do item."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "string",
"example": "Crystals - description",
"description": "Descrição do item."
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "URL da imagem."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": [
"object",
"null"
],
"description": "Preços dos itens.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Preço do item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response",
"example": [
{
"amount": 100,
"sku": "com.xsolla.crystals_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png"
}
]
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Virtual-Items-Currency_virtual-currency-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency"
}
}
}
},
"Virtual-Items-Currency_virtual-currency-package": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "ID de item único atribuído pela Xsolla."
},
"sku": {
"type": "string",
"example": "crystal-pack",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Crystal Pack",
"description": "Nome do item."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "bundle",
"description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`."
},
"bundle_type": {
"type": "string",
"example": "virtual_currency_package",
"description": "Tipo de conjunto. Sempre `virtual_currency_package` para pacotes de moedas virtuais."
},
"description": {
"type": "string",
"example": "Crystal Pack Description",
"description": "Descrição do item."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/items/crystal-pack.png",
"description": "URL da imagem."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Preços dos itens.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Preço do item sem desconto."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"content": {
"type": "array",
"example": [
{
"description": "Crystal - short description",
"image_url": "https://cdn.xsolla.net/items/crystal-pack.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100
}
],
"description": "Conteúdo do pacote de moedas virtuais.",
"items": {
"type": "object",
"description": "Moeda virtual em um pacote.",
"properties": {
"item_id": {
"type": "integer",
"description": "ID de item único atribuído pela Xsolla."
},
"sku": {
"type": "string",
"example": "com.xsolla.crystal_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Crystals",
"description": "Nome do item."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Tipo de item. Para moedas virtuais, é `virtual_currency`."
},
"description": {
"type": "string",
"example": "Crystals - description",
"description": "Descrição do item."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/items/crystal-pack.png",
"description": "URL da imagem."
},
"quantity": {
"type": "integer",
"example": 250,
"description": "Quantidade de moeda virtual no pacote."
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Virtual-Items-Currency_virtual-currency-packages": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package"
}
}
}
},
"group-name-localization-object": {
"type": [
"object",
"null"
],
"description": "Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, `en`) ou códigos de localidade de cinco caracteres (por exemplo, `en-US`). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, `en` e `en-US`), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na [documentação](/pt/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"group-description-localization-object": {
"type": [
"object",
"null"
],
"description": "Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, `en`) ou códigos de localidade de cinco caracteres (por exemplo, `en-US`). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, `en` e `en-US`), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na [documentação](/pt/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"group-image-url": {
"type": [
"string",
"null"
],
"description": "URL da imagem do grupo de itens.",
"example": "https://example.com/weapons.png"
},
"group-display-order": {
"type": "integer",
"description": "Ordem de exibição do grupo de itens no catálogo. Quanto maior o valor, mais baixa a posição do grupo na lista. Se os valores forem iguais, os grupos serão organizados por data de criação, com os mais novos sendo exibidos mais alto.",
"default": 1,
"example": 1
},
"group-is-enabled": {
"type": "boolean",
"description": "Se o grupo de itens fica ativado no catálogo.",
"example": true,
"default": true
},
"admin-group-response-base": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID de grupo de itens atribuído pela Xsolla.",
"example": 1
},
"external_id": {
"type": "string",
"description": "ID de grupo de itens externo especificado durante a criação.",
"example": "weapons"
},
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/group-image-url"
},
"order": {
"$ref": "#/components/schemas/group-display-order"
},
"is_enabled": {
"$ref": "#/components/schemas/group-is-enabled"
},
"items_count": {
"type": "integer",
"description": "Número total de itens no grupo.",
"example": 5
}
},
"required": [
"id",
"external_id",
"name",
"is_enabled"
]
},
"error-response-base": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "Status de resposta HTTP."
},
"errorCode": {
"type": "integer",
"description": "Código de erro."
},
"errorMessage": {
"type": "string",
"description": "Descrição de erro curta."
},
"transactionId": {
"type": "string",
"description": "ID de solicitação. O ID usado para rastrear e associar entradas de registros a essa solicitação ou operação específica. Esse ID pode ser útil para encontrar problemas, realizar depurações e auditorias."
}
}
},
"admin-group-create-request": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "ID externo do grupo de itens. Só pode conter caracteres alfanuméricos, hífens e sublinhados.",
"pattern": "^[A-Za-z0-9_\\-]+$",
"example": "weapons"
},
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"iconUrl": {
"$ref": "#/components/schemas/group-image-url"
},
"isEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/group-is-enabled"
}
],
"default": true
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/group-display-order"
}
]
}
},
"description": "Dados do grupo dei tens.",
"required": [
"external_id",
"name"
]
},
"error-message-extended-validation": {
"type": "array",
"description": "Dados de erro de validação. Contém uma matriz de erros a nível de propriedade descrevendo quais campos falharam a validação e o porquê.",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"description": "Nome do campo que falhou a validação.",
"example": "external_id"
},
"message": {
"type": "string",
"description": "Mensagem de erro da validação para o campo.",
"example": "The property external_id is required"
}
}
}
},
"ItemGroup_422-invalid-request": {
"type": "object",
"required": [
"statusCode",
"errorCode",
"errorMessage",
"transactionId"
],
"properties": {
"statusCode": {
"type": "integer",
"description": "Status de resposta HTTP.",
"example": 422
},
"errorCode": {
"type": "integer",
"description": "Código de erro.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Descrição de erro curta.",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"description": "ID de solicitação. O ID usado para rastrear e associar entradas de registros a essa solicitação ou operação específica. Esse ID pode ser útil para encontrar problemas, realizar depurações e auditorias.",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"$ref": "#/components/schemas/error-message-extended-validation"
}
}
},
"admin-group-update-request": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"external_id": {
"type": "string",
"description": "ID externo de grupo exclusivo. Só pode conter caracteres alfanuméricos, hífens e sublinhados. Pode ser usado para renomear o ID externo do grupo.",
"pattern": "^[A-Za-z0-9_\\-]+$",
"example": "weapons"
},
"iconUrl": {
"$ref": "#/components/schemas/group-image-url"
},
"isEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/group-is-enabled"
}
]
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/group-display-order"
}
]
}
},
"description": "Dados de grupo de itens para atualizar. Os campos `external_id` e `name` são necessários em todas as solicitações. Outros campos são opcionais — campos omitidos vão reter os valores atuais.",
"required": [
"external_id",
"name"
]
},
"group-is-contains-any-items": {
"type": "boolean",
"description": "Se o grupo contém algum item ou não, independentemente do `item_type` especificado,. Um grupo pode ter `items_count: 0` para o tipo especificado, enquanto que `is_contains_any_items` é `true` se o grupo contiver itens de outros tipos.",
"example": true
},
"admin-group-response-by-item-type": {
"allOf": [
{
"$ref": "#/components/schemas/admin-group-response-base"
},
{
"type": "object",
"properties": {
"is_contains_any_items": {
"$ref": "#/components/schemas/group-is-contains-any-items"
}
}
}
]
},
"admin-group-detail-response-by-item-type": {
"allOf": [
{
"$ref": "#/components/schemas/admin-group-response-base"
},
{
"type": "object",
"properties": {
"is_contains_any_items": {
"$ref": "#/components/schemas/group-is-contains-any-items"
}
}
}
]
},
"item-in-group-order-request-item": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "ID de item interno atribuído pela Xsolla. Use o ID de item retornado nas respostas de [chamadas API de catálogos de itens](/pt/api/catalog/common-catalog).",
"minimum": 0,
"example": 101
},
"order": {
"type": "integer",
"description": "Novo valor de ordem de exibição.",
"minimum": 0,
"example": 1
}
},
"required": [
"item_id",
"order"
],
"additionalProperties": false
},
"Cart-Payment_custom_parameters": {
"description": "Seus parâmetros personalizados representados como um conjunto JSON válido de pares chave-valor.
\nVocê pode passar parâmetros adicionais por esse campo para configurar filtros antifraude. [Consulte a documentação do Pay Station](https://developers.xsolla.com/pt/doc/pay-station/features/antifraud/).",
"type": [
"object",
"null"
],
"minProperties": 1,
"maxProperties": 200,
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"example": {
"custom_parameters": {
"string_param": "example",
"bool_param": true,
"int_param": 100,
"null_param": null
}
}
},
"Game-Keys_schemas-client-attributes": {
"type": "array",
"description": "Lista de atributos e seus valores correspondentes ao item. Pode ser usado para a filtragem de catálogos.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Nome do atributo.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Valor do atributo.",
"example": "Strategy"
}
}
}
}
}
}
},
"Game-Keys_admin-attributes": {
"type": "array",
"description": "Lista de atributos.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Game-Keys_regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
}
}
}
},
"Game-Keys_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Lista de atributos.\n\nAtenção. Não é possível especificar mais de 20 atributos para o item. Qualquer tentativa de exceder o limite resulta em um erro.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"game_key_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Limite o período de atualização.",
"properties": {
"per_user": {
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
}
]
}
}
},
"Game-key-item-limit": {
"type": "object",
"description": "Limites de itens.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/game_key_recurrent_schedule"
}
}
},
"Game-Keys_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"Pagination_total-items-count": {
"type": "integer",
"example": 10,
"description": "Número total de itens no sistema."
},
"Game-Keys_client_name": {
"type": "string",
"example": "The Greatest Game in the World",
"description": "Nome do pacote do jogo."
},
"Game-Keys_description": {
"type": "string",
"example": "Description of the greatest game in the world.",
"description": "Descrição do pacote do jogo."
},
"Game-Keys_project_id": {
"type": "integer",
"example": 44056,
"description": "ID do projeto. Você pode encontrar esse parâmetro em sua [Conta de Distribuidor](https://publisher.xsolla.com/) ao lado do nome do projeto."
},
"Game-Keys_game_sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "theGreatestGameSku",
"description": "ID de pacote de chaves exclusivo."
},
"Game-Keys_drm_sku": {
"type": "string",
"example": "steam",
"description": "ID de DRM exclusivo.",
"enum": [
"steam",
"playstation",
"xbox",
"uplay",
"origin",
"drmfree",
"gog",
"epicgames",
"nintendo_eshop",
"discord_game_store",
"oculus",
"rockstar",
"viveport",
"stadia"
]
},
"Game-Keys_image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL da imagem. Para que a imagem seja exibida corretamente e carregue rapidamente na interface de pagamento, confira as nossas diretrizes de imagens e URLs:- Formatos suportados: WebP (recomendado), PNG, JPG.
- Tamanho do arquivo: ≤ 50 KB (para WebP) ou ≤ 150 KB (para PNG e JPG).
- Tamanho da imagem: 280 x 280 px.
- Espaço de cores: sRGB.
- Protocolo: HTTPS com cache de longa duração para URLs versionados.
"
},
"Game-Keys_admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "ID de atributo exclusivo. O `external_id` só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados."
},
"Game-Keys_value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "ID de valor exclusivo para um atributo. O `external_id` pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados."
},
"Game-Keys_client-attributes": {
"type": "array",
"description": "Lista de atributos e seus valores correspondentes ao jogo.\n\nAtenção. Essa parte da resposta estará disponível somente se você enviar o parâmetro de consulta 'additional_fields[]=attributes`.
",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Game-Keys_admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Nome do atributo.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Game-Keys_value-external_id"
},
"value": {
"type": "string",
"description": "Valor do atributo.",
"example": "Strategy"
}
}
}
}
}
}
},
"Game-Keys_entitlement_item": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/Game-Keys_client_name"
},
"description": {
"$ref": "#/components/schemas/Game-Keys_description"
},
"project_id": {
"$ref": "#/components/schemas/Game-Keys_project_id"
},
"game_sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
},
"drm": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
},
"image_url": {
"$ref": "#/components/schemas/Game-Keys_image_url"
},
"is_pre_order": {
"type": "boolean",
"example": false,
"description": "Se o jogo está em status de pré-venda ou não."
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_client-attributes"
}
}
},
"Bundles_item_id": {
"type": "integer",
"example": 1,
"minLength": 1,
"maxLength": 255,
"description": "ID de item exclusivo interno."
},
"Bundles_sku": {
"type": "string",
"example": "bundle_1",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"Bundles_admin-attributes": {
"type": "array",
"description": "Lista de atributos.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Bundles_type": {
"type": "string",
"example": "bundle",
"description": "Tipo de item."
},
"bundle_type": {
"type": "string",
"description": "Tipo de pacote. Devolvido se o tipo de item for um pacote.",
"enum": [
"standard",
"virtual_currency_package",
"partner_side_content"
]
},
"Bundles_image_url": {
"type": [
"string",
"null"
],
"example": "https://image.example.com",
"description": "URL da imagem. Para que a imagem seja exibida corretamente e carregue rapidamente na interface de pagamento, confira as nossas diretrizes de imagens e URLs:- Formatos suportados: WebP (recomendado), PNG, JPG.
- Tamanho do arquivo: ≤ 50 KB (para WebP) ou ≤ 150 KB (para PNG e JPG).
- Tamanho da imagem: 280 x 280 px.
- Espaço de cores: sRGB.
- Protocolo: HTTPS com cache de longa duração para URLs versionados.
"
},
"Bundles_groups_response": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"default": [],
"description": "Grupo aos quais o item pertence.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"description": "Nome do item. Deve conter pares chave/valor\nonde chave é uma localização com o formato \"^[a-z]{2}\", e o valor é uma cadeia de caracteres.",
"example": {
"en": "Horror",
"de": "Horror"
},
"default": {
"en": "Horror"
},
"additionalProperties": {
"type": "string"
}
}
}
}
},
"Bundles_amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Preço do item.",
"pattern": "^\\d*\\.?\\d*$"
},
"Bundles_currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"Bundles_prices": {
"type": "array",
"description": "Preços em moedas reais.",
"items": {
"type": "object",
"properties": {
"amount": {
"$ref": "#/components/schemas/Bundles_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
},
"is_default": {
"type": "boolean",
"description": "O preço padrão é usado para criar um catálogo se nenhum preço na moeda do usuário for especificado."
},
"is_enabled": {
"type": "boolean",
"description": "O preço está habilitado."
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "País onde este preço está disponível. Código de duas letras de acordo com o padrão [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"Bundles_vc-type": {
"type": "string",
"example": "virtual_currency",
"description": "Tipo de moeda virtual."
},
"Bundles_amount": {
"type": "string",
"example": "100.99",
"description": "Preço do item com desconto.",
"pattern": "^\\d*\\.?\\d*$"
},
"Bundles_currency-is_default": {
"type": "boolean",
"example": true,
"description": "Se o preço é padrão para um item."
},
"Bundles_admin-response-virtual_price": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"$ref": "#/components/schemas/Bundles_vc-type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"amount": {
"$ref": "#/components/schemas/Bundles_amount"
},
"is_default": {
"$ref": "#/components/schemas/Bundles_currency-is_default"
}
}
},
"Bundles_media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Ativos adicionais do conjunto.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Tipo de mídia: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Arquivo de recurso."
}
}
}
},
"Bundles_order": {
"type": "integer",
"example": 1,
"default": 1,
"description": "Prioridade de pedido do conjunto na lista."
},
"Bundles_is_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "Se estiver desativado, o item não poderá ser encontrado nem comprado."
},
"Bundles_is_show_in_store": {
"type": "boolean",
"example": true,
"default": false,
"description": "O item está disponível para compra."
},
"Bundles_admin-regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"example": 1
}
}
}
},
"Bundles_admin_content_response": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"quantity": {
"type": "integer",
"description": "Quantidade do tipo de item no conjunto.",
"default": 1,
"minimum": 1
}
}
},
"Bundles_total_content_price": {
"type": [
"object",
"null"
],
"description": "Soma dos preços do conteúdo do conjunto.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Soma dos preços do conteúdo do conjunto com um desconto."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Soma dos preços do conteúdo do conjunto."
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
}
}
},
"Bundles_admin_bundle_response": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/Bundles_item_id"
},
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_admin-attributes"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"bundle_type": {
"$ref": "#/components/schemas/bundle_type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_response"
},
"prices": {
"$ref": "#/components/schemas/Bundles_prices"
},
"virtual_prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin-response-virtual_price"
}
},
"media_list": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_media_list"
},
{
"type": "null"
}
]
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"is_enabled": {
"$ref": "#/components/schemas/Bundles_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Bundles_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Bundles_admin-regions"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_content_response"
}
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
}
},
"description": "O conjunto especificado."
},
"Bundles_groups_request": {
"type": "array",
"example": [
"honor"
],
"default": [],
"description": "Grupo aos quais o item pertence.\n\nObservação: o valor da cadeia de caracteres refere-se ao grupo `external_id`.
",
"items": {
"type": "string"
}
},
"Bundles_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Lista de atributos.\n\nAtenção. Não é possível especificar mais de 20 atributos para o item. Qualquer tentativa de exceder o limite resulta em um erro.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"Bundles_vc_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"amount": {
"type": "integer"
},
"is_default": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"Bundles_bundle_type": {
"type": "string",
"example": "standard",
"enum": [
"standard",
"partner_side_content"
],
"description": "Tipo de pacote. Use `standard` para criar um pacote com itens e especificar os SKUs dos itens incluídos no pacote.\nUse `partner_side_content` para criar um pacote vazio e adicionar itens do seu lado usando um [webhook](https://developers.xsolla.com/pt/webhooks/operation/personalized-partner-catalog/). Esse tipo é usado somente para a [personalização de catálogos no lado do parceiro](https://developers.xsolla.com/pt/doc/shop-builder/features/personalization/#guides_personalization_on_partner_side).",
"default": "standard"
},
"Bundles_admin_content_request": {
"type": "array",
"minItems": 1,
"description": "Matriz de itens inclusos no conjunto. Cada entrada especifica o SKU e quantidade do item. Todos os itens devem ser criados no seu projeto antecipadamente. O sistema retorna um erro se o SKU especificado não existir.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "com.xsolla.kg_1",
"description": "SKU de um item para incluir no conjunto. O item deve ser criado no seu projeto antecipadamente. O sistema retorna um erro se o SKU especificado não existir. Caracteres permitidos: a–z, A–Z, 0–9, ponto (.), hífen (-), sublinhado (_)."
},
"quantity": {
"type": "integer",
"description": "Quantidade dos itens selecionados no conjunto.",
"default": 1,
"minimum": 1
}
},
"required": [
"sku"
],
"example": {
"sku": "com.xsolla.kg_1",
"quantity": 1
}
}
},
"per_user_hourly_bundle": {
"type": "object",
"title": "interval_type = a cada hora",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Intervalo em horas, após o qual o limite é redefinido.
A contagem começa a partir do parâmetro date_from.
Por exemplo, se `date_start = \"2025-11-15T18:15:00+05:00\"` e `hours_interval = 2`, o limite de compra para esse item será redefinido a cada 2 horas começando a partir de `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"bundle_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Limite o período de atualização.",
"properties": {
"per_user": {
"description": "Redefinição do limite de compra realizado no intervalo de tempo especificado em horas.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_bundle"
}
]
}
}
},
"bundle-item-limit": {
"type": "object",
"description": "Limites de itens.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/bundle_recurrent_schedule"
}
}
},
"Bundles_admin_bundle_request": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_request"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_admin-post-put-attributes"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"prices": {
"$ref": "#/components/schemas/Bundles_prices"
},
"vc_prices": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_vc_prices"
},
{
"type": "null"
}
]
},
"bundle_type": {
"$ref": "#/components/schemas/Bundles_bundle_type"
},
"content": {
"$ref": "#/components/schemas/Bundles_admin_content_request"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"is_enabled": {
"$ref": "#/components/schemas/Bundles_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Bundles_is_show_in_store"
},
"media_list": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_media_list"
},
{
"type": "null"
}
]
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"regions": {
"$ref": "#/components/schemas/Bundles_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/bundle-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
},
"description": "O conjunto especificado.",
"required": [
"sku",
"name",
"description"
]
},
"Bundles_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": "array"
}
}
},
"Bundles_client_name": {
"type": "string",
"example": "Big Rocket",
"description": "Nome do item."
},
"Bundles_client_description": {
"type": [
"string",
"null"
],
"example": "Big Rocket - description.",
"description": "Descrição do item."
},
"Bundles_client-attributes": {
"type": "array",
"description": "Lista de atributos e seus valores correspondentes ao item. Pode ser usado para a filtragem de catálogos.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Nome do atributo.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Valor do atributo.",
"example": "Strategy"
}
}
}
}
}
}
},
"Bundles_price": {
"type": [
"object",
"null"
],
"description": "Preço do item.",
"required": [
"amount",
"amount_without_discount",
"currency"
],
"properties": {
"amount": {
"$ref": "#/components/schemas/Bundles_amount"
},
"amount_without_discount": {
"$ref": "#/components/schemas/Bundles_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
}
}
},
"Catalog_item_limits_with_hourly": {
"description": "Limites de itens.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Limites de item para um usuário.",
"properties": {
"total": {
"type": "integer",
"description": "Quantidade máxima de itens que o usuário atual pode comprar.",
"example": 5
},
"available": {
"type": "integer",
"description": "Quantidade restante de itens que o usuário atual pode comprar.",
"example": 3
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Limites de item para um item.",
"properties": {
"total": {
"type": "integer",
"description": "Quantidade máxima de itens que todos os usuários podem comprar.",
"example": 5
},
"available": {
"type": "integer",
"description": "Quantidade restante de itens que todos os usuários podem comprar.",
"example": 3
}
}
}
},
"type": [
"object",
"null"
]
},
"Bundles_client_content": {
"type": "array",
"example": [
{
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"attributes": [],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
}
}
],
"description": "Conteúdo do pacote de conjuntos.",
"items": {
"type": "object",
"description": "Item em um pacote.",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Nome do item."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Descrição do item."
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "URL da imagem."
},
"quantity": {
"type": "integer",
"example": 250,
"description": "Quantidade de item em um pacote."
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Tipo de item virtual.\n\nPossíveis valores:\n- `consumable` — Um item que desaparece do inventário após o uso (ex.: munição)..\n- `non_consumable` — Um item que permanece no inventário por um tempo ilimitado.\n- `non_renewing_subscription` — Item de tempo limitado que pode representar acesso a serviços ou conteúdos por um período específico.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"attributes": {
"$ref": "#/components/schemas/Bundles_client-attributes"
},
"price": {
"type": [
"object",
"null"
],
"description": "Preços dos itens.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Preço do item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits_with_hourly"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_response"
}
}
}
},
"Bundles_client_bundle": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/Bundles_item_id"
},
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/Bundles_client_name"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"description": {
"$ref": "#/components/schemas/Bundles_client_description"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_client-attributes"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"bundle_type": {
"$ref": "#/components/schemas/Bundles_bundle_type"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"$ref": "#/components/schemas/Bundles_price"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"content": {
"$ref": "#/components/schemas/Bundles_client_content"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits_with_hourly"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"media_list": {
"$ref": "#/components/schemas/Bundles_media_list"
}
},
"description": "O conjunto especificado."
},
"value-cart_is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Se `true`, o carrinho é gratuito."
},
"Cart-Payment_client-attributes": {
"type": "array",
"description": "Lista de atributos e seus valores correspondentes ao item. Pode ser usado para a filtragem de catálogos.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Nome do atributo.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Valor do atributo.",
"example": "Strategy"
}
}
}
}
}
}
},
"Catalog_cart_promotions": {
"type": "array",
"description": "Promoções aplicadas para todo o carrinho. A matriz é retornada nos seguintes casos:\n\n* Uma promoção afeta o valor total do carrinho, como um código promocional com a configuração **Desconto na compra**.\n\n* Uma promoção adiciona itens bônus ao carrinho.\n\nSe nenhuma promoção no nível do pedido for aplicada, é retornada uma matriz vazia.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"date_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"type": [
"string",
"null"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"bonus": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"type": "string",
"description": "Tipo de item bônus.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"physical_good",
"game_key",
"nft"
]
},
"name": {
"type": "string",
"description": "Nome do item bônus. Indisponível para o tipo de item bônus `physical_good`."
},
"image_url": {
"type": "string",
"description": "URL da imagem do item bônus. Indisponível para o tipo de item bônus `physical_good`."
},
"bundle_type": {
"type": "string",
"description": "Tipo de item de pacote de bônus. Disponível apenas para o tipo de item bônus `bundle`.",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
},
"limits": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"available": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
}
}
}
}
}
},
"Cart-Payment_settings_ui": {
"description": "Configurações da interface.",
"type": "object",
"additionalProperties": false,
"properties": {
"theme": {
"description": "Tema da interface de pagamento. Pode ser `63295a9a2e47fab76f7708e1` para o tema claro (padrão) ou `63295aab2e47fab76f7708e3` para o tema escuro. Você também pode [criar um tema personalizado](https://developers.xsolla.com/pt/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token) e passar seu ID nesse parâmetro.",
"type": "string",
"default": "63295a9a2e47fab76f7708e1",
"enum": [
"63295a9a2e47fab76f7708e1",
"63295aab2e47fab76f7708e3"
]
},
"desktop": {
"type": "object",
"additionalProperties": false,
"description": "Configurações de interface para a versão desktop.",
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"description": "Configurações de cabeçalho.",
"properties": {
"is_visible": {
"type": "boolean",
"description": "Se o cabeçalho na interface de pagamento deve ser exibido ou não."
},
"visible_logo": {
"type": "boolean",
"description": "Se `true`, o logotipo é exibido no cabeçalho. Para fazer upload da imagem, abra seu projeto na [Contado Publisher](https://publisher.xsolla.com/) e vá para aseção Pay Station > Configurações."
},
"visible_name": {
"type": "boolean",
"description": "Se o nome do projeto deve ser exibido no cabeçalho ou não."
},
"visible_purchase": {
"type": "boolean",
"description": "Se a descrição da compra (`purchase.description.value`) deve ser exibida no cabeçalho ou não. `true` por padrão.",
"default": true
},
"type": {
"type": "string",
"description": "Como mostrar o cabeçalho. Pode ser `compact` (oculta o nome do projeto e ID do usuário) ou `normal` (padrão).",
"default": "normal",
"enum": [
"compact",
"normal"
]
},
"close_button": {
"type": "boolean",
"description": "Se um botão **Fechar** na interface de pagamento desktop deve ser exibido ou não. O botão fecha a interface de pagamento e redireciona o usuário para o URL especificado no parâmetro `settings.return_url`. `false` por padrão.",
"default": false
}
}
}
}
},
"mode": {
"type": "string",
"enum": [
"user_account"
],
"description": "Modo de interface na interface de pagamento. Pode ser apenas `user_account`. O cabeçalho contém apenas o menu de navegação da conta, e o usuário não pode selecionar um produto ou fazer um pagamento. Esse modo só está disponível no desktop."
},
"user_account": {
"type": "object",
"additionalProperties": false,
"description": "Dados da conta do usuário.",
"properties": {
"payment_accounts": {
"type": "object",
"additionalProperties": false,
"description": "Submenu **My payment accounts**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Se o submenu deve ser exibido ou não. `false` por padrão."
}
},
"required": [
"enable"
]
},
"info": {
"type": "object",
"additionalProperties": false,
"description": "Página **Minha conta**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Se o submenu deve ser exibido ou não. `false` por padrão."
},
"order": {
"type": "integer",
"minimum": 1,
"description": "Posição do submenu no menu."
}
},
"required": [
"enable",
"order"
]
},
"subscriptions": {
"type": "object",
"additionalProperties": false,
"description": "Submenu **Manage subscriptions**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Se o submenu deve ser exibido ou não. `false` por padrão."
},
"order": {
"type": "integer",
"minimum": 1,
"description": "Posição do submenu no menu."
}
},
"required": [
"enable",
"order"
]
}
}
},
"header": {
"type": "object",
"properties": {
"visible_virtual_currency_balance": {
"type": "boolean",
"additionalProperties": false,
"description": "Se esse elemento pode ser ocultado ou não na interface de pagamento.",
"default": true
}
}
},
"mobile": {
"type": "object",
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"properties": {
"close_button": {
"type": "boolean",
"description": "Se um botão **Fechar** na interface de pagamento móvel deve ser exibido ou não. O botão fecha a interface de pagamento e redireciona o usuário para o URL especificado no parâmetro `settings.return_url`.",
"default": false
}
}
}
}
},
"is_prevent_external_link_open": {
"type": "boolean",
"description": "Se o redirecionamento de links a uma fonte externa está desabilitado ou não. Ao clicar em um link externo, o evento `external-link-open` é enviado através do mecanismo `postMessage`. O endereço para o link de redirecionamento é passado no parâmetro `url`.",
"default": false
},
"is_payment_methods_list_mode": {
"type": "boolean",
"description": "Se uma lista dos métodos de pagamento disponíveis no país do usuário deve ser exibida ou não ao abrir a interface de pagamento. Se `false` (padrão), o método de pagamento passando no parâmetro `settings.payment_method` ou o método selecionado pelo [algoritmo PayRank](https://developers.xsolla.com/pt/solutions/payments/payment-ui-management/top-payment-methods-management/) será exibido.",
"default": false
},
"is_independent_windows": {
"type": "boolean",
"description": "Se os usuários devem ser redirecionados do navegador integrado do inicializador (WebView) ao navegador padrão para fazer uma compra.",
"default": false
},
"currency_format": {
"type": "string",
"description": "Defina como `code` para exibir um código monetário [ISO 4217](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/) de três letras na interface de pagamento. O símbolo da moeda é exibido em vez do código monetário de três letras por padrão."
},
"is_show_close_widget_warning": {
"type": "boolean",
"description": "Se deve ser exibido um aviso sobre o processamento da transação ao focalizar o cursor sobre o ícone **×** antes de fechar a página de pagamento ou não. Se `false` for passado, ou o parâmetro não for passado, o aviso não será exibido.",
"default": true
},
"layout": {
"type": "string",
"description": "Local dos elementos principais da interface de pagamento. Você pode abrir a interface de pagamento dentro do seu jogo e/ou trocar as colunas com informações sobre um pedido e métodos de pagamento. Consulte as [instruções de personalização](https://developers.xsolla.com/pt/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_layout) para mais detalhes.",
"enum": [
"embed",
"column_reverse",
"embed_column_reverse"
]
},
"is_three_ds_independent_windows": {
"type": "boolean",
"description": "Se a verificação 3-D Secure deve ser aberta em uma nova janela do navegador ou não. Se sua configuração utiliza Content Security Policy (CSP), defina como `true`.",
"default": false
},
"is_cart_open_by_default": {
"type": "boolean",
"description": "A exibição da lista de itens no carrinho ao abrir a versão móvel da interface de pagamento. Se `true`, a lista é exibida na visualização estendida. Se for `false` (padrão) ou os parâmetros não forem passados, a lista é exibida em uma visualização reduzida.",
"default": false
}
}
},
"Cart-Payment_settings_payment_method": {
"type": "integer",
"description": "ID do método de pagamento. Ele determina a exibição da moeda na interface de pagamento, pois alguns métodos de pagamento suportam apenas determinadas moedas.",
"minimum": 1
},
"Cart-Payment_settings_return_url": {
"type": "string",
"format": "uri",
"description": "Página para redirecionar o usuário para após o pagamento. Parâmetros `user_id`, `foreigninvoice`, `invoice_id` e `status` serão adicionados automaticamente ao link.",
"maxLength": 1000
},
"Cart-Payment_redirect_policy": {
"type": "object",
"properties": {
"redirect_conditions": {
"description": "Status de pagamento acionando o redirecionamento do usuário para o URL de retorno.",
"type": "string",
"example": "none",
"enum": [
"none",
"successful",
"successful_or_canceled",
"any"
]
},
"delay": {
"description": "Atraso após o qual o usuário será redirecionado automaticamente para o URL de retorno.",
"type": "integer",
"example": 0
},
"status_for_manual_redirection": {
"description": "Status do pagamento acionando a exibição de um botão clicando que redireciona o usuário para o URL de retorno.",
"type": "string",
"example": "none",
"enum": [
"none",
"successful",
"successful_or_canceled",
"any"
]
},
"redirect_button_caption": {
"description": "Legendas de botão de redirecionamento traduzidas.",
"type": "string",
"example": "Text button"
}
}
},
"Cart-Payment_settings_sandbox": {
"type": "boolean",
"description": "Defina como `true` para testar o processo de pagamento. Nesse caso, use https://sandbox-secure.xsolla.com para acessar a interface de pagamento de teste.",
"default": false
},
"Cart-Payment_admin-user-request-body": {
"type": "object",
"required": [
"id"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "object",
"properties": {
"value": {
"description": "ID do usuário. Para teste, você pode passar qualquer valor. Para aceitar pagamentos reais, você precisa usar o valor do ID do usuário do seu sistema. Esse ID é passado no webhook [User validation](https://developers.xsolla.com/pt/webhooks/operation/user-validation/).",
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
},
"name": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Nome de exibição do usuário."
}
}
},
"email": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"format": "email",
"description": "E-mail do usuário. Deve ser válido de acordo com o protocolo RFC 822."
}
}
},
"country": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Código de país de duas letras maiúsculas de acordo com o padrão [ISO 3166-1 alfa-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). É necessário se um endereço IP não for passado no cabeçalho `X-User-Ip`. Verifique a documentação para obter informações detalhadas sobre [os países suportados pela Xsolla](https://developers.xsolla.com/pt/doc/shop-builder/references/supported-countries/).
Exemplo: `country=US`",
"example": "US"
},
"allow_modify": {
"type": "boolean",
"description": "Se o usuário pode ou não alterar o país na interface de pagamento.",
"default": false,
"example": false
}
}
},
"age": {
"type": "integer",
"description": "Idade do usuário."
},
"phone": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "Número de telefone do usuário."
},
"allow_modify": {
"type": "boolean",
"description": "Se o usuário pode ou não alterar o telefone na interface de pagamento. Se `phone.value` for passado no token, o valor será `false` por padrão.",
"default": false,
"example": false
},
"hidden": {
"type": "boolean",
"default": true,
"example": false
}
}
},
"tracking_id": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"minLength": 32,
"maxLength": 32,
"pattern": "^[A-Za-z0-9]{32}$",
"description": "ID de rastreamento exclusivo (usado em campanhas de marketing)."
}
}
},
"steam_id": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"minLength": 17,
"maxLength": 17,
"pattern": "^\\d{17}$",
"description": "ID do Steam."
}
}
},
"is_legal": {
"type": "boolean",
"description": "Se o usuário é uma entidade legal."
},
"legal": {
"type": "object",
"description": "Objeto com dados da entidade legal. O objeto e todos os seus parâmetros são necessários se `user.is_legal` for `true`. ",
"properties": {
"name": {
"type": "string",
"description": "Nome legal completo."
},
"address": {
"type": "string",
"description": "Endereço legal completo."
},
"vat_id": {
"type": "string",
"description": "Identificação de contribuinte individual. "
},
"country": {
"type": "string",
"description": "País da incorporação. É utilizado o código de país de duas letras maiúsculas, de acordo com o [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
}
},
"Cart_admin_payment": {
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.\n\nAtenção
Para vender um SKU múltiplas vezes, especifique a quantidade necessária no parâmetro purchase.items[].quantity. Os SKUs duplicados dentro da matriz não são suportados — apenas a primeira ocorrência é utilizada ao criar o token. Nenhum erro é retornado nesse caso.
",
"example": "t-shirt"
},
"quantity": {
"type": "number",
"minimum": 1,
"example": 2,
"description": "Quantidade do item."
}
},
"required": [
"sku",
"quantity"
]
},
"minItems": 1
}
},
"required": [
"items"
]
},
"Promotions_coupon_code": {
"type": "string",
"description": "Código exclusivo que diferencia maiúsculas de minúsculas. Contém letras e números.",
"minLength": 1,
"maxLength": 128,
"example": "WINTER2021",
"default": "WINTER2021",
"pattern": "^[a-zA-Z0-9]+$"
},
"Cart-Payment_settings_currency": {
"type": "string",
"description": "Moeda de compra preferencial. Código de três letras de acordo com o formato [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre as [moedas suportadas pela Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
},
"Cart-Payment_settings_locale": {
"type": "string",
"description": "Idioma da interface. [Código de idioma](https://developers.xsolla.com/pt/doc/pay-station/features/localization/) de duas letras minúsculas."
},
"Cart-Payment_settings_external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "ID de transação externo."
},
"Cart-Payment_custom_parameters_token": {
"description": "Seus parâmetros personalizados representados como um conjunto JSON válido de pares chave-valor.
\nVocê pode passar parâmetros adicionais por esse campo para configurar filtros antifraude. [Consulte a documentação do Pay Station](https://developers.xsolla.com/pt/doc/pay-station/features/antifraud/).",
"type": [
"object",
"null"
],
"minProperties": 1,
"maxProperties": 200,
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"example": {
"custom_parameters": {
"string_param": "example",
"bool_param": true,
"int_param": 100,
"number_param": 12.5,
"null_param": null
}
}
},
"422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Código de status da resposta.",
"example": 422
},
"errorCode": {
"type": "number",
"description": "Código de erro.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Mensagem de erro legível.",
"example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
},
"transactionId": {
"type": "string",
"description": "ID de solicitação exclusivo.",
"example": "da145238620011eb8e24fe6913ff226a"
}
}
},
"Cart": {
"type": "object",
"additionalProperties": false,
"properties": {
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"example": "US",
"description": "Código de país de duas letras maiúsculas de acordo com o padrão [ISO 3166-1 alfa-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Verifique a documentação para obter informações detalhadas sobre [os países suportados pela Xsolla](https://developers.xsolla.com/pt/doc/shop-builder/references/supported-countries/).
Exemplo: `country=US`"
},
"currency": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"example": "USD",
"description": "A moeda do preço do item exibida no carrinho. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.",
"example": "t-shirt"
},
"quantity": {
"type": "number",
"minimum": 1,
"example": 2,
"description": "Quantidade do item."
}
},
"required": [
"sku",
"quantity"
]
},
"minItems": 1
}
},
"required": [
"items"
]
},
"User-limit_user-external-id": {
"description": "ID de usuário externo.",
"type": "string",
"minLength": 1,
"pattern": "^\\S+$"
},
"User-limit_user": {
"type": "object",
"properties": {
"user_external_id": {
"$ref": "#/components/schemas/User-limit_user-external-id"
}
},
"required": [
"user_external_id"
]
},
"User-limit_user_flexible": {
"type": [
"object",
"null"
],
"properties": {
"user_external_id": {
"$ref": "#/components/schemas/User-limit_user-external-id"
}
}
},
"User-limit-item": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 10,
"description": "O número máximo de itens que um usuário pode comprar."
},
"available": {
"type": "integer",
"example": 9,
"description": "O número restante de itens disponíveis para o usuário comprar."
}
}
}
}
},
"User-limit_available_flexible": {
"type": "integer",
"minimum": 0,
"description": "Número restante de itens ou usos da promoção disponíveis para o usuário dentro do limite aplicado."
},
"User-limit_available": {
"type": "integer",
"minimum": 1,
"description": "Número restante de itens ou usos da promoção disponíveis para o usuário dentro do limite aplicado."
},
"422-invalid-request-extended": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Código de status da resposta.",
"example": 422
},
"errorCode": {
"type": "number",
"description": "Código de erro.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Mensagem de erro legível.",
"example": "[0401-1102]: Unprocessable Entity"
},
"errorMessageExtended": {
"$ref": "#/components/schemas/error-message-extended-validation"
},
"transactionId": {
"type": "string",
"description": "ID de solicitação único. Pode ser usado para entrar em contato com o suporte da Xsolla para solução de problemas.",
"example": "da145238620011eb8e24fe6913ff226a"
}
}
},
"client_virtual_prices_with_calculated_price_response": {
"type": "array",
"description": "Preços virtuais.",
"items": {
"type": "object",
"description": "Preço virtual.",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "Preço do item em moeda virtual."
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "Preço do item em moedas virtuais sem desconto. Sempre igual a `amount` já que descontos não são aplicados a preços em moedas virtuais."
},
"calculated_price": {
"type": "object",
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
}
}
},
"sku": {
"type": "string",
"example": "vc_gold",
"description": "SKU de moeda virtual."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Se o preço padrão é definido em uma moeda virtual ou não."
},
"image_url": {
"type": [
"string",
"null"
],
"example": "http://image.png",
"description": "URL de imagem da moeda virtual"
},
"item_id": {
"type": "integer",
"example": 259774,
"description": "ID de item único atribuído pela Xsolla."
},
"name": {
"type": "string",
"example": "Gold",
"description": "Nome da moeda virtual."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Tipo de item. Para moedas virtuais, é `virtual_currency."
},
"description": {
"type": [
"string",
"null"
],
"example": "In-game currency used to purchase weapons and upgrades",
"description": "Descrição da moeda virtual."
}
}
}
},
"Regions_region_id": {
"type": "integer",
"description": "ID de região. Identificador de região exclusivo dentro do projeto.",
"example": 42
},
"Regions_name": {
"type": "object",
"description": "Nome da região. Deve conter pares chave/valor onde chave é uma localidade com o formato \"^[a-z]{2}-[A-Z]{2}$\", e o valor sendo uma cadeia de caracteres.",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Asia",
"de-DE": "Asien"
},
"default": {
"en-US": "Asia",
"de-DE": "Asien"
}
},
"Regions_200-region-short-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Regions_region_id"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
}
}
},
"Regions_countries": {
"type": "array",
"description": "Lista de países a serem adicionados em uma região.\n
Código de país de duas letras maiúsculas de acordo com o padrão [ISO 3166-1 alfa-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\nVerifique a documentação para obter informações detalhadas sobre [os países suportados pela Xsolla](https://developers.xsolla.com/pt/doc/shop-builder/references/supported-countries/).\n
Exemplo: `[\"JP\", \"CN\", \"VN\"]`",
"items": {
"type": "string"
}
},
"Regions_200-region-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Regions_region_id"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
},
"countries": {
"$ref": "#/components/schemas/Regions_countries"
}
},
"example": {
"value": {
"id": 44,
"name": {
"en-US": "Asia",
"de-DE": "Asien"
},
"countries": [
"JP",
"CN",
"VN"
]
}
}
},
"admin_attribute_response": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
}
},
"example": {
"value": [
{
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
]
}
},
"schemas-422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"request-attribute-value": {
"type": "object",
"required": [
"external_id",
"value"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"$ref": "#/components/schemas/value-name"
}
},
"example": {
"external_id": "value_id",
"value": {
"en": "Value",
"de": "Wert"
}
}
},
"404-not-found": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0000-0000]: Entity not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
},
"responses": {
"Virtual-Items-Currency_200-admin-get-virtual-items": {
"description": "A lista de itens virtuais foi recebida com sucesso.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.armor_max_1",
"name": {
"en": "Maximum Armor Xsolla Skin"
},
"type": "virtual_good",
"description": {
"en": "Suit up with flair showcasing your allegiance to Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"long_description": {
"en": "The metal coverings formerly worn by soldiers or warriors to protect the body in battle."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "featured",
"name": {
"en": "featured"
}
},
{
"external_id": "Xsolla",
"name": {
"en": "Xsolla"
}
},
{
"external_id": "Premium",
"name": {
"en": "Premium"
}
},
{
"external_id": "NonConsumableGroupCode",
"name": {
"en": "Non-consumable"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.armor_max_2",
"name": {
"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_1",
"name": {
"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {
"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "Xsolla",
"name": {
"en": "Xsolla"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": false,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_2",
"name": {
"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
},
{
"sku": "com.xsolla.armor_large_3",
"name": {
"en": "Empire Large Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "hourly",
"hours_interval": 8,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
}
}
}
},
"Virtual-Items-Currency_401-invalid-basic-auth": {
"description": "Autenticação básica não aprovada ou errada. Verifique se você usou a autenticação básica ou as credenciais corretas.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Virtual-Items-Currency_201-created": {
"description": "Item virtual criado com sucesso.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"sku": "com.xsolla.item_1"
}
}
},
"schema": {
"type": "object",
"example": {
"sku": "com.xsolla.item_1"
},
"properties": {
"sku": {
"type": "string",
"example": "new-sku"
}
}
}
}
}
},
"Virtual-Items-Currency_422-invalid-request": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_422-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
},
"Custom attributes JSON can’t exceed 500 characters": {
"$ref": "#/components/examples/422-custom-attributes-size-exceeded"
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-items-by-group": {
"description": "A lista de itens virtuais foi recebida com sucesso.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.armor_max_2",
"name": {
"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {
"en": "A strong armor forged to withstand heavy attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "monthly",
"day_of_week": null,
"day_of_month": 28,
"time": "11:00:00+08:00",
"reset_next_date": 1679972400,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.armor_med_1",
"name": {
"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {
"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": false,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_2",
"name": {
"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
},
{
"sku": "com.xsolla.armor_lrg_2",
"name": {
"en": "Empire Large Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "hourly",
"hours_interval": 8,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-item": {
"description": "O item virtual especificado foi recebido com sucesso.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.swords_1",
"name": {
"en": "Sword Xsolla Skin"
},
"type": "virtual_good",
"description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png",
"long_description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": true,
"order": 1,
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
},
{
"external_id": "weapon",
"name": {
"en": "weapon"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currencies": {
"description": "A lista de moedas virtuais foi recebida com sucesso.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency": {
"description": "A moeda virtual especificada foi recebida com sucesso.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency"
}
}
}
},
"Virtual-Items-Currency_404-item": {
"description": "O item não foi encontrado. Certifique-se de que o `project_id` e o `item_sku` estão corretos.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found"
}
},
"type": "object"
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency-packages": {
"description": "A lista de pacotes de moedas virtuais foi recebida com sucesso.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.crystal_pack_1",
"name": {
"en": "Small crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.crystal_pack_2",
"name": {
"en": "Medium crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/431a40dd8c99290dd761508964ddbacf.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_2",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.crystal_pack_3",
"name": {
"en": "Massive crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/1d67a1d2f92d69e021a97effa692dff3.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_3",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 1500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_1",
"name": {
"en": "Small gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/09984ff0a3ae6b367c9c886b31366950.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_2",
"name": {
"en": "Medium gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/b5d8130bdaf28aa55c43a68aa3ca0ef4.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_2",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_3",
"name": {
"en": "Large gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/dea74a3667807d5502a4acb8f4c879ca.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_3",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 1500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency-package": {
"description": "O pacote de moedas virtuais especificado foi recebido com sucesso.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.crystal_pack_1",
"name": {
"en": "Small crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": true,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package"
}
}
}
},
"Virtual-Items-Currency_200-get-items-list": {
"description": "A lista de itens virtuais foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item-list"
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": {
"en": "Big Rocket"
},
"groups": [
{
"external_id": "accessory",
"name": "accessory",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": {
"en": "Big Rocket - description"
},
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": null,
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
},
{
"quantity": 1,
"sku": "com.xsolla.phys_good_1",
"type": "physical_good"
},
{
"quantity": 1,
"name": "Super Lootbox with items",
"image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png",
"sku": "com.xsolla.SuperLootboxBundle_1",
"type": "bundle",
"bundle_type": "standard"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": {
"en": "SHOTGUN FOR TRUE RAIDERS"
},
"groups": [
{
"external_id": "weapons",
"name": "Weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": {
"en": "description"
},
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": {
"en": "SHOTGUN FOR TRUE RAIDERS"
},
"groups": [],
"attributes": [],
"type": "virtual_good",
"description": {
"en": "description"
},
"image_url": "http://image.png",
"is_free": true,
"price": null,
"virtual_prices": [],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-item-by-sku": {
"description": "O item virtual foi recebido com sucesso.",
"content": {
"application/json": {
"example": {
"item_id": 488833,
"sku": "com.xsolla.swords_1",
"type": "virtual_good",
"name": {
"en": "Sword Xsolla Skin"
},
"description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": {
"per_user": {
"total": 3,
"available": 1,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1761840000
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": "VALUE"
},
{
"external_id": "val2",
"value": "VALUE2"
}
]
}
],
"is_free": false,
"groups": [
{
"external_id": "weapons",
"name": "weapons"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item"
}
}
}
},
"Virtual-Items-Currency_200-get-all-items-list": {
"description": "A lista de todos os itens virtuais foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com itens virtuais.",
"properties": {
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"description": "description",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
]
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"description": "description",
"groups": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Nome do item."
},
"groups": {
"type": "array",
"properties": {
"external_id": {
"type": "string",
"example": "weapons"
},
"name": {
"type": "object",
"additionalProperties": {
"type": [
"string",
"null"
]
}
}
}
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Descrição do item."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"description": "Big Rocket - description"
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
],
"description": "description"
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [],
"description": "description"
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-list": {
"description": "A lista de moedas virtuais foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"type": "virtual_currency",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "Virtual currency name",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_currency",
"description": "Emeralds - short description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
},
{
"sku": "com.xsolla.diamond_1",
"name": "Diamonds",
"groups": [],
"attributes": [],
"type": "virtual_currency",
"description": "Diamonds - description",
"image_url": "http://image.png",
"is_free": true,
"price": null,
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency": {
"description": "A moeda virtual foi recebida com sucesso.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"item_id": 451414,
"sku": "com.xsolla.crystal_1",
"type": "virtual_currency",
"name": "Crystals",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"price": {
"amount": "100",
"amount_without_discount": "100",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2023-08-11T10:00:00+03:00",
"date_until": "2023-08-11T20:00:00+03:00"
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"is_free": false,
"groups": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency"
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-packages-list": {
"description": "A lista de pacotes de moedas virtuais foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.vc_package_1",
"name": "VC Name first package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 1
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.vc_package_3",
"name": "VC Name third package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 2
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"type": "virtual_currency",
"quantity": 200,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-package": {
"description": "O pacote de moedas virtuais foi recebido com sucesso.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"item_id": 488832,
"sku": "com.xsolla.crystal_pack_1",
"type": "bundle",
"name": "Crystal Pack",
"bundle_type": "virtual_currency_package",
"description": "Crystal Pack Short Description",
"image_url": "http://vc_package_image.png",
"price": {
"amount": "100",
"amount_without_discount": "100",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": {
"per_user": {
"total": 1,
"available": 1,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1690732800
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 488831,
"sku": "com.xsolla.crystals_1",
"type": "virtual_currency",
"name": "Crystals",
"description": "Crystal - short description",
"image_url": "https://cdn.xsolla.net/items/crystal-pack.png",
"quantity": 10,
"limits": null
}
],
"vp_rewards": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package"
}
}
}
},
"Virtual-Items-Currency_200-get-items-by-group-id": {
"description": "A lista de itens do grupo especificado foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons"
}
],
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": "Big Rocket - description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.shotgun_raider",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "weapons"
}
}
],
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"value": "3.9"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"value": "Strategy"
},
{
"value": "Tactical"
},
"Turn-based"
]
}
],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Nome do item."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Tipo de item: `consumable`/`expiration`/`permanent`/`lootboxes`/`physical`."
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Descrição do item."
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "URL da imagem."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Preços dos itens.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Preço do item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"virtual_item_type": {
"type": "string",
"example": "non_consumable",
"description": "Tipo de item virtual.\n\nPossíveis valores:\n- `consumable` — Um item que desaparece do inventário após o uso (ex.: munição)..\n- `non_consumable` — Um item que permanece no inventário por um tempo ilimitado.\n- `non_renewing_subscription` — Item de tempo limitado que pode representar acesso a serviços ou conteúdos por um período específico.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": "Big Rocket - description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_404-item-group": {
"description": "O grupo não foi encontrado. Verifique se o `external_id` está correto e se o grupo não está desativado ou excluído.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "Código de status de resposta HTTP.",
"example": 404
},
"errorCode": {
"type": "integer",
"description": "Código de erro Xsolla",
"example": 4403
},
"errorMessage": {
"type": "string",
"description": "Descrição de erro curta.",
"example": "[0401-4403]: Item group not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Item group not found"
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-by-group-id": {
"description": "A lista de moedas virtuais do grupo especificado foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"type": "virtual_currency",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "Virtual currency name",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_currency",
"description": "Emeralds - short description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-packages-by-group-id": {
"description": "A lista de pacotes de moedas virtuais do grupo especificado foi recebido com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.vc_package_1",
"name": "VC Name first package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 1
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.vc_package_3",
"name": "VC Name third package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 2
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"type": "virtual_currency",
"quantity": 200,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-items-groups": {
"description": "A lista de grupos foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"example": [
{
"external_id": "weapons",
"name": "Weapons",
"description": "All weapons available in the game",
"image_url": null,
"order": 1
},
{
"external_id": "group_external_id",
"name": "Super",
"description": "Super description",
"image_url": null,
"order": 1
}
],
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "weapons",
"description": "ID de grupo externo."
},
"name": {
"type": "string",
"example": "Weapons",
"description": "Nome do grupo."
},
"description": {
"type": "string",
"example": "All weapons available in the game",
"description": "Descrição do grupo."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "URL da imagem."
},
"order": {
"type": "integer",
"example": 1,
"description": "Define a ordem do arranjo."
},
"level": {
"type": "integer",
"example": 0,
"description": "Nível de aninhamento de grupo."
},
"children": {
"type": "array",
"example": [
{
"external_id": "background",
"name": "Background",
"description": "Background description",
"image_url": null,
"order": 1,
"level": 1,
"children": [
{
"external_id": "accessory",
"name": "Accessory",
"description": "Accessory",
"image_url": null,
"order": 1,
"level": 2,
"children": [],
"parent_external_id": "background"
}
],
"parent_external_id": "weapons"
}
],
"description": "Grupos filhos.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "background",
"description": "ID de grupo externo."
},
"name": {
"type": "string",
"example": "Background",
"description": "Nome do grupo."
},
"description": {
"type": "string",
"example": "Background description",
"description": "Descrição do grupo."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "URL da imagem do grupo."
},
"order": {
"type": "integer",
"example": 1,
"description": "Define a ordem do arranjo."
},
"level": {
"type": "integer",
"example": 1,
"description": "Nível de aninhamento de grupo."
},
"children": {
"type": "array",
"example": [
{
"external_id": "accessory",
"name": "Accessory",
"description": "Accessory",
"image_url": null,
"order": 1,
"level": 2,
"children": [],
"parent_external_id": "background"
}
],
"description": "Grupos filhos.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "accessory",
"description": "ID de grupo externo."
},
"name": {
"type": "string",
"example": "Accessory",
"description": "Nome do grupo."
},
"description": {
"type": "string",
"example": "Accessory",
"description": "Descrição do grupo."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "URL da imagem."
},
"order": {
"type": "integer",
"example": 1,
"description": "Define a ordem do arranjo."
},
"level": {
"type": "integer",
"example": 2,
"description": "Nível de aninhamento de grupo."
},
"children": {
"type": "array",
"example": [],
"description": "Grupos filhos.",
"items": {
"type": "string"
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": "background",
"description": "ID de grupo pai externo."
}
}
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": "weapons",
"description": "ID de grupo pai externo."
}
}
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": null,
"description": "ID de grupo pai externo."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"groups": [
{
"external_id": "weapons",
"name": "Weapons",
"description": "All weapons available in the game",
"image_url": "https://example.com/groups/weapons.png",
"order": 1
},
{
"external_id": "armor",
"name": "Armor",
"description": "Protective equipment",
"image_url": "https://example.com/groups/armor.png",
"order": 2
},
{
"external_id": "consumables",
"name": "Consumables",
"description": "Potions, food, and other single-use items",
"image_url": null,
"order": 3
}
]
}
}
}
}
}
},
"ItemGroup_200-admin-get-group-list": {
"description": "A lista de grupos de itens foi recuperada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-group-response-base"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-list"
}
}
}
}
},
"ItemGroup_401-invalid-basic-auth": {
"description": "A autenticação básica falhou ou foram fornecidas credenciais inválidas. Certifique-se de usar autenticação básica e credenciais corretas.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error-response-base"
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_201-admin-create-group": {
"description": "Grupo de itens criado com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "ID de grupo de itens externo especificado durante a criação.",
"example": "weapons"
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/201-admin-create-group"
}
}
}
}
},
"ItemGroup_422-create-update": {
"description": "A solicitação não pôde ser processada. Retornado para erros de validação ou se os dados violarem as regras do sistema.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"The property `external_id` is required": {
"$ref": "#/components/examples/422-property-external-id-required"
},
"Group already exists": {
"value": {
"statusCode": 422,
"errorCode": 4401,
"errorMessage": "[0401-4401]: Item group already exists",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"Group cannot be its own parent": {
"value": {
"statusCode": 422,
"errorCode": 4404,
"errorMessage": "[0401-4404]: Group can't be self parent",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"Reserved external_id value": {
"value": {
"statusCode": 422,
"errorCode": 4516,
"errorMessage": "[0401-4516]: Value 'tools' not allowed to be used for the property 'external_id'.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_200-admin-get-group": {
"description": "Grupo de itens recuperado com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-response-base"
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group"
}
}
}
}
},
"ItemGroup_404-group-not-found": {
"description": "Grupo de itens não encontrado. Retornado se o grupo com o `external_id` especificado não existe ou pertence a outro projeto.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "IDs usados na pesquisa falha.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID de projeto usado na solicitação de pesquisa."
},
"external_id_list": {
"type": "array",
"description": "Lista de grupo `external_id` utilizada na solicitação de pesquisa.",
"items": {
"type": "string"
}
},
"group_id_list": {
"type": "array",
"description": "Lista de grupo `id` utilizada na solicitação de pesquisa.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Group not found by external_id": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with external id = 'weapons' not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"external_id_list": [
"weapons"
]
}
}
},
"Group not found by ID": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"group_id_list": [
99
]
}
}
},
"Items or group not found (reorder endpoints)": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"ItemGroup_204-admin-update-group": {
"description": "Grupo de itens atualizado com sucesso."
},
"ItemGroup_204-admin-delete-group": {
"description": "Grupo de itens excluído com sucesso."
},
"ItemGroup_422-delete": {
"description": "A solicitação não pôde ser processada. Não é possível excluir um grupo que contém itens.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"Cannot delete group with items": {
"value": {
"statusCode": 422,
"errorCode": 4402,
"errorMessage": "[0401-4402]: Item group with items cannot be deleted.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_200-admin-get-group-list-by-item-type": {
"description": "A lista do grupo de itens foi recuperada com sucesso. O campo `items_count` inclui somente itens do tipo especificado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-group-response-by-item-type"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-list-by-item-type"
}
}
}
}
},
"ItemGroup_200-admin-get-group-by-item-type": {
"description": "O grupo de itens foi recuperado com sucesso, com `items_count` filtrados pelo tipo de item especificado.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-detail-response-by-item-type"
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-by-item-type"
}
}
}
}
},
"ItemGroup_204-admin-reorder-groups": {
"description": "Grupos de itens reorganizados com sucesso."
},
"ItemGroup_404-reorder-groups-not-found": {
"description": "Grupo de itens não encontrado. Retornado se o grupo com o `id` ou `external_id` especificado não existe ou pertence a outro projeto.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "IDs usados na pesquisa falha.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID de projeto usado na solicitação de pesquisa."
},
"external_id_list": {
"type": "array",
"description": "Lista de grupo `external_id` utilizada na solicitação de pesquisa.",
"items": {
"type": "string"
}
},
"group_id_list": {
"type": "array",
"description": "Lista de grupo `id` utilizada na solicitação de pesquisa.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Group not found by external_id": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with external id = 'weapons' not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"external_id_list": [
"weapons"
]
}
}
},
"Group not found by ID": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"group_id_list": [
99
]
}
}
}
}
}
}
},
"ItemGroup_422-ordering": {
"description": "A solicitação não pode ser processada. A validação do corpo da solicitação falhou.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"Invalid request body": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": [
{
"property": "",
"message": "Object value found, but an array is required"
}
]
}
}
}
}
}
},
"ItemGroup_204-admin-reorder-items": {
"description": "Itens dentro do grupo reorganizados com sucesso."
},
"ItemGroup_404-reorder-items-by-external-id-not-found": {
"description": "O grupo de itens ou itens não foram encontrados. Retornado se o grupo com o `external_id` especificado não existir ou pertencer a outro projeto, ou se um ou mais `item_id` não forem encontrados em grupo.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "IDs usados na pesquisa falha.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID de projeto usado na solicitação de pesquisa."
},
"external_id_list": {
"type": "array",
"description": "Lista de grupo `external_id` utilizada na solicitação de pesquisa.",
"items": {
"type": "string"
}
}
}
}
}
}
]
},
"examples": {
"Items or group not found": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"ItemGroup_404-reorder-items-by-id-not-found": {
"description": "O grupo de itens ou itens não foram encontrados. Retornado se o grupo com o `id` especificado não existe ou pertence a outro projeto, ou se um ou mais `item_id` não forem encontrados em grupo.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "IDs usados na pesquisa falha.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID de projeto usado na solicitação de pesquisa."
},
"group_id_list": {
"type": "array",
"description": "Lista de grupo `id` utilizada na solicitação de pesquisa.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Items or group not found": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"Virtual-Items-Currency_200-quick-purchase": {
"description": "Compra virtual rápida bem-sucedida.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID de pedido."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"Virtual-Items-Currency_422-not-enough-virtual-currency": {
"description": "Não há moedas virtuais suficientes.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 5006
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-5006]: Not enough virtual currency"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 5006,
"statusCode": 422,
"errorMessage": "[0401-5006]: Not enough virtual currency"
}
}
}
}
}
},
"Game-Keys_200-get-games-catalog": {
"description": "A lista de jogos foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com jogos.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"promotions": [],
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [],
"periods": []
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [],
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Game name",
"description": "Nome do item."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_schemas-client-attributes"
},
"type": {
"type": "string",
"example": "unit",
"description": "Tipo de item:`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`."
},
"unit_type": {
"type": "string",
"example": "game",
"description": "Tipo de unidade: `game`."
},
"description": {
"type": "string",
"example": "Game description",
"description": "Descrição do item."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL da imagem."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"unit_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Tipo de item: `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Preços dos itens.",
"properties": {
"amount": {
"type": "string",
"example": "2.9900",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "2.9900",
"description": "Preço do item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Nome do DRM."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "ID de DRM exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"has_keys": {
"type": "boolean",
"example": false,
"description": "Se `true`, a chave de jogo tem chaves para venda."
},
"is_pre_order": {
"type": "boolean",
"example": true,
"description": "Se `true`, a chave do jogo é uma pré-venda e a data de lançamento não foi passada."
},
"release_date": {
"type": [
"string",
"null"
],
"example": "2020-08-11T10:00:00+03:00",
"description": "Data de lançamento da chave de jogo no formato ISO 8601."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{
"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"periods": [],
"vp_rewards": []
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
],
"vp_rewards": []
}
]
}
]
}
}
}
}
}
},
"Game-Keys_200-get-game-keys-by-group-catalog": {
"description": "A lista de chaves de jogo foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com jogos.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": true,
"is_pre_order": false,
"release_date": null,
"periods": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Game name",
"description": "Nome do item."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_schemas-client-attributes"
},
"type": {
"type": "string",
"example": "game_key",
"description": "Tipo de item: `game_key`."
},
"description": {
"type": "string",
"example": "Game description",
"description": "Descrição do item."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL da imagem."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Preços dos itens.",
"properties": {
"amount": {
"type": "string",
"example": "2.9900",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "2.9900",
"description": "Preço do item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Nome do DRM."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "ID de DRM exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"has_keys": {
"type": "boolean",
"example": false,
"description": "Se `true`, a chave de jogo tem chaves para venda."
},
"is_pre_order": {
"type": "boolean",
"example": true,
"description": "Se `true`, a chave do jogo é uma pré-venda e a data de lançamento não foi passada."
},
"release_date": {
"type": [
"string",
"null"
],
"example": "2020-08-11T10:00:00+03:00",
"description": "Data de lançamento da chave de jogo no formato ISO 8601."
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{
"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 1
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": true,
"is_pre_order": false,
"release_date": null,
"periods": []
}
]
}
}
}
}
}
},
"Game-Keys_200-get-drm-list": {
"description": "A lista de DRMs foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com jogos.",
"properties": {
"drm": {
"type": "array",
"example": [
{
"sku": "steam_key_1",
"name": "Steam",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"redeem_instruction_link": "https://support.steampowered.com",
"drm_id": 1
},
{
"sku": "playstation_key_1",
"name": "Playstation",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": null,
"redeem_instruction_link": "https://support.us.playstation.com",
"drm_id": 2
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "steam",
"description": "ID de DRM exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Steam",
"description": "Nome do DRM."
},
"image": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL da imagem."
},
"link": {
"type": [
"string",
"null"
],
"example": "https://support.us.playstation.com",
"description": "Resgatar link."
},
"redeem_instruction_link": {
"type": "string",
"example": "https://support.us.playstation.com",
"description": "Resgatar link de instrução."
},
"drm_id": {
"type": "number",
"example": 1,
"description": "ID de DRM."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"drm": [
{
"sku": "steam_key_1",
"name": "Steam",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"redeem_instruction_link": "https://support.steampowered.com",
"drm_id": 1
},
{
"sku": "playstation_key_1",
"name": "Playstation",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": null,
"redeem_instruction_link": "https://support.us.playstation.com",
"drm_id": 2
}
]
}
}
}
}
}
},
"Game-Keys_200-admin-get-games-list": {
"description": "A lista de jogos foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com jogos.",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "ID de item exclusivo interno que é fornecido na criação do item."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"type": {
"type": "string",
"example": "unit",
"description": "Tipo de item. Neste caso é sempre `unit`."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL da imagem."
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Recursos adicionais do jogo, como capturas de tela, vídeo de jogabilidade e assim por diante.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Tipo de mídia: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Arquivo de recurso."
}
}
}
},
"is_enabled": {
"type": "boolean",
"description": "Se desabilitado, o item não poderá ser comprado nem acessado pelo inventário."
},
"is_show_in_store": {
"type": "boolean",
"description": "O item está disponível para compra."
},
"order": {
"type": "integer",
"example": 1,
"description": "Prioridade da ordem de jogos na lista."
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Grupo aos quais o item pertence.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"unit_items": {
"type": "array",
"description": "Chaves de jogo para diferentes DRMs.",
"items": {
"type": "object",
"description": "Item de chave de jogo. Ele representa o jogo em uma determinada plataforma (Steam, GOG, etc.).",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "ID de item exclusivo interno que é fornecido na criação do item."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Tipo de item. Neste caso é sempre `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Preços em moedas reais.",
"example": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true
}
],
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"is_default": {
"type": "boolean",
"description": "O preço padrão é usado para criar o catálogo se nenhum preço for especificado na moeda do usuário."
},
"is_enabled": {
"type": "boolean"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "País onde este preço está disponível. Código de duas letras de acordo com o padrão [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
},
"virtual_prices": {
"type": [
"array",
"null"
],
"example": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Gold"
},
"description": "Objeto com localizações para o nome da moeda virtual. As chaves são especificadas no padrão ISO 3166-1."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Tipo de item. Neste caso é sempre `virtual_currency`."
},
"description": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"example": {
"en": "Game 1 Example"
},
"description": "Objeto com localizações para descrição do jogo. As chaves são especificadas no padrão ISO 3166-1."
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL da imagem."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Prioridade da ordem de jogos na lista."
},
"is_enabled": {
"type": "boolean",
"description": "Se desabilitado, o item não poderá ser comprado nem acessado pelo inventário."
},
"is_show_in_store": {
"type": "boolean",
"description": "O item está disponível para compra."
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Nome do DRM da chave de jogo."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "ID de DRM exclusivo."
},
"drm_image": {
"type": [
"string",
"null"
],
"example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"description": "Ícone de DRM da chave de jogo."
},
"drm_id": {
"type": "integer",
"example": 1,
"description": "ID exclusivo interno do DRM."
},
"keys": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"description": "Número de chaves disponíveis para compra."
},
"total": {
"type": "integer",
"description": "Número total de chaves carregadas."
},
"used": {
"type": "integer",
"description": "Número de chaves vendidas."
}
}
},
"is_sales_exist": {
"type": "boolean",
"description": "Se `true`, a chave de jogo foi comprada pelos usuários."
},
"pre_order": {
"type": "object",
"description": "Configurações de pré-venda.",
"properties": {
"release_date": {
"type": [
"string",
"null"
],
"description": "Data de lançamento da chave de jogo no formato ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Se desabilitado, o item não é uma pré-venda."
},
"description": {
"type": [
"string",
"null"
],
"description": "Informações adicionais para a pré-venda que serão enviadas por e-mail."
}
}
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Grupo aos quais o item pertence.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"item_id": 1,
"sku": "com.xsolla.game_1",
"type": "unit",
"name": {
"en": "Game 1"
},
"description": {
"en": "Example game 1"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": false,
"unit_items": [
{
"item_id": 3,
"sku": "com.xsolla.game_1_key_1",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1199.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"drm_id": 1,
"keys": {
"available": 3,
"total": 4,
"used": 1
},
"is_sales_exist": false,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
]
},
{
"item_id": 4,
"sku": "com.xsolla.game_1_key_2",
"type": "game_key",
"name": {
"en": "Game 1 Key 2"
},
"groups": [],
"attributes": [],
"is_free": false,
"prices": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": null,
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": true,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": "Some description"
},
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
{
"item_id": 2,
"sku": "com.xsolla.game_2",
"type": "unit",
"name": {
"en": "Game 2"
},
"description": {
"en": "Example game 2"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": true,
"unit_items": [
{
"item_id": 5,
"sku": "com.xsolla.game_2_key_2",
"type": "game_key",
"is_free": false,
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"order": 1,
"is_enabled": false,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": true,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
]
}
}
}
}
}
},
"Game-Keys_401-invalid-basic-auth": {
"description": "Autenticação básica não aprovada ou errada. Verifique se você usou a autenticação básica ou as credenciais corretas.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Game-Keys_422-invalid-request": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Game-Keys_422-invalid-request"
},
"examples": {
"The property `drm_sku` is required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `drm_sku` is required"
}
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
}
}
}
}
},
"Game-Keys_200-admin-get-game-by-sku": {
"description": "Jogo recebido com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com informações do jogo.",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "ID de item exclusivo interno que é fornecido na criação do item."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"type": {
"type": "string",
"example": "unit",
"description": "Tipo de item. Neste caso é sempre `unit`."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL da imagem."
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Recursos adicionais do jogo, como capturas de tela, vídeo de jogabilidade e assim por diante.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Tipo de mídia: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Arquivo de recurso."
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Prioridade da ordem de jogos na lista."
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Grupo aos quais o item pertence.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_enabled": {
"type": "boolean"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_show_in_store": {
"type": "boolean"
},
"unit_items": {
"type": "array",
"description": "Chaves de jogo para diferentes DRMs.",
"items": {
"type": "object",
"description": "Item de chave de jogo. Ele representa o jogo em uma determinada plataforma (Steam, GOG, etc.).",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "ID de item exclusivo interno que é fornecido na criação do item."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Tipo de item. Neste caso é sempre `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Preços em moedas reais.",
"example": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_is": "RU"
}
],
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"is_default": {
"type": "boolean",
"description": "O preço padrão é usado para criar o catálogo se nenhum preço for especificado na moeda do usuário."
},
"is_enabled": {
"type": "boolean"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "País onde este preço está disponível. Código de duas letras de acordo com o padrão [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
},
"virtual_prices": {
"type": [
"array",
"null"
],
"example": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Gold"
},
"description": "Objeto com localizações para o nome da moeda virtual. As chaves são especificadas no padrão ISO 3166-1."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Tipo de item. Neste caso é sempre `virtual_currency`."
},
"description": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Game 1 Example"
},
"description": "Objeto com localizações para descrição do jogo. As chaves são especificadas no padrão ISO 3166-1."
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL da imagem."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Prioridade da ordem de jogos na lista."
},
"is_enabled": {
"type": "boolean",
"description": "Se desabilitado, o item não poderá ser comprado nem acessado pelo inventário."
},
"is_show_in_store": {
"type": "boolean",
"description": "O item está disponível para compra."
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Nome do DRM da chave de jogo."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "ID de DRM exclusivo."
},
"drm_image": {
"type": [
"string",
"null"
],
"example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"description": "Ícone de DRM da chave de jogo."
},
"drm_id": {
"type": "integer",
"example": 1,
"description": "ID exclusivo interno do DRM."
},
"keys": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"description": "Número de chaves disponíveis para compra."
},
"total": {
"type": "integer",
"description": "Número total de chaves carregadas."
},
"used": {
"type": "integer",
"description": "Número de chaves vendidas."
}
}
},
"is_sales_exist": {
"type": "boolean",
"description": "Se `true`, a chave de jogo foi comprada pelos usuários."
},
"pre_order": {
"type": "object",
"description": "Configurações de pré-venda.",
"properties": {
"release_date": {
"type": [
"string",
"null"
],
"description": "Data de lançamento da chave de jogo no formato ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Se desabilitado, o item não é uma pré-venda."
},
"description": {
"type": [
"string",
"null"
],
"description": "Informações adicionais para a pré-venda que serão enviadas por e-mail."
}
}
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"item_id": 1,
"sku": "com.xsolla.game_1",
"type": "unit",
"name": {
"en": "Game 1"
},
"description": {
"en": "Example game 1"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": false,
"unit_items": [
{
"item_id": 3,
"sku": "com.xsolla.game_1_key_1",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1199.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"drm_id": 1,
"keys": {
"available": 3,
"total": 4,
"used": 1
},
"is_sales_exist": false,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"item_id": 4,
"sku": "com.xsolla.game_1_key_2",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": null,
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": false,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": null
},
"regions": [
{
"id": 12
},
{
"id": 64
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
}
}
}
},
"Game-Keys_200-session-information": {
"description": "As informações da sessão de carregamento de códigos foram recebidas com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"session_id": {
"type": "string",
"example": "fc7105b6e8ee01339582970b37697242"
},
"count_uploaded": {
"type": "integer",
"example": 0
},
"count_total": {
"type": "integer",
"example": 100
},
"count_skipped": {
"type": "integer",
"example": 10
},
"status": {
"type": "string",
"example": "processing"
}
}
},
"examples": {
"response": {
"value": {
"session_id": "fc7105b6e8ee01339582970b37697242",
"count_uploaded": 0,
"count_total": 100,
"count_skipped": 10,
"status": "processing"
}
}
}
}
}
},
"Game-Keys_200-get-codes": {
"description": "Os códigos foram recebidos com sucesso.",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "PIN-CODE-ALL PIN-CODE-ALL-3"
},
"examples": {
"response": {
"value": "PIN-CODE-ALL PIN-CODE-ALL-3"
}
}
}
}
},
"Game-Keys_200-user-entitlement-list": {
"description": "Lista de chaves de jogo que o usuário possui recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com informações do jogo.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"total_items_count": {
"$ref": "#/components/schemas/Pagination_total-items-count"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Game-Keys_entitlement_item"
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"total_items_count": 1,
"items": [
{
"name": "The Greatest Game in the World",
"description": "Description of the greatest game in the world.",
"image_url": "https://none",
"project_id": 30810,
"game_sku": "com.xsolla.key_1",
"drm": "drmfree",
"is_pre_order": false
}
]
}
}
}
}
}
},
"Game-Keys_403-auth-header-not-sent": {
"description": "Cabeçalho de autorização não enviado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 403
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "Authorization header not sent."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}
}
}
}
}
},
"Bundles_200-admin-get-bundle-list": {
"description": "A lista de conjuntos foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com itens.",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
}
}
}
},
"example": {
"items": [
{
"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {
"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {
"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {
"en": "Ultra Super lootbox with different items"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [
{
"amount": "150.49",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.booster_min_1",
"name": {
"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Booster"
},
"type": "virtual_good",
"description": {
"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{
"sku": "com.xsolla.gloves_1",
"name": {
"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {
"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{
"sku": "com.xsolla.boots_1",
"name": {
"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {
"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{
"sku": "com.xsolla.gun_max",
"name": {
"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {
"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{
"sku": "com.xsolla.minigun_2",
"name": {
"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {
"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677639600,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-01T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
},
{
"item_id": 610317,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
}
}
}
},
"Bundles_401-invalid-basic-auth": {
"description": "Autenticação básica não aprovada ou errada. Verifique se você usou a autenticação básica ou as credenciais corretas.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Bundles_201-admin-create-bundle": {
"description": "Conjunto criado com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
}
}
},
"examples": {
"response": {
"value": {
"sku": "com.xsolla.kg_1"
}
}
}
}
}
},
"Bundles_422-invalid-request": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_422-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
},
"Custom attributes JSON can’t exceed 500 characters": {
"$ref": "#/components/examples/422-custom-attributes-size-exceeded"
}
}
}
}
},
"Bundles_200-admin-get-bundle-list-in-group": {
"description": "A lista de conjuntos foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com itens.",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
}
}
}
},
"example": {
"items": [
{
"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {
"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {
"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {
"en": "Ultra Super lootbox with different items"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [
{
"amount": "150.49",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.booster_min_1",
"name": {
"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Booster"
},
"type": "virtual_good",
"description": {
"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{
"sku": "com.xsolla.gloves_1",
"name": {
"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {
"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{
"sku": "com.xsolla.boots_1",
"name": {
"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {
"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{
"sku": "com.xsolla.gun_max",
"name": {
"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {
"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{
"sku": "com.xsolla.minigun_2",
"name": {
"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {
"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "weekly",
"day_of_week": 2,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-07T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
},
{
"item_id": 610317,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
}
}
}
},
"Bundles_200-admin-get-bundle": {
"description": "O conjunto especificado foi recebido com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
},
"example": {
"item_id": 610316,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
}
}
}
},
"Bundles_204-admin-update-bundle": {
"description": "Conjunto atualizado com sucesso.",
"content": {}
},
"Bundles_204-admin-delete-bundle": {
"description": "Conjunto excluído com sucesso.",
"content": {}
},
"Bundles_204-admin-show-bundle": {
"description": "Conjunto exibido com sucesso.",
"content": {}
},
"Bundles_204-admin-hide-bundle": {
"description": "Conjunto ocultado com sucesso.",
"content": {}
},
"Bundles_200-get-bundle-list": {
"description": "A lista de conjuntos foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com itens.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_client_bundle"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Bundles_200-get-bundle-list"
}
}
}
}
},
"Cart-Payment_200-get-cart-json-model": {
"description": "O carrinho com itens foi devolvido com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "ID do carrinho."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string",
"default": "50.0000000000000000"
},
"amount_without_discount": {
"type": "string",
"default": "100.0000000000000000"
},
"currency": {
"type": "string",
"default": "USD"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Preço do carrinho."
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Preço do item."
},
"virtual_item_type": {
"type": "string",
"description": "Tipo de item."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_200-fill-cart-json-model": {
"description": "O carrinho com itens foi devolvido com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "ID do carrinho."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string",
"default": "50.0000000000000000"
},
"amount_without_discount": {
"type": "string",
"default": "100.0000000000000000"
},
"currency": {
"type": "string",
"default": "USD"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Preço do carrinho."
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Preço do item."
},
"virtual_item_type": {
"type": "string",
"description": "Tipo de item."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"warnings": [
{
"sku": "com.xsolla.booster_mega_21",
"quantity": 1,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found"
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_404-item": {
"description": "O item não foi encontrado. Certifique-se de que o `project_id` e o `item_sku` estão corretos.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found"
}
},
"type": "object"
}
}
}
},
"Cart-Payment_422-non-negative-quantity": {
"description": "A quantidade do item deve ser um número inteiro não negativo.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "Item quantity must be non-negative integer."
},
"errorCode": {
"type": "integer",
"example": 1102
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1102,
"errorMessage": "[0401-1102]: Item quantity must be non-negative integer",
"statusCode": 422
}
}
}
}
}
},
"Cart-Payment_422-can-put-only-virtual-good-to-cart": {
"description": "Esse tipo de item não pode ser colocado no carrinho. Selecione outro tipo de item.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1421
},
"errorMessage": {
"type": "string",
"example": "This type of item cannot be put to the cart. Select another type of item."
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1421,
"errorMessage": "Only Virtual Good Supported"
}
}
}
}
}
},
"Cart-Payment_200-order-created": {
"description": "Pedido criada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID de pedido."
},
"token": {
"type": "string",
"description": "Token de pagamento."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641,
"token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}
}
}
}
}
},
"Cart-Payment_422-invalid-cart": {
"description": "Carrinho inválido. Verifique se o carrinho existe, não está vazio e todos os itens nele não são gratuitos.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1401
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1401]: Invalid cart"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1401,
"statusCode": 422,
"errorMessage": "[0401-1401]: Invalid cart"
}
}
}
}
}
},
"Cart-Payment_404-create-order-with-item-not-found-errors": {
"description": "Item ou cupom não encontrado. Verifique se os dados usados estão corretos.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"coupon not found": {
"$ref": "#/components/examples/404-coupon-not-found"
}
}
}
}
},
"Cart-Payment_422-create-order-with-item-invalid": {
"description": "Erro inválido.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1411
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1411]: Invalid item"
}
}
},
"examples": {
"invalid item": {
"value": {
"errorCode": 1411,
"statusCode": 422,
"errorMessage": "[0401-1411]: Invalid item"
}
},
"code expired": {
"value": {
"errorCode": 9810,
"statusCode": 422,
"errorMessage": "[0401-9810]: Sorry, this code is expired."
}
},
"code redemption limit": {
"value": {
"errorCode": 9804,
"statusCode": 422,
"errorMessage": "[0401-9804]: You have reached the coupon redemption limit."
}
},
"regionally restricted": {
"value": {
"errorCode": 9808,
"statusCode": 422,
"errorMessage": "[0401-9808]: Coupon is not available in your region."
}
}
}
}
}
},
"Cart-Free_200-order-created": {
"description": "O pedido grátis foi criado com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID de pedido."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"Cart-Payment_422-invalid-item": {
"description": "Item inválido. Verifique se o item existe, não está desativado, se foi excluído ou se não é gratuito.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1411
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1411]: Invalid item"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1411,
"statusCode": 422,
"errorMessage": "[0401-1411]: Invalid item"
}
}
}
}
}
},
"Cart-Payment_200-get-order": {
"description": "Solicitação de pedido bem-sucedida.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"example": 1,
"default": "Order ID.",
"description": "ID de pedido."
},
"status": {
"type": "string",
"example": "paid",
"enum": [
"new",
"paid",
"done",
"canceled",
"expired"
],
"description": "Status do pedido. Consulte a seção [Ciclo de vida do pedido](https://developers.xsolla.com/pt/api/catalog/order-life-cycle) para obter uma descrição de status detalhada."
},
"content": {
"type": "object",
"description": "Detalhes do pedido.",
"properties": {
"price": {
"type": "object",
"description": "Preço do pedido.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Preço do pedido com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Preço do pedido."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do pedido. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_price": {
"type": "object",
"description": "Preço do pedido em moedas virtuais.",
"properties": {
"amount": {
"type": "string",
"example": "100",
"description": "Preço do pedido com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "150",
"description": "Preço do pedido."
},
"currency": {
"type": "string",
"example": "test_vc",
"description": "SKU de moeda virtual usado no pedido."
}
}
},
"is_free": {
"type": "boolean",
"example": false,
"description": "Se `true`, o pedido é gratuito."
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.item_1",
"quantity": 1,
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
}
],
"description": "Lista de itens.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "some_sku",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"quantity": {
"type": "integer",
"example": 1,
"description": "Quantidade do item."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Preço do item.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Preço do item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"order_id": 1,
"status": "paid",
"content": {
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
},
"is_free": false,
"items": [
{
"sku": "com.xsolla.item_1",
"quantity": 1,
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
}
]
}
}
}
}
}
}
},
"Cart-Payment_404-get-order": {
"description": "Pedido não encontrado. Certifique-se de que o `project_id` e o `order_id` estão corretos.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9001
},
"errorMessage": {
"type": "string",
"example": "[0401-9001]: Order not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9001,
"errorMessage": "[0401-9001]: Order not found"
}
}
}
}
}
},
"200-admin-order-search": {
"description": "A lista de pedidos foi recuperada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"orders": {
"type": "array",
"description": "Lista de pedidos.",
"items": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"example": 1,
"description": "ID de pedido."
},
"project_id": {
"type": "integer",
"example": 44056,
"description": "ID do projeto. Você pode encontrar esse parâmetro em sua [Conta de Distribuidor](https://publisher.xsolla.com/) ao lado do nome do projeto."
},
"status": {
"type": "string",
"enum": [
"new",
"paid",
"done",
"canceled",
"expired"
],
"example": "paid",
"description": "Status do pedido. Consulte a seção [Ciclo de vida do pedido](https://developers.xsolla.com/pt/api/catalog/order-life-cycle) para obter uma descrição de status detalhada."
},
"date_created": {
"type": "string",
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Data de criação do pedido ou código de data e hora de acordo com o padrão [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "Modo de criação de pedidos."
},
"is_free": {
"type": "boolean",
"example": false,
"description": "Se o pedido é gratuito ou não."
},
"invoice_id": {
"type": "string",
"description": "ID da fatura."
},
"price": {
"type": [
"object",
"null"
],
"description": "Preço do pedido.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Preço final do pedido."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Preço do pedido sem descontos."
},
"currency": {
"type": "string",
"example": "USD",
"description": "SKU da moeda virtual ou código de três letras de uma moeda real de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre as [moedas suportadas pela Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
},
"is_virtual_currency": {
"type": "boolean",
"example": false,
"description": "Se a moeda é virtual ou não."
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "07e653a2b15011e6818f005056a54369",
"description": "ID de usuário passado ao criar o pedido."
},
"country": {
"type": "string",
"description": "Código de país de duas letras maiúsculas de acordo com o padrão [ISO 3166-1 alfa-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Verifique a documentação para obter informações detalhadas sobre os [países suportados pela Xsolla](https://developers.xsolla.com/pt/doc/shop-builder/references/supported-countries/).",
"example": "US"
},
"email": {
"type": "string",
"format": "email",
"example": "user@xsolla.com",
"description": "E-mail do usuário formatado de acordo com o protocolo [RFC 822](https://www.w3.org/Protocols/rfc822/#z8)."
},
"region_id": {
"type": [
"integer",
"null"
],
"example": 12,
"description": "ID da região do usuário. Ele será devolvido se as restrições de vendas regionais forem configuradas. O país do usuário, passado ao criar o pedido, é correspondido com a lista de países especificados ao [criar a região](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-region/). Consulte a [documentação](https://developers.xsolla.com/pt/doc/shop-builder/features/regional-restrictions/) para obter mais informações sobre restrições de vendas regionais."
}
}
},
"items": {
"type": "array",
"description": "Lista de itens.",
"items": {
"type": "object",
"properties": {
"order_item_id": {
"type": "integer",
"description": "ID do item na ordem. Ele é gerado pela Xsolla durante a criação do pedido."
},
"item_id": {
"type": "integer",
"example": 1,
"description": "ID do item. Ele é gerado pela Xsolla ao criar um item."
},
"sku": {
"type": "string",
"example": "elven_shield",
"description": "ID do item especificado durante sua criação. O SKU pode conter apenas caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Tipo de item.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good",
"value_point"
]
},
"quantity": {
"type": "integer",
"example": 1,
"description": "Quantidade do item."
},
"is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Se o item é gratuito ou não."
},
"is_bonus": {
"type": "boolean",
"example": false,
"description": "Se o item é um bônus ou não."
},
"region_id": {
"type": [
"integer",
"null"
],
"description": "ID da região onde o item está disponível. Consulte a [documentação](https://developers.xsolla.com/pt/doc/shop-builder/features/regional-restrictions/) para obter mais informações sobre restrições de vendas regionais."
},
"tax_category": {
"type": "string",
"example": "DG00002",
"description": "Categoria fiscal."
},
"price": {
"type": [
"object",
"null"
],
"description": "Preço do item.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Preço do item sem descontos."
},
"currency": {
"type": "string",
"example": "USD",
"description": "SKU da moeda virtual ou código de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre as [moedas suportadas pela Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
},
"is_virtual_currency": {
"type": "boolean",
"example": false,
"description": "Se a moeda é virtual ou não."
}
}
},
"description": {
"type": [
"object",
"null"
],
"description": "Objeto com informações sobre o item.",
"properties": {
"name": {
"type": "string",
"description": "Nome do item."
},
"image_url": {
"type": "string",
"format": "uri",
"description": "URL da imagem do item."
},
"description": {
"type": "string",
"description": "Descrição do item."
}
}
}
}
}
},
"promotions": {
"type": [
"array",
"null"
],
"description": "Lista de promoções aplicada ao pedido.",
"items": {
"type": "object",
"properties": {
"promotion_id": {
"type": "integer",
"example": 111425,
"description": "ID da promoção dentro do projeto."
}
}
}
},
"coupons": {
"type": [
"array",
"null"
],
"description": "Lista de cupons aplicada ao pedido.",
"items": {
"type": "object",
"properties": {
"coupon_id": {
"type": "integer",
"description": "ID do cupom, gerado pela Xsolla ao criar uma promoção com um cupom."
},
"sku": {
"type": "string",
"description": "SKU do cupom, gerado pela Xsolla ao criar uma promoção com cupom."
},
"code": {
"type": "string",
"description": "Código de cupom usado. Código exclusivo que diferencia maiúsculas de minúsculas. Contém letras e números."
},
"type": {
"type": "string",
"enum": [
"unique_catalog_offer",
"coupon",
"promocode"
],
"description": "Tipo de cupom."
}
}
}
}
}
}
},
"total_items_count": {
"type": "integer",
"example": 1,
"description": "O número total de pedidos para o período de tempo especificado."
},
"has_more": {
"type": "boolean",
"example": true,
"description": "Se existem páginas adicionais ou não."
}
}
},
"examples": {
"response": {
"value": {
"orders": [
{
"order_id": 100511,
"project_id": 101,
"status": "done",
"date_created": "2018-01-08T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": 1
},
"is_free": true,
"items": [
{
"order_item_id": 29,
"item_id": 1005111,
"sku": "com.xsolla.1005111",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": false,
"region_id": 1,
"tax_category": "DG00001",
"description": {
"name": "bla",
"image_url": "http://example.com/image.jpg",
"description": "yes"
}
},
{
"order_item_id": 30,
"item_id": 1005112,
"sku": "com.xsolla.1005112",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": 1,
"tax_category": "DG00001",
"description": null
}
]
},
{
"order_id": 100510,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-07T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [
{
"order_item_id": 27,
"item_id": 1005101,
"sku": "com.xsolla.1005101",
"type": "game_key",
"quantity": 1,
"is_free": false,
"is_bonus": false,
"region_id": null,
"tax_category": "DG00001",
"description": null,
"price": {
"amount": "67.3400",
"amount_without_discount": "67.3400",
"currency": "USD",
"is_virtual_currency": false
}
},
{
"order_item_id": 28,
"item_id": 1005102,
"sku": "com.xsolla.1005102",
"type": "value_point",
"quantity": 2,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {
"amount": "67.3400",
"amount_without_discount": "72.3400",
"currency": "USD",
"is_virtual_currency": false
},
"invoice_id": "100510",
"promotions": [
{
"promotion_id": 1005101
}
],
"coupons": [
{
"coupon_id": 100510,
"sku": "com.xsolla.100510",
"code": "OPQRSTUVWX",
"type": "promocode"
}
]
},
{
"order_id": 100505,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-02T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [
{
"order_item_id": 17,
"item_id": 1005051,
"sku": "com.xsolla.1005051",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
},
{
"order_item_id": 18,
"item_id": 1005052,
"sku": "com.xsolla.1005052",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {
"amount": "78.2300",
"amount_without_discount": "78.2300",
"currency": "popugi",
"is_virtual_currency": true
}
}
],
"total_items_count": 11,
"has_more": true
}
}
}
}
}
},
"401-invalid-basic-auth": {
"description": "Autenticação básica não aprovada ou errada. Verifique se você usou a autenticação básica ou as credenciais corretas.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Cart-Payment_201-admin-create-payment-token": {
"description": "Token de pagamento e pedido criados com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Token de pagamento."
},
"order_id": {
"type": "integer",
"example": 1,
"description": "ID de pedido."
}
}
},
"examples": {
"response": {
"value": {
"token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb",
"order_id": 12345
}
}
}
}
}
},
"Cart-Payment_401-invalid-basic-auth": {
"description": "Autenticação básica não aprovada ou errada. Verifique se você usou a autenticação básica ou as credenciais corretas.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Cart-Payment_422-admin-create-payment-token": {
"description": "Erro de corpo de solicitação e validação de criação do carrinho.\n- Carrinho inválido, criado a partir de itens passados. Verifica se o carrinho não está vazio e se todos os itens não são gratuitos.\n- Corpo de solicitação inválido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request"
},
"examples": {
"Invalid request body": {
"value": {
"errorCode": 1102,
"statusCode": 422,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Item is free": {
"value": {
"errorCode": 1421,
"statusCode": 422,
"errorMessage": "[0401-1421]: Item is free",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Invalid cart": {
"value": {
"errorCode": 1401,
"statusCode": 422,
"errorMessage": "[0401-1401]: Invalid cart",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Empty cart": {
"value": {
"errorCode": 1417,
"statusCode": 422,
"errorMessage": "[0401-1417]: Empty cart! Cart shouldn't be empty!",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"User country not provided": {
"value": {
"errorCode": 1102,
"statusCode": 422,
"errorMessage": "[0401-1102]: The parameter user.country.value or the header X-User-Ip must be specified",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
}
}
}
}
},
"Cart-Payment_200-admin-fill-cart-json-model": {
"description": "O carrinho com itens foi devolvido com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "ID do carrinho. Passe-o para consulta da página de compra ou os pontos de extremidade da API de pagamento."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"description": "Preço do carrinho."
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"description": "Preço do item."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "The cup of tea",
"groups": [
{
"external_id": "cups",
"name": "Cups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Cup",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"quantity": 2,
"sku": "com.xsolla.cup01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"attributes": [],
"description": "Wonderful white T-shirt",
"groups": [],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "White T-shirt",
"price": {
"amount": "3.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"quantity": 1,
"sku": "com.xsolla.t-shirt01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"attributes": [],
"description": "Wonderful white T-shirt",
"groups": [
{
"external_id": "clothes",
"name": "Clothes"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": true,
"is_bonus": false,
"name": "Cat's cup",
"price": null,
"quantity": 1,
"sku": "com.xsolla.cup01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"warnings": [
{
"sku": "com.xsolla.hat01",
"quantity": 1,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = hut01 not found"
}
],
"price": {
"amount": "15.97",
"amount_without_discount": "22.96",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_404-user": {
"description": "O usuário não foi encontrado. Verifique se o token `x-user-for` ou `x-user-id` está correto.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 5008
},
"errorMessage": {
"type": "string",
"example": "[0401-5008]: Could not find User"
}
},
"type": "object"
}
}
}
},
"Common_401-invalid-basic-auth": {
"description": "As credenciais de autenticação básica não foram fornecidas ou estão incorretas. Certifique-se de usar a autenticação básica e verifique se as suas credenciais estão corretas.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"200-admin-get-user-item-limits": {
"description": "Os limites de compra para um usuário foram recebidos com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User-limit-item"
},
"examples": {
"response": {
"value": {
"per_user": {
"total": 10,
"available": 9
}
}
}
}
}
}
},
"connector-422-validation-failed": {
"description": "Erro de validação causado por parâmetros incorretos do corpo da solicitação, propriedades do arquivo ou conteúdo do arquivo.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1803
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1803,
"errorMessage": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"200-items-import-status-model": {
"description": "O status da importação foi recuperado com êxito.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "error",
"description": "Status de importação.\n\nPossíveis valores:\n- `initialized` — A importação foi iniciada.\n- `process` — A importação está em progresso.\n- `done` — A importação foi bem-sucedida.\n- `error` — Devido a erros, a importação não foi concluída ou foi concluída parcialmente.",
"enum": [
"initialized",
"process",
"done",
"error"
]
},
"date_created": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "O carimbo de data da operação de criação de importação no fuso horário GMT+3."
},
"date_updated": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "O carimbo de data em que a importação foi interrompida devido a um erro no fuso horário GMT+3."
},
"date_completed": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "O carimbo de data de conclusão da operação de importação no fuso horário GMT+3. Se a importação foi interrompida devido a um erro e nenhum item foi importado, será retornada uma string vazia."
},
"progress": {
"type": "integer",
"example": 100,
"description": "O progresso da execução da importação em porcentagem."
},
"error": {
"type": "string",
"description": "Descrição do erro geral de importação."
},
"error_code": {
"type": "string",
"description": "O código do erro de importação geral."
},
"result": {
"type": "object",
"description": "Um objeto com dados sobre os resultados da importação e erros de importação para o SKU de itens específicos.",
"properties": {
"errors_count": {
"type": "integer",
"example": 3,
"description": "O número de itens que tiveram erros durante a importação."
},
"total_entities_count": {
"type": "integer",
"example": 11,
"description": "O número total de itens importados."
},
"errors_by_sku": {
"type": "array",
"description": "Uma matriz de objetos com dados sobre erros de importação para SKUs de itens específicos.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "sku_1",
"description": "SKU do item importado."
},
"type": {
"type": "string",
"example": "vi",
"description": "Tipo de item.",
"enum": [
"virtual_good",
"virtual_currency",
"virtual_currency_packages",
"bundle"
]
},
"error_code": {
"type": "integer",
"example": 1001,
"description": "O código de erro de importação para um SKU de item específico."
},
"error_message": {
"type": "string",
"example": "Something went wrong",
"description": "A descrição do erro de importação para um SKU de item específico."
}
}
}
}
}
}
},
"example": {
"status": "error",
"date_created": "2024-11-19T14:27:31+03:00",
"date_updated": "2024-11-19T15:27:31+03:00",
"date_completed": "2024-11-19T15:27:31+03:00",
"progress": 100,
"error": null,
"error_code": null,
"result": {
"errors_count": 2,
"total_entities_count": 10,
"errors_by_sku": [
{
"sku": "com.xsolla.sword_1",
"type": "virtual_items",
"error_code": 4055,
"error_message": "[0401-4055]: Item default price not set"
},
{
"sku": "",
"type": null,
"error_code": 1817,
"error_message": "[0410-1817]: SKU can't be empty"
}
]
}
}
}
}
}
},
"sellable_items_200-get-items-list": {
"description": "A lista de itens vendáveis foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com itens vendáveis.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"price": {
"amount": "1.00",
"amount_without_discount": "1.00",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"price": {
"amount": "0.50",
"amount_without_discount": "0.50",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"price": {
"amount": "0.10",
"amount_without_discount": "0.10",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259768,
"sku": "com.xsolla.gold_chest_1",
"type": "bundle",
"name": "Chest of gold",
"bundle_type": "virtual_currency_package",
"description": "Chest of gold",
"image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png",
"price": {
"amount": "7.99",
"amount_without_discount": "7.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"quantity": 10
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_1",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_1",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259771,
"sku": "com.xsolla.sword_1",
"type": "virtual_good",
"name": "Sword",
"description": "Sword",
"image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 50,
"amount_without_discount": 50,
"calculated_price": {
"amount": "50.00",
"amount_without_discount": "50.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259773,
"sku": "com.xsolla.bow_1",
"type": "virtual_good",
"name": "Bow",
"description": "Bow",
"image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_4",
"name": "Bronze",
"type": "virtual_currency",
"amount": 100,
"amount_without_discount": 100,
"calculated_price": {
"amount": "100.00",
"amount_without_discount": "100.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "bows",
"name": "Bows"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_5",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_5",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_6",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_6",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_6",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_7",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_7",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_7",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_8",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_8",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_8",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259778,
"sku": "com.xsolla.armor_chest_1",
"type": "bundle",
"name": "Chest of armor",
"bundle_type": "standard",
"description": "Chest of armour",
"image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_9",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_9",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_9",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "11.98",
"amount_without_discount": "11.98",
"currency": "USD"
},
"content": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_10",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_10",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_10",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_2",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_11",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_11",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
}
],
"vp_rewards": []
},
{
"item_id": 259779,
"sku": "com.xsolla.treasure_chest_1",
"type": "bundle",
"name": "Treasure Chest",
"bundle_type": "standard",
"description": "Treasure Chest",
"image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_12",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_12",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_12",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "802.89",
"amount_without_discount": "802.89",
"currency": "USD"
},
"content": [
{
"item_id": 259772,
"sku": "com.xsolla.saber_2",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_13",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_2",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_14",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"quantity": 10
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_2",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"quantity": 100
}
],
"vp_rewards": []
}
],
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "ID de item exclusivo interno que é fornecido na criação do item."
},
"sku": {
"type": "string",
"example": "com.xsolla.electric_shield_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Nome do item."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"bundle_type": {
"type": "string",
"description": "Tipo de pacote. Devolvido se o tipo de item for um pacote.",
"enum": [
"standard",
"virtual_currency_package"
]
},
"description": {
"type": "string",
"example": "Electric shield",
"description": "Descrição do item."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "URL da imagem."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Preços dos itens.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "Preço do item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response"
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Se `true`, o usuário pode comprar um item."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Tipo de item virtual.\n\nPossíveis valores:\n- `consumable` — Um item que desaparece do inventário após o uso (ex.: munição)..\n- `non_consumable` — Um item que permanece no inventário por um tempo ilimitado.\n- `non_renewing_subscription` — Item de tempo limitado que pode representar acesso a serviços ou conteúdos por um período específico.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"content": {
"type": "array",
"items": {
"type": "object",
"items": {
"$ref": "#/components/schemas/Bundles_client_content"
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"price": {
"amount": "1.00",
"amount_without_discount": "1.00",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"price": {
"amount": "0.50",
"amount_without_discount": "0.50",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"vp_rewards": []
},
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"price": {
"amount": "0.10",
"amount_without_discount": "0.10",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"vp_rewards": []
},
{
"item_id": 259768,
"sku": "com.xsolla.gold_chest_1",
"type": "bundle",
"name": "Chest of gold",
"bundle_type": "virtual_currency_package",
"description": "Chest of gold",
"image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png",
"price": {
"amount": "7.99",
"amount_without_discount": "7.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"quantity": 10
}
],
"vp_rewards": []
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_1",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"vp_rewards": []
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_1",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"vp_rewards": []
},
{
"item_id": 259771,
"sku": "com.xsolla.sword_1",
"type": "virtual_good",
"name": "Sword",
"description": "Sword",
"image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 50,
"amount_without_discount": 50,
"calculated_price": {
"amount": "50.00",
"amount_without_discount": "50.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259773,
"sku": "com.xsolla.bow_1",
"type": "virtual_good",
"name": "Bow",
"description": "Bow",
"image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 100,
"amount_without_discount": 100,
"calculated_price": {
"amount": "100.00",
"amount_without_discount": "100.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "bows",
"name": "Bows",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_5",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_5",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_2",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_6",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_6",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_6",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_7",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_7",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_7",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 3
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_8",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_8",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_8",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 4
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259778,
"sku": "com.xsolla.armor_chest_1",
"type": "bundle",
"name": "Chest of armor",
"bundle_type": "standard",
"description": "Chest of armour",
"image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_9",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_9",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_9",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "11.98",
"amount_without_discount": "11.98",
"currency": "USD"
},
"content": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_10",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_10",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_10",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_2",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_11",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_11",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
}
],
"vp_rewards": []
},
{
"item_id": 259779,
"sku": "com.xsolla.treasure_chest_1",
"type": "bundle",
"name": "Treasure Chest",
"bundle_type": "standard",
"description": "Treasure Chest",
"image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_12",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_12",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_12",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "802.89",
"amount_without_discount": "802.89",
"currency": "USD"
},
"content": [
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_13",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_2",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"quantity": 10
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_2",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"quantity": 100
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"sellable_items_200-get-item-by-id": {
"description": "O item vendável foi recebido com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com item vendável.",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "ID de item exclusivo interno que é fornecido na criação do item."
},
"sku": {
"type": "string",
"example": "electric_shield",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Nome do item."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"description": {
"type": "string",
"example": "Electric shield",
"description": "Descrição do item."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "URL da imagem."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Preços dos itens.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "Preço do item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response"
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Se `true`, o usuário pode comprar um item."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Tipo de item virtual.\n\nPossíveis valores:\n- `consumable` — Um item que desaparece do inventário após o uso (ex.: munição)..\n- `non_consumable` — Um item que permanece no inventário por um tempo ilimitado.\n- `non_renewing_subscription` — Item de tempo limitado que pode representar acesso a serviços ou conteúdos por um período específico.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"examples": {
"response": {
"value": {
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 10
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
}
}
},
"sellable-item-by-id_404": {
"description": "Item não encontrado. Certifique-se de que o `project_id` e o `item_id` estão corretos.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 259774 not found"
}
}
}
}
}
},
"sellable-item-by-sku_404": {
"description": "Item não encontrado. Certifique-se de que o `project_id` e o `sku` estão corretos.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'electric_shiel' not found"
}
}
}
}
}
},
"sellable_items_200-get-items-by-group-id": {
"description": "A lista de itens vendáveis do grupo especificado foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "clan_value_point_sku_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_4",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
}
],
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "ID de item exclusivo interno que é fornecido na criação do item."
},
"sku": {
"type": "string",
"example": "com.xsolla.electric_shield_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Nome do item."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"description": {
"type": [
"string",
"null"
],
"example": "Electric shield",
"description": "Descrição do item."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "URL da imagem."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Preços dos itens.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Preço do item com desconto."
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "Preço do item."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response"
},
"virtual_item_type": {
"type": "string",
"example": "non_consumable",
"description": "Tipo de item virtual.\n\nPossíveis valores:\n- `consumable` — Um item que desaparece do inventário após o uso (ex.: munição)..\n- `non_consumable` — Um item que permanece no inventário por um tempo ilimitado.\n- `non_renewing_subscription` — Item de tempo limitado que pode representar acesso a serviços ou conteúdos por um período específico.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Se `true`, o usuário pode comprar um item."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shields_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 3
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_2",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 4
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
}
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
]
}
}
}
}
}
},
"200-admin-get-regions-list": {
"description": "Lista de regiões recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com itens.",
"properties": {
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Regions_200-region-short-model"
}
}
}
},
"examples": {
"response": {
"value": {
"regions": [
{
"id": 44,
"name": {
"en-US": "Asia",
"de-DE": "Asien"
}
},
{
"id": 45,
"name": {
"en-US": "CIS",
"de-DE": "GUS"
}
}
]
}
}
}
}
}
},
"201-admin-create-region": {
"description": "Região criada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"region_id": {
"$ref": "#/components/schemas/Regions_region_id"
}
}
},
"example": {
"region_id": 42
}
}
}
},
"200-admin-get-region": {
"description": "A região especificada foi recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Regions_200-region-model"
}
}
}
},
"404-region-not-found": {
"description": "Região não encontrada. Verifique se o `id` está correto.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9701
},
"errorMessage": {
"type": "string",
"example": "[0401-9701]: Region not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"204-admin-update-region": {
"description": "Região atualizada com sucesso.",
"content": {}
},
"204-admin-delete-region": {
"description": "Região excluída com sucesso.",
"content": {}
},
"200-admin-get-attribute-list-response": {
"description": "Lista de atributos recebida com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objeto com itens.",
"properties": {
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin_attribute_response"
}
},
"total_count": {
"type": "integer"
}
}
},
"examples": {
"response": {
"value": {
"total_count": 2,
"attributes": [
{
"external_id": "size",
"name": {
"en": "Size",
"de": "Größe"
}
},
{
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
]
}
}
}
}
}
},
"201-admin-create-attribute": {
"description": "O atributo foi criado com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
}
}
},
"example": {
"external_id": "genre"
}
}
}
},
"422-validation-failed": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas-422-invalid-request"
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
}
}
}
}
}
},
"200-admin-get-attribute": {
"description": "O atributo especificado foi recebido com sucesso.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin_attribute_response"
}
}
}
},
"404-attribute-not-found": {
"description": "Atributo não encontrado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9901
},
"errorMessage": {
"type": "string",
"example": "[0401-9901]: Attribute not found."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-9901]: Attribute not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"204-admin-update-attribute": {
"description": "Atributo atualizado com sucesso.",
"content": {}
},
"201-admin-create-attribute-value": {
"description": "O valor do atributo foi criado com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
}
}
},
"example": {
"external_id": "rpg"
}
}
}
},
"403-auth-header-not-sent": {
"description": "Cabeçalho de autorização não enviado.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 403
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "Authorization header not sent."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}
}
}
}
}
},
"422-create-update-attribute-value": {
"description": "Solicitação inválida.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas-422-invalid-request"
},
"examples": {
"external_id is required": {
"$ref": "#/components/examples/422-external-id-required"
},
"external_id is invalid": {
"$ref": "#/components/examples/422-external-id-invalid"
},
"external_id is duplicate": {
"$ref": "#/components/examples/422-external-id-duplicate"
},
"value is required": {
"$ref": "#/components/examples/422-value-invalid"
},
"value properties minimum length": {
"$ref": "#/components/examples/422-value-properties-required"
},
"value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
}
}
}
}
},
"404-attribute-value-not-found": {
"description": "Valor de atributo não encontrado.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404-not-found"
},
"examples": {
"Attribute not found": {
"$ref": "#/components/examples/404-attribute-not-found"
},
"Attribue value not found": {
"$ref": "#/components/examples/404-attribute-value-not-found"
}
}
}
}
}
},
"requestBodies": {
"Virtual-Items-Currency_admin-create-virtual-item": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-item"
},
"examples": {
"default": {
"summary": "Minimal setup example",
"value": {
"sku": "booster_mega_1",
"name": {
"en": "Mega Booster"
},
"description": {
"en": "Temporarily doubles the experience points earned in battle."
}
}
},
"quickstart": {
"summary": "Quickstart example",
"value": {
"sku": "booster_mega_1",
"name": {
"en": "Mega Booster",
"de": "Mega-Booster"
},
"description": {
"en": "Temporarily doubles the experience points earned in battle.",
"de": "Verdoppelt vorübergehend die im Kampf erhaltenen Erfahrungspunkte."
},
"is_enabled": true,
"is_show_in_store": true,
"is_free": false,
"groups": [
"boosters"
],
"order": 1,
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
]
}
},
"full-payload": {
"summary": "Full payload example",
"value": {
"sku": "com.xsolla.sword_1",
"name": {
"en": "Sword",
"de": "Schwert"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
"weapons"
],
"order": 1,
"description": {
"en": "A sword is a bladed melee weapon intended for cutting or thrusting that is longer than a knife or dagger, consisting of a long blade attached to a hilt.",
"de": "Ein Schwert ist eine Nahkampfwaffe mit Klinge, die zum Schneiden oder Stechen bestimmt ist, länger als ein Messer oder Dolch ist und aus einer langen Klinge besteht, die an einem Griff befestigt ist."
},
"prices": [
{
"amount": 100,
"currency": "USD",
"is_enabled": true,
"is_default": true
},
{
"amount": 200,
"currency": "CZK",
"country_iso": "CZ",
"is_enabled": false,
"is_default": true
}
],
"vc_prices": [],
"is_show_in_store": true,
"attributes": [
{
"external_id": "craft-materials",
"name": {
"en": "Craft materials"
},
"values": [
{
"external_id": "steel",
"value": {
"en-US": "5"
}
},
{
"external_id": "leather",
"value": {
"en-US": "1"
}
}
]
}
],
"limits": {
"per_user": 5,
"per_item": 100
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency"
},
"example": {
"sku": "com.xsolla.coin_1",
"name": {
"en-US": "Gold coin",
"de-DE": "Goldmünze"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": false,
"groups": [
"gold"
],
"order": 1,
"description": {
"en-US": "The main currency of your kingdom",
"de-DE": "Die Hauptwährung deines Königreichs"
},
"prices": [
{
"amount": 100,
"currency": "USD",
"is_enabled": true,
"is_default": true
}
],
"attributes": [
{
"external_id": "material",
"name": {
"en-US": "Material"
},
"values": [
{
"external_id": "gold",
"value": {
"en-US": "Gold"
}
}
]
}
],
"limits": {
"per_user": 5,
"per_item": 10000
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency-package": {
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.novigrad_crown_500",
"name": {
"en-US": "500x Novigradian crown",
"ru-RU": "500x Новиградских крон"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
"witcher"
],
"order": 1,
"long_description": {
"en-US": "Long Test new",
"ru-RU": "Длинное описание"
},
"description": {
"en-US": "The Crown (also known as the Novigradian crown) is a monetary unit which is used in some Northern Kingdoms",
"ru-RU": "Крона (Также известна как Новиградская крона) - платежная единица, используемая в северных королевствах"
},
"image_url": "https://vignette.wikia.nocookie.net/witcher/images/7/7c/Items_Orens.png/revision/latest?cb=20081113120917",
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"attributes": [
{
"external_id": "event",
"name": {
"en-US": "Event"
},
"values": [
{
"external_id": "10-anniversary",
"value": {
"en-US": "10th anniversary"
}
},
{
"external_id": "christmas",
"value": {
"en-US": "Christmas"
}
}
]
}
],
"prices": [
{
"currency": "USD",
"amount": 99.99,
"is_default": true
},
{
"currency": "EUR",
"amount": 80.03,
"is_enabled": false
}
],
"vc_prices": null,
"content": [
{
"sku": "com.xsolla.novigrad_crown",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency-package"
}
}
}
},
"ItemGroup_create": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-create-request"
},
"example": {
"external_id": "weapons",
"name": {
"en": "Weapons",
"de": "Waffen"
},
"description": {
"en": "Player weapons",
"de": "Spielerwaffen"
},
"iconUrl": "https://example.com/weapons.png",
"isEnabled": true,
"order": 1
}
}
},
"description": "Objeto com dados de grupo de itens.",
"required": true
},
"ItemGroup_update": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-update-request"
},
"example": {
"external_id": "weapons",
"name": {
"en": "Weapons Updated",
"de": "Waffen Aktualisiert"
},
"description": {
"en": "Updated player weapons",
"de": "Aktualisierte Spielerwaffen"
},
"iconUrl": "https://example.com/weapons-new.png",
"isEnabled": true,
"order": 2
}
}
},
"description": "Objeto com dados de grupo de itens para atualizar.",
"required": true
},
"ItemGroup_order": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"title": "Identificar por ID",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID de grupo de itens atribuído pela Xsolla.",
"minimum": 0,
"example": 1
},
"order": {
"type": "integer",
"description": "Novo valor de ordem de exibição.",
"minimum": 0,
"example": 1
}
},
"required": [
"id",
"order"
],
"additionalProperties": false
}
},
{
"title": "Identificar por external_id",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "ID de grupo de itens externo especificado durante a criação.",
"minLength": 1,
"example": "weapons"
},
"order": {
"type": "integer",
"description": "Novo valor de ordem de exibição.",
"minimum": 0,
"example": 1
}
},
"required": [
"external_id",
"order"
],
"additionalProperties": false
}
}
]
},
"examples": {
"by_id": {
"summary": "Identify groups by ID",
"value": [
{
"id": 1,
"order": 1
},
{
"id": 2,
"order": 2
},
{
"id": 3,
"order": 3
}
]
},
"by_external_id": {
"summary": "Identify groups by external_id",
"value": [
{
"external_id": "weapons",
"order": 1
},
{
"external_id": "armor",
"order": 2
},
{
"external_id": "consumables",
"order": 3
}
]
}
}
}
},
"description": "Matriz de grupos com novos valores de pedidos. Todos os itens devem usar o mesmo método de identificação (ou todos por `id` ou todos por `external_id`).",
"required": true
},
"ItemGroup_item_order": {
"content": {
"application/json": {
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/item-in-group-order-request-item"
}
},
"example": [
{
"item_id": 101,
"order": 1
},
{
"item_id": 102,
"order": 2
},
{
"item_id": 103,
"order": 3
}
]
}
},
"description": "Matriz de itens com novos valores de pedido no grupo.",
"required": true
},
"Game-Keys_create-update-game-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "game_1",
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL da imagem."
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Recursos adicionais do jogo, como capturas de tela, vídeo de jogabilidade, etc.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Tipo de mídia: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Arquivo de recurso."
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Prioridade da ordem de jogos na lista."
},
"groups": {
"type": "array",
"description": "Grupo aos quais o item pertence.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
}
},
"required": [
"external_id"
]
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-post-put-attributes"
},
"is_enabled": {
"type": "boolean",
"description": "Se desabilitado, o item não poderá ser comprado nem acessado pelo inventário."
},
"is_show_in_store": {
"type": "boolean",
"description": "O item está disponível para compra."
},
"unit_items": {
"type": "array",
"description": "Chaves de jogo para diferentes DRMs.",
"items": {
"type": "object",
"description": "Item de chave de jogo. Ele representa o jogo em uma determinada plataforma (Steam, GOG, etc.).",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "game_1",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"groups": {
"type": "array",
"description": "Grupo aos quais o item pertence.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
}
},
"required": [
"external_id"
]
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Preços em moedas reais.",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Moeda do preço do item. Código de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
},
"is_default": {
"type": "boolean",
"description": "O preço padrão é usado para criar o catálogo se nenhum preço for especificado na moeda do usuário."
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"vc_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Prioridade da ordem de jogos na lista."
},
"is_enabled": {
"type": "boolean",
"description": "Se desabilitado, o item não poderá ser comprado nem acessado pelo inventário."
},
"is_show_in_store": {
"type": "boolean",
"description": "O item está disponível para compra."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "ID de DRM exclusivo."
},
"pre_order": {
"type": "object",
"description": "Configurações de pré-venda.",
"properties": {
"release_date": {
"type": "string",
"description": "Data de lançamento da chave de jogo no formato ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Se desabilitado, o item não é uma pré-venda."
},
"description": {
"type": "string",
"description": "Informações adicionais para a pré-venda, que serão enviadas por e-mail."
}
},
"required": [
"release_date",
"is_enabled"
]
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/Game-key-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
},
"required": [
"sku",
"drm_sku",
"prices"
]
}
}
},
"required": [
"sku",
"name",
"unit_items"
],
"example": {
"sku": "com.xsolla.game_1",
"name": {
"en-US": "Game name",
"ru-RU": "Название игры"
},
"description": {
"en-US": "Game description",
"ru-RU": "Краткое описание игры"
},
"long_description": {
"en-US": "Game long description",
"ru-RU": "Полное описание игры"
},
"image_url": "http://image.png",
"media_list": [
{
"type": "image",
"url": "http://image.png"
},
{
"type": "video",
"url": "http://video.png"
}
],
"groups": [
"new_games"
],
"is_enabled": true,
"is_show_in_store": true,
"unit_items": [
{
"sku": "com.xsolla.game_key_1",
"name": {
"en-US": "Game key name",
"ru-RU": "Название игрового ключа"
},
"drm_sku": "steam_key_1",
"prices": [
{
"amount": 35.5,
"currency": "USD",
"is_enabled": true,
"is_default": true
}
],
"vc_prices": [
{
"amount": 35.5,
"sku": "com.xsolla.gold_1",
"is_enabled": true,
"is_default": true
}
],
"is_enabled": true,
"is_free": false,
"is_show_in_store": true,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": "Some description"
},
"regions": [
{
"id": 12
},
{
"id": 64
}
],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
}
},
"description": "Objeto com dados de jogo.",
"required": true
},
"Bundles_bundle": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_admin_bundle_request"
},
"example": {
"sku": "com.xsolla.armour_chest_1",
"name": {
"en": "Chest of armour",
"de": "Brustpanzer"
},
"is_enabled": true,
"is_free": true,
"is_paid_randomized_reward": true,
"order": 1,
"long_description": {
"en": "Chest of armour for soldiers",
"de": "Brustpanzer für Soldaten"
},
"description": {
"en": "Chest of armour for soldiers",
"de": "Brustpanzer für Soldaten"
},
"image_url": "https://picture.bundle-with-many-stuff.png",
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"groups": [
"chests"
],
"attributes": [
{
"external_id": "class",
"name": {
"en": "Class"
},
"values": [
{
"external_id": "soldier",
"value": {
"en": "Soldier"
}
},
{
"external_id": "officer",
"value": {
"en": "Officer"
}
}
]
}
],
"prices": [
{
"currency": "USD",
"amount": "9.99",
"is_default": true,
"is_enabled": true
},
{
"currency": "EUR",
"amount": "9.99",
"is_default": false,
"is_enabled": true
}
],
"vc_prices": [],
"content": [
{
"sku": "com.xsolla.iron_gloves_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_boots_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_shield_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_armour_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_helmet_1",
"quantity": 1
}
],
"limits": {
"per_user": null,
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
}
}
},
"description": "Objeto com dados de conjunto.",
"required": true
},
"Cart-Payment_fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"example": {
"items": [
{
"sku": "com.xsolla.booster_mega_1",
"quantity": 123
}
]
},
"properties": {
"items": {
"type": "array",
"description": "Lista de itens.",
"items": {
"type": "object",
"minItems": 1,
"required": [
"sku",
"quantity"
],
"properties": {
"sku": {
"type": "string",
"default": "booster_mega_1"
},
"quantity": {
"type": "number",
"default": 123
}
}
}
}
}
}
}
}
},
"Cart-Payment_put-item-by-cart-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "number",
"description": "Quantidade do item.",
"default": 123
}
}
}
}
}
},
"Cart-Payment_create-order-by-cart-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Moeda do preço do pedido. Código de moeda de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
},
"locale": {
"type": "string",
"description": "Idioma de resposta."
},
"sandbox": {
"type": "boolean",
"description": "Cria um pedido no modo sandbox. A opção está disponível para os usuários especificados na lista de usuários da empresa.",
"default": false
},
"settings": {
"type": "object",
"description": "As configurações para instalar o processo de pagamento e a interface de pagamento para um usuário.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"type": "object",
"description": "Parâmetros específicos do projeto.",
"minProperties": 1,
"maxProperties": 200
}
}
},
"example": {
"sandbox": true,
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}
}
}
},
"Cart-Payment_create-order-with-specified-item-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Moeda do preço do pedido. Código de moeda de três letras de acordo com [a ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre [as moedas suportadas pelo Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/)."
},
"locale": {
"type": "string",
"description": "Idioma de resposta."
},
"sandbox": {
"type": "boolean",
"description": "Cria um pedido no modo sandbox. A opção está disponível para os usuários especificados na lista de usuários da empresa.",
"default": false
},
"quantity": {
"type": "integer",
"minimum": 1,
"description": "Quantidade do item.",
"default": 1
},
"promo_code": {
"type": "string",
"description": "Resgata um código de uma promoção de código promocional com pagamento."
},
"settings": {
"type": "object",
"description": "As configurações para instalar o processo de pagamento e a interface de pagamento para um usuário.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"type": "object",
"description": "Parâmetros específicos do projeto.",
"minProperties": 1,
"maxProperties": 200
}
}
},
"example": {
"sandbox": true,
"quantity": 5,
"promo_code": "discount_code",
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}
}
}
},
"admin-order-search": {
"description": "Parâmetros de pesquisa de pedidos",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Um limite no número de pedidos incluídos na resposta.",
"minimum": 1,
"maximum": 10,
"default": 10,
"nullable": false
},
"offset": {
"type": "integer",
"description": "Número da ordem a partir do qual a lista é gerada (a contagem começa em 0).",
"default": 0,
"minimum": 0,
"nullable": false
},
"created_date_from": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-04-15T18:16:00+05:00",
"description": "Data de início ou data-hora do período de criação do pedido de acordo com o padrão [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
},
"created_date_until": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-04-16T18:16:00+05:00",
"description": "Data de finalização ou data-hora do período de criação do pedido de acordo com o padrão [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
}
}
},
"example": {
"offset": 0,
"limit": 5,
"created_date_from": "2018-01-07T00:00:00+03:00",
"created_date_until": "2018-01-09T16:00:00+03:00"
}
}
}
},
"Cart-Payment_admin-create-payment-token": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"purchase"
],
"properties": {
"sandbox": {
"$ref": "#/components/schemas/Cart-Payment_settings_sandbox"
},
"user": {
"$ref": "#/components/schemas/Cart-Payment_admin-user-request-body"
},
"purchase": {
"$ref": "#/components/schemas/Cart_admin_payment"
},
"promo_code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
},
"settings": {
"type": "object",
"description": "As configurações para instalar o processo de pagamento e a interface de pagamento para um usuário.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"language": {
"$ref": "#/components/schemas/Cart-Payment_settings_locale"
},
"external_id": {
"$ref": "#/components/schemas/Cart-Payment_settings_external_id"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"$ref": "#/components/schemas/Cart-Payment_custom_parameters_token"
}
},
"additionalProperties": false
},
"examples": {
"common": {
"value": {
"user": {
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
},
"email": {
"value": "user@xsolla.com"
},
"country": {
"value": "US",
"allow_modify": false
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"language": "de",
"external_id": "AABBCCDD01",
"currency": "USD",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/pt/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
}
}
},
"in-sandbox": {
"value": {
"sandbox": true,
"user": {
"id": {
"value": "user-id"
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"currency": "USD"
}
}
},
"with-custom-parameters": {
"value": {
"user": {
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
},
"email": {
"value": "user@xsolla.com"
},
"country": {
"value": "US",
"allow_modify": false
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"language": "de",
"external_id": "AABBCCDD01",
"currency": "USD",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/pt/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
},
"custom_parameters": {
"user_public_id": "player1",
"user_os": "windows10"
}
}
}
}
}
}
},
"Cart-Payment_admin-fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart"
},
"examples": {
"basic": {
"value": {
"currency": "USD",
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
}
}
}
}
}
},
"reset-user-limits": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}
}
}
},
"reset-user-limits-flexible": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user_flexible"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}
}
}
},
"update-user-limits-flexible": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"available"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
},
"available": {
"$ref": "#/components/schemas/User-limit_available_flexible"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
},
"available": 0
}
}
}
},
"update-user-limits-strict": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"available"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
},
"available": {
"$ref": "#/components/schemas/User-limit_available"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
},
"available": 1
}
}
}
},
"connector-import-items-body": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connector_external_id",
"file_url"
],
"properties": {
"connector_external_id": {
"type": "string",
"description": "Um valor fixo que especifica o tipo de operação para importar itens.",
"enum": [
"import_items"
]
},
"file_url": {
"type": "string",
"description": "A URL de um arquivo com dados no formato JSON. O arquivo deve ser hospedado em um serviço de armazenamento com acesso público. Você pode baixar o modelo de arquivo na Conta de Distribuidor na seção [Store > Virtual Items > Catalog Management > Import Items (JSON)](https://publisher.xsolla.com/0/projects/0/storefront/import-export/import-items).",
"example": "https://my-bucket.s3.amazonaws.com/items.json"
},
"mode": {
"type": "string",
"description": "Ações de importação:\n\nPossíveis valores:\n- `create` — Adicionar novos itens.\n- `create_and_update` — Adicionar novos itens e atualizar os existentes.\n- `sync` — Adicionar itens novos, atualizar itens existentes, e desativar itens faltantes.",
"enum": [
"create",
"create_and_update",
"sync"
],
"default": "create_and_update"
}
}
}
}
}
},
"create-update-region": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"countries",
"name"
],
"properties": {
"countries": {
"$ref": "#/components/schemas/Regions_countries"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
}
},
"example": {
"name": {
"en-US": "Asia",
"de-DE": "Asien"
},
"countries": [
"JP",
"CN",
"VN"
]
}
}
}
}
},
"create-update-attribute": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"external_id",
"name"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
}
}
},
"example": {
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
}
}
},
"create-update-attribute-value": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/request-attribute-value"
},
"example": {
"external_id": "weapon_class_sword_value",
"value": {
"en": "Sword",
"de": "Schwert"
}
}
}
}
}
},
"examples": {
"422-property-sku-is-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-numbers-of-attribute-values-per-item-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9909,
"errorMessage": "[0401-9909]: The number of attribute values you specified for the item exceeds the required limit. Try to specify fewer attribute values.",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-numbers-of-attributes-per-item-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9908,
"errorMessage": "[0401-9908]: The number of attributes you specified for the item exceeds the required limit. Try to specify fewer attributes.",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-value-limit-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9908,
"errorMessage": "[0401-9908]: You reached the maximum number of values for the attribute.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-custom-attributes-size-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "da145238620011eb8e24fe6913ff226a",
"errorMessageExtended": [
{
"property": "custom_attributes",
"message": "JSON can’t exceed 500 characters."
}
]
}
},
"200-admin-get-group-list": {
"value": {
"groups": [
{
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 5
},
{
"id": 2,
"external_id": "swords",
"name": {
"en": "Swords"
},
"description": {
"en": "Melee weapons"
},
"image_url": "https://example.com/swords.png",
"order": 2,
"is_enabled": true,
"items_count": 3
},
{
"id": 3,
"external_id": "armor",
"name": {
"en": "Armor"
},
"description": {
"en": "Player armor"
},
"image_url": "https://example.com/armor.png",
"order": 3,
"is_enabled": true,
"items_count": 4
}
]
}
},
"201-admin-create-group": {
"value": {
"external_id": "weapons"
}
},
"422-property-external-id-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": [
{
"property": "external_id",
"message": "The property external_id is required"
}
]
}
},
"200-admin-get-group": {
"value": {
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 5
}
},
"200-admin-get-group-list-by-item-type": {
"value": {
"groups": [
{
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 3,
"is_contains_any_items": true
},
{
"id": 2,
"external_id": "swords",
"name": {
"en": "Swords"
},
"description": {
"en": "Melee weapons"
},
"image_url": "https://example.com/swords.png",
"order": 2,
"is_enabled": true,
"items_count": 2,
"is_contains_any_items": true
},
{
"id": 3,
"external_id": "armor",
"name": {
"en": "Armor"
},
"description": {
"en": "Player armor"
},
"image_url": "https://example.com/armor.png",
"order": 3,
"is_enabled": true,
"items_count": 0,
"is_contains_any_items": false
}
]
}
},
"200-admin-get-group-by-item-type": {
"value": {
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 3,
"is_contains_any_items": true
}
},
"404-game-code-not-found": {
"value": {
"statusCode": 404,
"errorCode": 4603,
"errorMessage": "[0401-4603]: Game code not found.",
"transactionId": "transaction id"
}
},
"422-drm-is-not-drm-free": {
"value": {
"statusCode": 422,
"errorCode": 5103,
"errorMessage": "[0401-5103]: Selected drm is not drmfree.",
"transactionId": "transaction id"
}
},
"422-user-already-has-entitlement": {
"value": {
"statusCode": 422,
"errorCode": 5101,
"errorMessage": "[0401-5101]: User already has entitlement.",
"transactionId": "transaction id"
}
},
"Bundles_200-get-bundle-list": {
"value": {
"has_more": true,
"items": [
{
"item_id": 61031,
"sku": "com.xsolla.kg_1",
"name": "kg_10.00_bundle",
"type": "bundle",
"description": "pricePoint_44056_1",
"image_url": null,
"long_description": null,
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
],
"is_free": false,
"order": 999,
"groups": [
{
"external_id": "exclusive",
"name": "Exclusive",
"item_order_in_group": 1
}
],
"price": {
"amount": "9.99",
"currency": "USD",
"amount_without_discount": "9.99"
},
"total_content_price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"media_list": [],
"virtual_prices": [],
"can_be_bought": true,
"bundle_type": "standard",
"promotions": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"content": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "virtual_currency",
"quantity": 100,
"virtual_item_type": "non_consumable",
"attributes": [
{
"external_id": "size",
"name": "Size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Large"
}
]
}
],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"virtual_prices": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
}
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
}
]
}
},
"Bundles_200-get-bundle": {
"value": {
"item_id": 610316,
"sku": "com.xsolla.kg_1",
"name": "kg_10.00_bundle",
"type": "bundle",
"description": "pricePoint_44056_1.",
"image_url": null,
"long_description": null,
"attributes": [],
"is_free": false,
"order": 999,
"groups": [],
"price": {
"amount": "9.99",
"currency": "USD",
"amount_without_discount": "9.99"
},
"total_content_price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"media_list": [],
"virtual_prices": [],
"promotions": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"bundle_type": "standard",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"content": [
{
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"attributes": [],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"virtual_prices": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
}
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
}
},
"404-item-by-sku-not-found": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'item_sku' not found",
"transactionId": "transaction id"
}
},
"404-coupon-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9802,
"errorMessage": "[0401-9802]: Coupon not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-user-not-found": {
"value": {
"statusCode": 404,
"errorCode": 5008,
"errorMessage": "[0401-5008]: Could not find User",
"transactionId": "transaction id"
}
},
"422-user_external_id_invalid": {
"value": {
"statusCode": 404,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "transaction id",
"errorMessageExtended": [
{
"property": "user_external_id",
"message": "Must be at least 1 characters long"
},
{
"property": "user_external_id",
"message": "Does not match the regex pattern ^\\S+$"
}
]
}
},
"422-item-without-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4508,
"errorMessage": "[0401-4508]: Item does not have configured user limits.",
"transactionId": "transaction id"
}
},
"422-item-out-of-range-available-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4510,
"errorMessage": "[0401-4510]: Available item limit is out of range.",
"transactionId": "transaction id"
}
},
"422-external-id-required": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-external-id-invalid": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. Does not match the regex pattern ^[a-zA-Z0-9-_]+$",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-external-id-duplicate": {
"value": {
"statusCode": 422,
"errorCode": 9907,
"errorMessage": "[0401-9907]: The attribute value already exists.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-value-invalid": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `value` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-value-properties-required": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. Array value found, but an object is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-attribute-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-9901]: Attribute not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-attribute-value-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9906,
"errorMessage": "[0401-9906]: Attribute value not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
},
"x-tagGroups": [
{
"name": "ITENS VIRTUAIS & MOEDA",
"tags": [
"virtual-items-currency-overview",
"virtual-items-currency-admin",
"virtual-items-currency-catalog",
"virtual-payment"
]
},
{
"name": "CHAVES DE JOGO",
"tags": [
"game-keys-overview",
"game-keys-catalog",
"game-keys-entitlement",
"game-keys-admin"
]
},
{
"name": "PACOTES",
"tags": [
"bundles-overview",
"bundles-admin",
"bundles-catalog"
]
},
{
"name": "CARRINHO E PAGAMENTO",
"tags": [
"cart-and-payment-overview",
"order-life-cycle",
"cart-client-side",
"cart-server-side",
"payment-client-side",
"payment-server-side",
"order",
"free-item"
]
},
{
"name": "LIMITES",
"tags": [
"limits-overview",
"user-limits-admin"
]
},
{
"name": "IMPORTAÇÃO DE ITENS",
"tags": [
"connector-admin"
]
},
{
"name": "COMUM",
"tags": [
"common-pre-orders",
"common-merchant",
"common-catalog",
"common-regions",
"common-webhooks"
]
},
{
"name": "ATRIBUTOS DO ITEM",
"tags": [
"attribute-admin"
]
},
{
"name": "GRUPOS DE ITENS",
"tags": [
"item-groups-admin",
"item-groups-catalog"
]
}
]
}