{ "openapi": "3.0.0", "info": { "description": "# Visão Geral\n\nDigital Distribution Hub é uma nova solução Xsolla que visa conectar pagamentos digitais e baseados em dinheiro através da tecnologia de pagamentos push e e-commerce.\n\nEssa referência combina pontos de extremidade de API para dois produtos Xsolla: [In-Game Store](https://developers.xsolla.com/pt/doc/in-game-store/) e [Pay Station](https://developers.xsolla.com/pt/doc/pay-station/). Há dois URLs base:\n\n* `https://store.xsolla.com/api` para os grupos **Common**, **Catalog**, **Cart** e **Order**.\n* `https://ps.xsolla.com` para o grupo **Notifications**.\n\nOs pontos de extremidade da API no grupo **Catalog** não exigem autorização. \n\nPara trabalhar com operações nos grupos **Cart** e **Order**, você precisa gerar um token via [Create user token](https://developers.xsolla.com/pt/digital-distribution-hub/common/user-token/create-user-token).\n\n
Observação

Esta referência mostra o design de uma API futura e não uma interface totalmente funcional. Atualmente, você pode experimentar apenas os pontos de extremidade dos grupos Catalog e Notifications. Se você quiser compartilhar seus comentários, envie um e-mail para techdoc@xsolla.com.
", "title": "Digital Distribution Hub", "version": "1.0.0" }, "servers": [ { "url": "https://store.xsolla.com/api" } ], "tags": [ { "name": "cart", "x-displayName": "Carrinho" }, { "name": "game keys", "x-displayName": "Chaves de jogo" }, { "name": "virtual items & currency", "x-displayName": "Itens virtuais e moeda" }, { "name": "bundles", "x-displayName": "Conjuntos" }, { "name": "user token", "x-displayName": "Token de usuário" }, { "name": "notifications", "x-displayName": "Notificações" }, { "name": "order", "x-displayName": "Pedido" } ], "paths": { "/push-payments/cancel": { "post": { "description": "Enviar a notificação sobre o cancelamento do pagamento se:\n - o pagamento não foi concluído\n - o pagamento foi reembolsado", "operationId": "cancel-notification", "requestBody": { "content": { "application/json": { "example": { "payment_id": 784998479 }, "schema": { "properties": { "payment_id": { "type": "integer" } }, "required": [ "payment_id" ], "type": "object" } } } }, "responses": { "200": { "description": "OK." }, "400": { "description": "Solicitação ruim." }, "403": { "description": "Acesso negado." }, "404": { "description": "Pagamento não encontrado." }, "409": { "description": "O pagamento já foi cancelado." }, "422": { "description": "Erro ao cancelar o pagamento." }, "500": { "description": "Erro interno do servidor." } }, "servers": [ { "url": "https://ps.xsolla.com" } ], "summary": "Cancelar notificação", "tags": [ "notifications" ] } }, "/push-payments/pay": { "post": { "description": "Envie esta notificação depois de cobrar um usuário com êxito.", "operationId": "pay-notification", "requestBody": { "content": { "application/json": { "example": { "payment": { "amount": 10, "currency": "USD", "geotype_id": 13038, "ps_transaction_id": "ps_transaction_id" }, "project_id": 18404, "purchase": { "order_id": 1334430 }, "user": { "id": "s.ivanov" } }, "schema": { "properties": { "payment": { "properties": { "amount": { "description": "Valor do pagamento.", "type": "number" }, "currency": { "description": "Moeda do pedido. A moeda virtual usa o SKU e a moeda real usa um código de três letras do padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "type": "string" }, "geotype_id": { "description": "ID do parceiro distribuidor do lado da Xsolla.", "type": "integer" }, "project_transaction_id": { "description": "ID da transação do lado do desenvolvedor do jogo.", "type": "string" }, "ps_transaction_id": { "description": "ID da transação do lado do parceiro de distribuição.", "type": "string" } }, "required": [ "geotype_id", "amount" ], "type": "object" }, "project_id": { "description": "ID do Projeto.", "type": "integer" }, "purchase": { "properties": { "order_id": { "description": "ID do Pedido.", "type": "integer" } }, "required": [ "order_id" ], "type": "object" }, "user": { "properties": { "email": { "description": "Endereço de e-mail do usuário.", "type": "string" }, "id": { "description": "Identificador de usuário exclusivo no jogo.", "type": "string" }, "phone": { "description": "Número de telefone do usuário.", "type": "string" }, "ps_account_id": { "description": "ID da conta de pagamento do usuário do lado do parceiro de distribuição.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "project_id", "payment", "purchase", "user" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "payment_id": 784998484 }, "schema": { "properties": { "payment_id": { "type": "integer" } }, "type": "object" } } }, "description": "OK." }, "400": { "description": "Solicitação ruim." }, "403": { "description": "Acesso negado." }, "404": { "description": "Pedido não encontrado." }, "409": { "description": "O pedido já está pago." }, "422": { "description": "Erro ao criar o pagamento." }, "500": { "description": "Erro interno do servidor." } }, "servers": [ { "url": "https://ps.xsolla.com" } ], "summary": "Notificação de pagamento", "tags": [ "notifications" ] } }, "/v2/project/{project_id}/cart": { "get": { "description": "Retorna o carrinho do usuário atual.", "operationId": "get-user-cart", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "responses": { "200": { "content": { "application/json": { "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", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" } } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_200" } } }, "description": "O carrinho com itens foi devolvido com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter o carrinho do usuário atual", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/clear": { "put": { "description": "Exclui todos os itens do carrinho.", "operationId": "cart-clear", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "responses": { "204": { "description": "O carrinho foi redefinido com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Excluir todos os itens do carrinho atual", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/fill": { "put": { "description": "Enche o carrinho de itens. Se o carrinho já tiver um item com o mesmo SKU, o item existente será substituído pelo valor passado.", "operationId": "cart-fill", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/fill-cart-json-model" }, "responses": { "200": { "content": { "application/json": { "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", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "warnings": [ { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found", "quantity": 1, "sku": "booster_mega_21" } ] } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_200_1" } } }, "description": "O carrinho com itens foi devolvido com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Encher o carrinho com itens", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/item/{item_sku}": { "delete": { "description": "Remove um item do carrinho.", "operationId": "delete-item", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" } ], "responses": { "204": { "description": "O item do carrinho foi excluído com êxito." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart_inline_response_404" } } }, "description": "Item não encontrado. Certifique-se de que o `project_id` e o `item_sku` estão corretos." } }, "security": [ { "AuthForClient": [] } ], "summary": "Excluir item do carrinho atual", "tags": [ "cart" ] }, "put": { "description": "Atualiza um item de carrinho existente ou cria o item no carrinho.", "operationId": "put-item", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/put-item-by-cart-id-json-model" }, "responses": { "204": { "description": "O carrinho foi atualizado com sucesso." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart_inline_response_404" } } }, "description": "Item não encontrado. Certifique-se de que o `project_id` e o `item_sku` estão corretos." }, "422": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1421, "errorMessage": "Only Virtual Good Supported", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_422_1" } } }, "description": "Esse tipo de item não pode ser colocado no carrinho. Selecione outro tipo de item." } }, "security": [ { "basicAuth": [] } ], "summary": "Atualizar item de carrinho no carrinho atual", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/{cart_id}": { "get": { "description": "Devolve o carrinho do usuário pelo ID do carrinho.", "operationId": "get-cart-by-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "responses": { "200": { "content": { "application/json": { "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", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" } } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_200" } } }, "description": "O carrinho com itens foi devolvido com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter carrinho por ID de carrinho", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/{cart_id}/clear": { "put": { "description": "Exclui todos os itens do carrinho.", "operationId": "cart-clear-by-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" } ], "responses": { "204": { "description": "O carrinho foi redefinido com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Excluir todos os itens do carrinho pelo ID do carrinho", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/{cart_id}/fill": { "put": { "description": "Preenche o carrinho específico com itens. Se o carrinho já tiver um item com o mesmo SKU, a posição do item existente será substituída pelo valor passado.", "operationId": "cart-fill-by-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/fill-cart-json-model" }, "responses": { "200": { "content": { "application/json": { "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", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "warnings": [ { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found", "quantity": 1, "sku": "booster_mega_21" } ] } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_200_1" } } }, "description": "O carrinho com itens foi devolvido com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Encher o carrinho específico com itens", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/{cart_id}/item/{item_sku}": { "delete": { "description": "Remove um item do carrinho.", "operationId": "delete-item-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" } ], "responses": { "204": { "description": "O item do carrinho foi excluído com êxito." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart_inline_response_404" } } }, "description": "Item não encontrado. Certifique-se de que o `project_id` e o `item_sku` estão corretos." } }, "security": [ { "AuthForClient": [] } ], "summary": "Excluir item de carrinho por ID de carrinho", "tags": [ "cart" ] }, "put": { "description": "Atualiza um item de carrinho existente ou cria o item no carrinho.", "operationId": "put-item-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/put-item-by-cart-id-json-model" }, "responses": { "204": { "description": "O carrinho foi atualizado com sucesso." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart_inline_response_404" } } }, "description": "Item não encontrado. Certifique-se de que o `project_id` e o `item_sku` estão corretos." }, "422": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Item quantity must be non-negative integer", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_422" } } }, "description": "A quantidade de item deve ser um número inteiro positivo." } }, "security": [ { "basicAuth": [] } ], "summary": "Atualizar item do carrinho por ID do carrinho", "tags": [ "cart" ] } }, "/v2/project/{project_id}/distribution_hub/order/{order_id}": { "get": { "description": "Recupera um pedido especificado.", "operationId": "get-order", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/order-id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "content": { "is_free": "false", "items": [ { "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "quantity": 1, "sku": "some_sku" } ], "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" } }, "order_id": 1, "status": "paid" } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_200_1" } } }, "description": "Solicitação de pedido bem-sucedida." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9001, "errorMessage": "[0401-9001]: Order not found", "statusCode": 404 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_404" } } }, "description": "Pedido não encontrado. Certifique-se de que o `project_id` e o `order_id` estão corretos." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter pedido", "tags": [ "order" ] } }, "/v2/project/{project_id}/distribution_hub/payment/cart": { "post": { "description": "Cria um pedido com todos os itens do carrinho. O pedido criado receberá um status de pedido `new`.", "operationId": "create-order", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-order-model" }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "billing_info": { "direct_taxes": [ { "amount": 150, "name": "TAX", "rate": 10 } ], "indirect_taxes": [ { "amount": 246.75, "name": "VAT", "rate": 20 } ], "price": { "amount": 1480.45, "currency": "USD" } }, "order_id": 641 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_200" } } }, "description": "O pedido foi criado com sucesso." }, "422": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1401, "errorMessage": "[0401-1401]: Invalid cart", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_422" } } }, "description": "Carrinho inválido. Verifique se o carrinho existe, não está vazio, e todos os itens nele não são gratuitos." } }, "security": [ { "AuthForClient": [] } ], "summary": "Criar pedido com todos os itens do carrinho atual", "tags": [ "order" ] } }, "/v2/project/{project_id}/distribution_hub/payment/cart/{cart_id}": { "post": { "description": "Cria um pedido com todos os itens do carrinho específico. O pedido criado receberá um status de pedido `new`.", "operationId": "create-order-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-order-model" }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "billing_info": { "direct_taxes": [ { "amount": 150, "name": "TAX", "rate": 10 } ], "indirect_taxes": [ { "amount": 246.75, "name": "VAT", "rate": 20 } ], "price": { "amount": 1480.45, "currency": "USD" } }, "order_id": 641 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_200" } } }, "description": "O pedido foi criado com sucesso." }, "422": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1401, "errorMessage": "[0401-1401]: Invalid cart", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_422" } } }, "description": "Carrinho inválido. Verifique se o carrinho existe, não está vazio, e todos os itens nele não são gratuitos." } }, "security": [ { "AuthForClient": [] } ], "summary": "Criar pedido com todos os itens de um carrinho específico", "tags": [ "order" ] } }, "/v2/project/{project_id}/distribution_hub/payment/item/{item_sku}": { "post": { "description": "Cria um pedido com um item especificado. O pedido criado receberá um status de pedido `new`.", "operationId": "create-order-with-item", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-order-model" }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "billing_info": { "direct_taxes": [ { "amount": 150, "name": "TAX", "rate": 10 } ], "indirect_taxes": [ { "amount": 246.75, "name": "VAT", "rate": 20 } ], "price": { "amount": 1480.45, "currency": "USD" } }, "order_id": 641 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_200" } } }, "description": "O pedido foi criado com sucesso." }, "422": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1411, "errorMessage": "[0401-1411]: Invalid item", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_422_1" } } }, "description": "Item inválido. Verifique se o item existe, não está desativado, excluído e não está grátis." } }, "security": [ { "AuthForClient": [] } ], "summary": "Criar pedido com item especificado", "tags": [ "order" ] } }, "/v2/project/{project_id}/distribution_hub/user/auth": { "post": { "description": "Verifica se um usuário existe no jogo e cria um token de usuário.", "operationId": "create-user-token", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/post-user-token-json-model" }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" } } }, "schema": { "$ref": "#/components/schemas/Common_inline_response_200_1" } } }, "description": "Token de usuário recebido com êxito." } }, "security": [ { "basicAuth": [] } ], "summary": "Criar token de usuário", "tags": [ "user token" ] } }, "/v2/project/{project_id}/items/bundle": { "get": { "description": "Obtém uma lista de conjuntos para criar um catálogo.\n\n
Atenção. Todos os projetos têm a limitação do número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta.
", "operationId": "get-bundle-list", "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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-get-bundle-list" } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_10" } } }, "description": "A lista de conjuntos foi recebida com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter lista de conjuntos", "tags": [ "bundles" ] } }, "/v2/project/{project_id}/items/bundle/sku/{sku}": { "get": { "description": "Obtém um conjunto especificado.", "operationId": "get-bundle", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-get-bundle" } }, "schema": { "$ref": "#/components/schemas/Catalog_client_bundle" } } }, "description": "O conjunto especificado foi recebido com êxito." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter conjunto especificado", "tags": [ "bundles" ] } }, "/v2/project/{project_id}/items/game": { "get": { "description": "Obtém uma lista de jogos para criar um catálogo.\n\n
Atenção. Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
", "operationId": "get-games-list", "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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": { "$ref": "#/components/examples/client-attribute-game/Catalog_value" }, "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": true, "is_free": false, "is_pre_order": true, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_key_01", "type": "game_key", "virtual_prices": [] }, { "drm_name": "Origin", "drm_sku": "origin", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_2", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_01", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200" } } }, "description": "A lista de jogos foi recebida com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter lista de jogos", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/game/drm": { "get": { "description": "Obtém a lista de DRMs disponíveis.", "operationId": "get-drm-list", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "drm": [ { "drm_id": 1, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "name": "Steam", "redeem_instruction_link": "https://support.steampowered.com", "sku": "steam" }, { "drm_id": 2, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Playstation", "redeem_instruction_link": "https://support.us.playstation.com", "sku": "playstation" } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_4" } } }, "description": "A lista de DRMs foi recebida com êxito." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter lista de DRMs", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/game/group/{external_id}": { "get": { "description": "Obtém uma lista de jogos do grupo especificado para criar um catálogo.\n\n
Atenção. Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
", "operationId": "get-games-group", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/external-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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": { "$ref": "#/components/examples/client-attribute-game/Catalog_value" }, "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": true, "is_free": false, "is_pre_order": true, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_key_01", "type": "game_key", "virtual_prices": [] }, { "drm_name": "Origin", "drm_sku": "origin", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_2", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_01", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200" } } }, "description": "A lista de jogos foi recebida com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter lista de jogos por grupo especificado", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/game/key/group/{external_id}": { "get": { "description": "Obtém uma lista de chaves de jogo do grupo especificado para criar um catálogo.\n\n
Atenção. Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
", "operationId": "get-game-keys-group", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/external-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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_1", "type": "game_key", "virtual_prices": [] }, { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": false, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_2", "type": "game_key", "virtual_prices": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_3" } } }, "description": "A lista de chaves do jogo foi recebida com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter lista de chaves de jogo por grupo especificado", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/game/key/sku/{item_sku}": { "get": { "description": "Obtém uma chave de jogo para o catálogo.", "operationId": "get-game-key-by-sku", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_1", "type": "game_key", "virtual_prices": [] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_2" } } }, "description": "A chave do jogo foi recebida com sucesso." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_key_1' not found", "statusCode": 404 } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_404_1" } } }, "description": "Chave de jogo não encontrada." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter chave de jogo para catálogo", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/game/sku/{item_sku}": { "get": { "description": "Obtém um jogo para o catálogo.", "operationId": "get-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": { "$ref": "#/components/examples/client-attribute-game/Catalog_value" }, "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": true, "is_free": false, "is_pre_order": true, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_key_01", "type": "game_key", "virtual_prices": [] }, { "drm_name": "Origin", "drm_sku": "origin", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_1" } } }, "description": "Jogo recebido com sucesso." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_404" } } }, "description": "Jogo não encontrado." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter jogo para catálogo", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/groups": { "get": { "description": "Obtém uma lista de grupos de itens para criar um catálogo.", "operationId": "get-item-groups", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "groups": [ { "children": [], "description": "Accessory", "external_id": "accessory", "level": 0, "name": "Accessory", "order": 1 }, { "children": [], "description": "Background", "external_id": "background", "level": 0, "name": "Background", "order": 1 }, { "children": [], "description": "Hair", "external_id": "hair", "level": 0, "name": "Hair", "order": 1 }, { "children": [], "description": "Outfit", "external_id": "outfit", "level": 0, "name": "Outfit", "order": 1 }, { "children": [], "description": "Body", "external_id": "body", "level": 0, "name": "Body", "order": 1 }, { "children": [], "description": "Body", "external_id": "delete_group", "level": 0, "name": "Body", "order": 1 }, { "children": [ { "children": [], "description": "Group description", "external_id": "test_group_secure", "image_url": "http://static.xsolla.com/img/xsolla-logo2.png", "level": 1, "name": "Test group secure", "order": 5, "parent_external_id": "very_cool_group" } ], "description": "Very cool group", "external_id": "very_cool_group", "level": 0, "name": "Very cool group", "order": 1 }, { "children": [ { "children": [], "description": "Group description", "external_id": "test_group_split", "image_url": "http://static.xsolla.com/img/xsolla-logo2.png", "level": 1, "name": "Test group secure", "order": 1, "parent_external_id": "test_group_secure" } ], "description": "Group description", "external_id": "test_group_secure", "image_url": "http://static.xsolla.com/img/xsolla-logo2.png", "level": 0, "name": "Test group secure", "order": 1 } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_9" } } }, "description": "A lista de grupos foi recebida com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter lista de grupos de itens", "tags": [ "virtual items & currency" ] } }, "/v2/project/{project_id}/items/virtual_currency": { "get": { "description": "Obtém uma lista de moedas virtuais para criar um catálogo.\n\n
Atenção. Todos os projetos têm a limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
", "operationId": "get-virtual-currency", "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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "description": "Big Rocket - short description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_currency", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "description": "description", "groups": [ { "external_id": "hair", "name": "Hair" } ], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_currency", "virtual_prices": [] }, { "attributes": [], "description": "description", "groups": [], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider_2", "type": "virtual_currency", "virtual_prices": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_6" } } }, "description": "A lista de moedas virtuais foi recebida com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter lista de moedas virtuais", "tags": [ "virtual items & currency" ] } }, "/v2/project/{project_id}/items/virtual_currency/package": { "get": { "description": "Obtém uma lista de pacotes de moedas virtuais para criar um catálogo.\n\n
Atenção. Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
", "operationId": "get-virtual-currency-package", "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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": "Big Rocket - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "name": "Big Rocket", "quantity": 100, "sku": "big_rocket", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "name": "VC Name first package", "price": { "amount": "2.0000", "amount_without_discount": "2.0000", "currency": "USD" }, "sku": "vc_package_1", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": "description", "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "name": "SHOTGUN FOR TRUE RAIDERS", "quantity": 200, "sku": "shotgun_raider", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "name": "VC Name third package", "price": { "amount": "4.0000", "amount_without_discount": "4.0000", "currency": "USD" }, "sku": "vc_package_3", "type": "bundle", "virtual_prices": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_7" } } }, "description": "A lista de pacotes de moedas virtuais foi recebida com sucesso." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter lista de pacotes de moedas virtuais", "tags": [ "virtual items & currency" ] } }, "/v2/project/{project_id}/items/virtual_items": { "get": { "description": "Obtém uma lista de itens virtuais para criar um catálogo.\n\n
Atenção. Todos os projetos têm a limitação do número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
", "operationId": "get-virtual-items", "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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "description": "description", "groups": [ { "external_id": "hair", "name": "Hair" } ], "image_url": "http://image.png", "inventory_options": [ { "consumable": [ { "usages_count": 1 } ] }, { "expiration_period": [ { "type": "day" }, { "value": 1 } ] } ], "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test_2", "type": "virtual_currency" } ] }, { "attributes": [], "description": "description", "groups": [], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider_2", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_5" } } }, "description": "A lista de itens virtuais foi recebida com êxito." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter lista de itens virtuais", "tags": [ "virtual items & currency" ] } }, "/v2/project/{project_id}/items/virtual_items/group/{external_id}": { "get": { "description": "Obtém uma lista de itens do grupo especificado para criar um catálogo.\n\n
Atenção. Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
", "operationId": "get-virtual-items-group", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/external-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" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "description": "description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test_2", "type": "virtual_currency" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_8" } } }, "description": "A lista de itens do grupo especificado foi recebida com êxito." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Item group not found", "statusCode": 404 } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_404_2" } } }, "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." } }, "security": [ { "AuthForClient": [] } ], "summary": "Obter lista de itens por grupo especificado", "tags": [ "virtual items & currency" ] } } }, "components": { "securitySchemes": { "AuthForClient": { "description": "Use o ponto de extremidade [Create user token](https://developers.xsolla.com\\/pt/api/digital-distribution-hub/operation/create-user-token) para gerar um token.", "scheme": "bearer", "type": "http" }, "basicAuth": { "description": "A Xsolla API usa autenticação de acesso básica. Todas as solicitações à API devem conter o cabeçalho `Authorization: Basic `, onde `your_authorization_basic_key` é o par `distribution_hub_id:api_key` codificado de acordo com o padrão Base64. \n\nEntre em contato com seu Gerente da Conta para obter `distribution_hub_id` e `api_key`.", "scheme": "basic", "type": "http" } }, "parameters": { "project-id-path-param": { "description": "ID do Projeto.", "explode": false, "in": "path", "name": "project_id", "required": true, "schema": { "example": 44056, "type": "integer" }, "style": "simple" }, "currency-query-param": { "description": "A moeda em que os preços são exibidos (USD por padrão). Código de moeda de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "explode": true, "in": "query", "name": "currency", "required": false, "schema": { "default": "USD", "type": "string" }, "style": "form" }, "locale-query-param": { "description": "Idioma de resposta. Código de idioma minúsculo de duas letras de acordo com o padrão ISO 639-1.", "explode": true, "in": "query", "name": "locale", "required": false, "schema": { "default": "en", "type": "string" }, "style": "form" }, "item-sku-path-param": { "description": "SKU do item.", "explode": false, "in": "path", "name": "item_sku", "required": true, "schema": { "example": "booster_mega_1", "type": "string" }, "style": "simple" }, "cart-id-path-param": { "description": "ID do Carrinho.", "explode": false, "in": "path", "name": "cart_id", "required": true, "schema": { "example": "custom_id", "type": "string" }, "style": "simple" }, "order-id-path-param": { "description": "ID do Pedido.", "explode": false, "in": "path", "name": "order_id", "required": true, "schema": { "example": "656", "type": "string" }, "style": "simple" }, "limit-query-param": { "description": "Limite para o número de elementos na página.", "example": 50, "explode": true, "in": "query", "name": "limit", "required": false, "schema": { "example": 50, "type": "integer" }, "style": "form" }, "offset-query-param": { "description": "Número do elemento a partir do qual a lista é gerada (a contagem começa a partir de 0).", "example": 0, "explode": true, "in": "query", "name": "offset", "required": false, "schema": { "example": 0, "type": "integer" }, "style": "form" }, "additional-fields-query-param": { "description": "A lista de campos adicionais. Esses campos estarão na resposta se você enviá-los em sua solicitação. Campos disponíveis `media_list`, `order`, `long_description`.", "explode": true, "in": "query", "name": "additional_fields[]", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, "country-query-param": { "description": "País para calcular preços regionais e restrições de catálogos. Código de país maiúsculo de duas letras de acordo com o padrão [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Se você não especificar o país explicitamente, ele será calculado com base no endereço IP do usuário.", "explode": true, "in": "query", "name": "country", "required": false, "schema": { "default": "US", "type": "string" }, "style": "form" }, "sku-path-param": { "description": "Pacote SKU.", "explode": false, "in": "path", "name": "sku", "required": true, "schema": { "example": "kg_1", "type": "string" }, "style": "simple" }, "external-id-path-param": { "description": "ID externo do grupo.", "explode": false, "in": "path", "name": "external_id", "required": true, "schema": { "default": "all", "type": "string" }, "style": "simple" } }, "schemas": { "Cart_admin-attribute-external_id": { "description": "ID de atributo exclusivo. O `external_id` pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "Cart_value-external_id": { "description": "ID de valor exclusivo para um atributo. O `external_id` pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "Cart_clientattributes_inner": { "properties": { "external_id": { "$ref": "#/components/schemas/Cart_admin-attribute-external_id" }, "name": { "description": "Nome do atributo.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/Cart_value-external_id" }, "value": { "description": "Valor do atributo.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "Cart_client-attributes": { "default": [], "description": "Lista de atributos e seus valores correspondentes ao item. Pode ser usado para filtrar 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" } ] } }, "items": { "$ref": "#/components/schemas/Cart_clientattributes_inner" }, "type": "array" }, "Cart_inline_response_200_groups": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "Cart_inline_response_200_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart_client-attributes" }, "description": { "type": "string" }, "groups": { "items": { "$ref": "#/components/schemas/Cart_inline_response_200_groups" }, "type": "array" }, "image_url": { "type": "string" }, "is_free": { "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "Cart_inline_response_200_price": { "description": "Preço do carrinho.", "example": "{\"amount\":\"6150.0000000000000000\",\"amount_without_discount\":\"6150.0000000000000000\",\"currency\":\"USD\"}", "nullable": true, "properties": { "amount": { "default": "50.0000000000000000", "type": "string" }, "amount_without_discount": { "default": "100.0000000000000000", "type": "string" }, "currency": { "default": "USD", "type": "string" } }, "type": "object" }, "Cart_inline_response_200": { "properties": { "cart_id": { "description": "ID do Carrinho.", "example": "cart_id", "type": "string" }, "is_free": { "description": "Se `true`, o carrinho está livre.", "type": "boolean" }, "items": { "example": [ { "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", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Cart_inline_response_200_items" }, "type": "array" }, "price": { "$ref": "#/components/schemas/Cart_inline_response_200_price" } }, "type": "object" }, "Cart-Payment_settings_currency": { "description": "Moeda de pagamento preferida. Código de moeda de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "type": "string" }, "Cart_inline_response_200_1_warnings": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" } }, "type": "object" }, "Cart_inline_response_200_1": { "properties": { "cart_id": { "description": "ID do Carrinho.", "example": "cart_id", "type": "string" }, "is_free": { "description": "Se `true`, o carrinho está livre.", "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/Cart_inline_response_200_items" }, "type": "array" }, "price": { "$ref": "#/components/schemas/Cart_inline_response_200_price" }, "warnings": { "example": [ { "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", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Cart_inline_response_200_1_warnings" }, "type": "array" } }, "type": "object" }, "Cart_inline_response_404": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with Project ID = 44056 and SKU = booster_mega_12222 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" }, "Cart_inline_response_422_1": { "properties": { "errorCode": { "example": 1421, "type": "integer" }, "errorMessage": { "example": "This type of item cannot be put to the cart. Select another type of item.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" }, "Cart_inline_response_422": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "Item quantity must be non-negative integer.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" }, "Order_inline_response_200_1_content_price_1": { "description": "Preço do item.", "properties": { "amount": { "description": "Preço do item com desconto.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "Preço do item.", "example": "30", "type": "string" }, "currency": { "description": "Moeda de compra padrão. Código de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "Order_inline_response_200_1_content_items": { "properties": { "is_free": { "description": "Se `true`, o item é gratuito.", "example": "false", "type": "string" }, "price": { "$ref": "#/components/schemas/Order_inline_response_200_1_content_price_1" }, "quantity": { "description": "Quantidade do item.", "example": 1, "type": "integer" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "some_sku", "type": "string" } }, "type": "object" }, "Order_inline_response_200_1_content_price": { "description": "Preço do pedido.", "properties": { "amount": { "description": "Preço do pedido com desconto.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "Preço do pedido.", "example": "30", "type": "string" }, "currency": { "description": "Moeda de compra padrão. Código de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "Order_inline_response_200_1_content_virtual_price": { "description": "Preço do pedido em moedas virtuais.", "properties": { "amount": { "description": "Preço do pedido com desconto.", "example": "100", "type": "string" }, "amount_without_discount": { "description": "Preço do pedido.", "example": "150", "type": "string" }, "currency": { "description": "SKU da moeda virtual usada no pedido.", "example": "test_vc", "type": "string" } }, "type": "object" }, "Order_inline_response_200_1_content": { "description": "Detalhes do pedido.", "properties": { "is_free": { "description": "Se `true`, o pedido é gratuito.", "example": "false", "type": "string" }, "items": { "description": "Lista de itens.", "example": [ { "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "quantity": 1, "sku": "some_sku" } ], "items": { "$ref": "#/components/schemas/Order_inline_response_200_1_content_items" }, "type": "array" }, "price": { "$ref": "#/components/schemas/Order_inline_response_200_1_content_price" }, "virtual_price": { "$ref": "#/components/schemas/Order_inline_response_200_1_content_virtual_price" } }, "type": "object" }, "Order_inline_response_200_1": { "properties": { "content": { "$ref": "#/components/schemas/Order_inline_response_200_1_content" }, "order_id": { "description": "ID do Pedido.", "example": 1, "type": "integer" }, "status": { "description": "Status do pedido: `new`/`paid`/`done`/`canceled`.", "example": "paid", "type": "string" } }, "type": "object" }, "Order_inline_response_404": { "properties": { "errorCode": { "example": 9001, "type": "integer" }, "errorMessage": { "example": "[0401-9001]: Order not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" }, "Order_inline_response_200_billing_info_direct_tax": { "properties": { "amount": { "example": 150, "type": "number" }, "name": { "example": "TAX", "type": "string" }, "rate": { "example": 10, "type": "number" } }, "type": "object" }, "Order_inline_response_200_billing_info_indirect_tax": { "properties": { "amount": { "example": 246.75, "type": "number" }, "name": { "example": "VAT", "type": "string" }, "rate": { "example": 20, "type": "number" } }, "type": "object" }, "Order_inline_response_200_billing_info_price": { "properties": { "amount": { "example": 1480.45, "type": "number" }, "currency": { "description": "Moeda de compra. Código de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" } }, "type": "object" }, "Order_inline_response_200_billing_info": { "description": "Informações de faturamento.", "properties": { "direct_tax": { "items": { "$ref": "#/components/schemas/Order_inline_response_200_billing_info_direct_tax" }, "type": "array" }, "indirect_tax": { "items": { "$ref": "#/components/schemas/Order_inline_response_200_billing_info_indirect_tax" }, "type": "array" }, "price": { "$ref": "#/components/schemas/Order_inline_response_200_billing_info_price" } }, "type": "object" }, "Order_inline_response_200": { "properties": { "billing_info": { "$ref": "#/components/schemas/Order_inline_response_200_billing_info" }, "order_id": { "description": "ID do Pedido.", "type": "integer" } }, "type": "object" }, "Order_inline_response_422": { "properties": { "errorCode": { "example": 1401, "type": "integer" }, "errorMessage": { "example": "[0401-1401]: Invalid cart", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" }, "Order_inline_response_422_1": { "properties": { "errorCode": { "example": 1411, "type": "integer" }, "errorMessage": { "example": "[0401-1411]: Invalid item", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" }, "email-required": { "properties": { "country": { "description": "Código de país maiúsculo 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": "US", "nullable": true, "type": "string" }, "email": { "description": "O endereço de e-mail do usuário onde ele pode receber a chave do jogo comprada.", "example": "public_email@test.com", "type": "string" }, "id": { "description": "Identificador de usuário exclusivo no jogo.", "example": "public_id", "nullable": true, "type": "string" }, "ip": { "description": "O endereço IP do usuário.", "example": "127.0.0.1", "nullable": true, "type": "string" }, "name": { "description": "O nome público do usuário.", "example": "Public name", "nullable": true, "type": "string" }, "phone": { "description": "O número de telefone do usuário.", "example": "+66-000-000-00-00", "nullable": true, "type": "string" } }, "required": [ "email" ] }, "Common_inline_response_200_1": { "properties": { "token": { "description": "Token do usuário.", "type": "string" } }, "type": "object" }, "Catalog_admin-attribute-external_id": { "description": "ID de atributo exclusivo. O `external_id` pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "Catalog_value-external_id": { "description": "ID de valor exclusivo para um atributo. O `external_id` pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "Catalog_clientattributes_inner": { "properties": { "external_id": { "$ref": "#/components/schemas/Catalog_admin-attribute-external_id" }, "name": { "description": "Nome do atributo.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/Catalog_value-external_id" }, "value": { "description": "Valor do atributo.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "Catalog_client-attributes-common": { "default": [], "description": "Lista de atributos e seus valores correspondentes ao item. Pode ser usado para filtrar catálogos.", "items": { "$ref": "#/components/schemas/Catalog_clientattributes_inner" }, "type": "array" }, "Catalog_bundle_type": { "description": "Tipo de pacote. Neste caso, é sempre `standart`.", "example": "standart", "type": "string" }, "Catalog_client_content_inner": { "description": "Item em um pacote.", "properties": { "description": { "description": "Descrição do item.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "URL da imagem.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "name": { "description": "Nome do item.", "example": "Big Rocket", "type": "string" }, "price": { "description": "Preços dos itens.", "nullable": true, "properties": { "amount": { "description": "Preço do item com desconto.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Preço do item.", "example": "100.99", "type": "string" }, "currency": { "description": "Moeda de compra padrão. Código de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "quantity": { "description": "Quantidade de item em um pacote.", "example": 250, "type": "integer" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, traços e sublinhados.", "example": "big_rocket", "type": "string" }, "type": { "description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" }, "virtual_prices": { "description": "Preços virtuais.", "items": { "description": "Preço virtual.", "properties": { "amount": { "description": "Preço do item em moeda virtual com desconto.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Preço do item.", "example": 200, "type": "integer" }, "description": { "description": "Descrição da moeda virtual.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Imagem da moeda virtual.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Se o preço é padrão para um item.", "example": true, "type": "boolean" }, "name": { "description": "Nome da moeda virtual.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "SKU do item de moeda virtual.", "example": "vc_test", "type": "string" }, "type": { "description": "Tipo de moeda virtual.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "Catalog_client_content": { "description": "Conteúdo do conjunto de pacotes.", "example": [ { "attributes": [], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "name": "Big Rocket", "price": { "amount": 10.99, "amount_without_discount": 10.99, "currency": "USD" }, "quantity": 100, "sku": "big_rocket", "type": "virtual_currency" } ], "items": { "$ref": "#/components/schemas/Catalog_client_content_inner" }, "type": "array" }, "Catalog_client_description": { "description": "Descrição do item.", "example": "Big Rocket - description.", "nullable": true, "type": "string" }, "Catalog_groups_response_inner": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "Catalog_groups_response": { "default": [], "description": "Grupos aos quais o item pertence.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "$ref": "#/components/schemas/Catalog_groups_response_inner" }, "type": "array" }, "Catalog_image_url": { "description": "URL da imagem.", "example": "https://image.example.com", "nullable": true, "type": "string" }, "Catalog_is_free": { "default": "false", "description": "Sempre `false`.", "example": "false", "type": "string" }, "Catalog_client_name": { "description": "Nome do item.", "example": "Big Rocket", "type": "string" }, "Catalog_amount": { "description": "Preço do item com desconto.", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Catalog_amount_without_discount": { "description": "Preço do item.", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Catalog_currency": { "description": "Moeda de compra. Código de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" }, "Catalog_price": { "description": "Preço do item.", "nullable": true, "properties": { "amount": { "$ref": "#/components/schemas/Catalog_amount" }, "amount_without_discount": { "$ref": "#/components/schemas/Catalog_amount_without_discount" }, "currency": { "$ref": "#/components/schemas/Catalog_currency" } }, "required": [ "amount", "amount_without_discount", "currency" ], "type": "object" }, "Catalog_sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "bundle_1", "type": "string" }, "Catalog_total_content_price": { "description": "Soma dos preços do conteúdo do conjunto.", "nullable": true, "properties": { "amount": { "description": "Soma dos preços do conteúdo do conjunto com um desconto.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Soma dos preços do conteúdo do conjunto.", "example": "100.99", "type": "string" }, "currency": { "$ref": "#/components/schemas/Catalog_currency" } }, "type": "object" }, "Catalog_type": { "description": "Tipo de item.", "example": "bundle", "type": "string" }, "Catalog_virtual_prices_inner": { "description": "Preço virtual.", "properties": { "amount": { "description": "Preço do item em moeda virtual com desconto.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Preço do item em moedas virtuais.", "example": 200, "type": "integer" }, "description": { "description": "Descrição da moeda virtual.", "example": "Most popular gold", "nullable": true, "type": "string" }, "image_url": { "description": "Imagem da moeda virtual.", "example": "http://image.png", "nullable": true, "type": "string" }, "is_default": { "description": "Se o preço é padrão para um item.", "example": true, "type": "boolean" }, "name": { "description": "Nome da moeda virtual.", "example": "Gold", "type": "string" }, "sku": { "description": "SKU do item de moeda virtual.", "example": "gold", "type": "string" }, "type": { "description": "Tipo de moeda virtual.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "Catalog_virtual_prices": { "description": "Preços virtuais.", "items": { "$ref": "#/components/schemas/Catalog_virtual_prices_inner" }, "type": "array" }, "Catalog_client_bundle": { "description": "O conjunto especificado.", "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes-common" }, "bundle_type": { "$ref": "#/components/schemas/Catalog_bundle_type" }, "content": { "$ref": "#/components/schemas/Catalog_client_content" }, "description": { "$ref": "#/components/schemas/Catalog_client_description" }, "groups": { "$ref": "#/components/schemas/Catalog_groups_response" }, "image_url": { "$ref": "#/components/schemas/Catalog_image_url" }, "is_free": { "$ref": "#/components/schemas/Catalog_is_free" }, "name": { "$ref": "#/components/schemas/Catalog_client_name" }, "price": { "$ref": "#/components/schemas/Catalog_price" }, "sku": { "$ref": "#/components/schemas/Catalog_sku" }, "total_content_price": { "$ref": "#/components/schemas/Catalog_total_content_price" }, "type": { "$ref": "#/components/schemas/Catalog_type" }, "virtual_prices": { "$ref": "#/components/schemas/Catalog_virtual_prices" } }, "type": "object" }, "Catalog_inline_response_200_10": { "description": "Objeto com itens.", "properties": { "items": { "items": { "$ref": "#/components/schemas/Catalog_client_bundle" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_groups": { "properties": { "external_id": { "example": "accessory", "type": "string" }, "name": { "example": "Accessory", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_price": { "description": "Preços dos itens.", "properties": { "amount": { "description": "Preço do item com desconto.", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "Preço do item.", "example": "2.9900", "type": "string" }, "currency": { "description": "Moeda de compra padrão. Código de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_virtual_prices": { "description": "Preço virtual.", "properties": { "amount": { "description": "Preço do item com desconto em moedas virtuais.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Preço do item.", "example": 200, "type": "integer" }, "description": { "description": "Descrição da moeda virtual.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Imagem da moeda virtual.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Se o preço é padrão para o item ou não.", "example": true, "type": "boolean" }, "name": { "description": "Nome da moeda virtual.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "SKU do item de moeda virtual.", "example": "vc_test", "type": "string" }, "type": { "description": "Tipo de moeda virtual.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_unit_items": { "properties": { "drm_name": { "description": "Nome do DRM.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "ID de DRM exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "steam", "type": "string" }, "has_keys": { "description": "Se `true`, a chave de jogo tem chaves para venda.", "example": false, "type": "boolean" }, "is_free": { "description": "Se `true`, o item é gratuito.", "example": false, "type": "boolean" }, "is_pre_order": { "description": "Se `true`, a chave de jogo é do tipo pré-venda e a data de lançamento não foi passada.", "example": true, "type": "boolean" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_price" }, "release_date": { "description": "Data de lançamento da chave de jogo no formato ISO 8601.", "example": "2020-08-11T10:00:00+03:00", "type": "string" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "game_01", "type": "string" }, "type": { "description": "Tipo de item: `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "Preços virtuais.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes-common" }, "description": { "description": "Descrição do item.", "example": "Game description", "type": "string" }, "groups": { "description": "Grupos aos quais o item pertence.", "example": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla game" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL da imagem.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "Nome do item.", "example": "Game name", "type": "string" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "game_01", "type": "string" }, "type": { "description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`.", "example": "unit", "type": "string" }, "unit_items": { "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_unit_items" }, "type": "array" }, "unit_type": { "description": "Tipo de unidade: `game`.", "example": "game", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200": { "description": "Objeto com jogos.", "properties": { "items": { "example": [ { "attributes": { "$ref": "#/components/examples/client-attribute-game/Catalog_value" }, "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": true, "is_free": false, "is_pre_order": true, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_key_01", "type": "game_key", "virtual_prices": [] }, { "drm_name": "Origin", "drm_sku": "origin", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_2", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_01", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_4_drm": { "properties": { "drm_id": { "description": "ID do DRM.", "example": 1, "type": "number" }, "image": { "description": "URL da imagem.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "link": { "description": "Link de resgate.", "example": "https://support.us.playstation.com", "type": "string" }, "name": { "description": "Nome do DRM.", "example": "Steam", "type": "string" }, "redeem_instruction_link": { "description": "Link de instrução de resgate.", "example": "https://support.us.playstation.com", "type": "string" }, "sku": { "description": "ID de DRM exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "steam", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_4": { "description": "Objeto com jogos.", "properties": { "drm": { "example": [ { "drm_id": 1, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "name": "Steam", "redeem_instruction_link": "https://support.steampowered.com", "sku": "steam" }, { "drm_id": 2, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Playstation", "redeem_instruction_link": "https://support.us.playstation.com", "sku": "playstation" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_4_drm" }, "type": "array" } }, "type": "object" }, "Catalog_client-attributes": { "default": [], "description": "Lista de atributos e seus valores correspondentes ao Jogo.\n\n
Atenção. Essa parte da resposta estará disponível somente se você enviar o parâmetro de consulta `additional_fields[]=attributes`.
", "items": { "$ref": "#/components/schemas/Catalog_clientattributes_inner" }, "type": "array" }, "Catalog_inline_response_200_3_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "description": { "description": "Descrição do item.", "example": "Game description", "type": "string" }, "drm_name": { "description": "Nome do DRM.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "ID de DRM exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "steam", "type": "string" }, "groups": { "description": "Grupos aos quais o item pertence.", "example": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla game" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "has_keys": { "description": "Se `true`, a chave de jogo tem chaves para venda.", "example": false, "type": "boolean" }, "image_url": { "description": "URL da imagem.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "description": "Se `true`, o item é gratuito.", "example": false, "type": "boolean" }, "is_pre_order": { "description": "Se `true`, a chave de jogo é do tipo pré-venda e a data de lançamento não foi passada.", "example": true, "type": "boolean" }, "name": { "description": "Nome do item.", "example": "Game name", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_price" }, "release_date": { "description": "Data de lançamento da chave de jogo no formato ISO 8601.", "example": "2020-08-11T10:00:00+03:00", "type": "string" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "game_01", "type": "string" }, "type": { "description": "Tipo de item: `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "Preços virtuais.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_3": { "description": "Objeto com jogos.", "properties": { "items": { "example": [ { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_1", "type": "game_key", "virtual_prices": [] }, { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": false, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_2", "type": "game_key", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_3_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_2": { "description": "Objeto com informações de chave de jogo.", "example": { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_1", "type": "game_key", "virtual_prices": [] }, "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes-common" }, "description": { "description": "Descrição do item.", "example": "Game description", "type": "string" }, "drm_name": { "description": "Nome do DRM.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "ID de DRM exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "steam", "type": "string" }, "groups": { "description": "Grupos aos quais o item pertence.", "example": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla game" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "has_keys": { "description": "Se `true`, a chave de jogo tem chaves para venda.", "example": false, "type": "boolean" }, "image_url": { "description": "URL da imagem.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "description": "Se `true`, o item é gratuito.", "example": false, "type": "boolean" }, "is_pre_order": { "description": "Se `true`, a chave de jogo é do tipo pré-venda e a data de lançamento não foi passada.", "example": true, "type": "boolean" }, "name": { "description": "Nome do item.", "example": "Game name", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_price" }, "release_date": { "description": "Data de lançamento da chave de jogo no formato ISO 8601.", "example": "2020-08-11T10:00:00+03:00", "type": "string" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "game_01", "type": "string" }, "type": { "description": "Tipo de item: `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "Preços virtuais.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_404_1": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_key_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" }, "Catalog_inline_response_200_1": { "description": "Objeto com informações do jogo.", "example": { "attributes": { "$ref": "#/components/examples/client-attribute-game/Catalog_value" }, "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": true, "is_free": false, "is_pre_order": true, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_key_01", "type": "game_key", "virtual_prices": [] }, { "drm_name": "Origin", "drm_sku": "origin", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "description": { "description": "Descrição do item.", "example": "Game description", "type": "string" }, "groups": { "description": "Grupos aos quais o item pertence.", "example": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla game" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL da imagem.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "Nome do item.", "example": "Game name", "type": "string" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "game_01", "type": "string" }, "type": { "description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`.", "example": "unit", "type": "string" }, "unit_items": { "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_unit_items" }, "type": "array" }, "unit_type": { "description": "Tipo de unidade: `game`.", "example": "game", "type": "string" } }, "type": "object" }, "Catalog_inline_response_404": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" }, "Catalog_inline_response_200_9_children": { "properties": { "children": { "description": "Grupos filhos.", "example": [], "items": { "type": "string" }, "type": "array" }, "description": { "description": "Descrição do grupo.", "example": "Accessory", "type": "string" }, "external_id": { "description": "ID do grupo externo.", "example": "accessory", "type": "string" }, "image_url": { "description": "URL da imagem.", "type": "string" }, "level": { "description": "Nível de aninhamento do grupo.", "example": 2, "type": "integer" }, "name": { "description": "Nome do grupo.", "example": "Accessory", "type": "string" }, "order": { "description": "Define a ordem do arranjo.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "ID do grupo externo pai.", "example": "background", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_9_children_1": { "properties": { "children": { "description": "Grupos filhos.", "example": [ { "children": [], "description": "Accessory", "external_id": "accessory", "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_9_children" }, "type": "array" }, "description": { "description": "Descrição do grupo.", "example": "Background description", "type": "string" }, "external_id": { "description": "ID do grupo externo.", "example": "background", "type": "string" }, "image_url": { "description": "URL da imagem do grupo.", "type": "string" }, "level": { "description": "Nível de aninhamento do grupo.", "example": 1, "type": "integer" }, "name": { "description": "Nome do grupo.", "example": "Background", "type": "string" }, "order": { "description": "Define a ordem do arranjo.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "ID do grupo externo pai.", "example": "hair", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_9_groups": { "properties": { "children": { "description": "Grupos filhos.", "example": [ { "children": [ { "children": [], "description": "Accessory", "external_id": "accessory", "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "description": "Background description", "external_id": "background", "level": 1, "name": "Background", "order": 1, "parent_external_id": "hair" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_9_children_1" }, "type": "array" }, "description": { "description": "Descrição do grupo.", "example": "Hair description", "type": "string" }, "external_id": { "description": "ID do grupo externo.", "example": "hair", "type": "string" }, "image_url": { "description": "URL da imagem.", "type": "string" }, "level": { "description": "Nível de aninhamento do grupo.", "example": 0, "type": "integer" }, "name": { "description": "Nome do grupo.", "example": "Hair", "type": "string" }, "order": { "description": "Define a ordem do arranjo.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "ID do grupo externo pai.", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_9": { "properties": { "groups": { "example": [ { "children": [ { "children": [ { "children": [], "description": "Accessory", "external_id": "accessory", "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "description": "Background description", "external_id": "background", "level": 1, "name": "Background", "order": 1, "parent_external_id": "hair" } ], "description": "Hair description", "external_id": "hair", "level": 0, "name": "Hair", "order": 1 }, { "children": [], "description": "Super description", "external_id": "group_external_id", "level": 0, "name": "Super", "order": 1 } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_9_groups" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_5_inventory_options_consumable": { "description": "Define as propriedades consumíveis se este for um item consumível ou `null` se este for um item não consumível.", "nullable": true, "properties": { "usages_count": { "description": "Número total de utilizações restantes se este for um item consumível ou `null` se este for um item não consumível.", "example": 1, "nullable": true, "type": "integer" } }, "type": "object" }, "Catalog_inline_response_200_5_inventory_options_expiration_period": { "description": "Define as propriedades de expiração se este for um item expirado ou `null` se este for um item não expirado.", "nullable": true, "properties": { "type": { "description": "Define o tipo de validade do item.", "enum": [ "minute", "hour", "day", "week", "month", "year" ], "example": "day", "type": "string" }, "value": { "description": "Define o valor para um período de validade.", "example": 1, "type": "integer" } }, "type": "object" }, "Catalog_inline_response_200_5_inventory_options": { "description": "Define as opções de item de inventário.", "properties": { "consumable": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_consumable" }, "expiration_period": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_expiration_period" } }, "type": "object" }, "Catalog_inline_response_200_5_price": { "description": "Preços dos itens.", "properties": { "amount": { "description": "Preço do item com desconto.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Preço do item.", "example": "100.99", "type": "string" }, "currency": { "description": "Moeda de compra padrão. Código de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_6_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "description": { "description": "Descrição do item.", "example": "Big Rocket - description", "type": "string" }, "groups": { "description": "Grupos aos quais o item pertence.", "example": [ { "external_id": "accessory", "name": "Accessory" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL da imagem.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "inventory_options": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options" }, "is_free": { "description": "Se `true`, o item é gratuito.", "example": "false", "type": "string" }, "name": { "description": "Nome do item.", "example": "Big Rocket", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_price" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "big_rocket", "type": "string" }, "type": { "description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" }, "virtual_prices": { "description": "Preços virtuais.", "example": [ { "amount": 100, "amount_without_discount": 100, "image_url": "http://image.png", "is_default": true, "sku": "shotgun_raider" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_6": { "properties": { "items": { "example": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] } ], "description": "Big Rocket - short description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_currency", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "1" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "value": "3.9" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "value": "Strategy" }, { "value": "Tactical" }, "Turn-based" ] } ], "description": "description", "groups": [ { "external_id": "hair", "name": "Hair" } ], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_currency", "virtual_prices": [] }, { "attributes": [], "description": "description", "groups": [], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider_2", "type": "virtual_currency", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_6_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_7_inventory_options_expiration_period": { "description": "Define as propriedades de expiração se este for um item expirado ou `null` se este for um item não expirado.", "nullable": true, "properties": { "type": { "description": "Define o tipo de validade de um item.", "enum": [ "minute", "hour", "day", "week", "month", "year" ], "example": "day", "type": "string" }, "value": { "description": "Define o valor para o período de validade.", "example": 1, "type": "integer" } }, "type": "object" }, "Catalog_inline_response_200_7_inventory_options": { "description": "Define as opções de item de inventário.", "properties": { "consumable": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_consumable" }, "expiration_period": { "$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options_expiration_period" } }, "type": "object" }, "Catalog_inline_response_200_7_content": { "description": "Moeda virtual em um pacote.", "properties": { "description": { "description": "Descrição do item.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "URL da imagem.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "inventory_options": { "$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options" }, "name": { "description": "Nome do item.", "example": "Big Rocket", "type": "string" }, "quantity": { "description": "Quantia de moedas virtuais em um pacote.", "example": 250, "type": "integer" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, traços e sublinhados.", "example": "big_rocket", "type": "string" }, "type": { "description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_7_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "bundle_type": { "description": "Tipo de conjunto: `standard`/`virtual_currency_package`.", "example": "virtual_currency_package", "type": "string" }, "content": { "description": "Conteúdo do pacote de moedas virtuais.", "example": [ { "description": "Big Rocket - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "name": "Big Rocket", "quantity": 100, "sku": "big_rocket", "type": "virtual_currency" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_7_content" }, "type": "array" }, "description": { "description": "Descrição do item.", "example": "Big Rocket - description", "type": "string" }, "groups": { "description": "Grupos aos quais o item pertence.", "example": [ { "external_id": "accessory", "name": "Accessory" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL da imagem.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "description": "Se `true`, o item é gratuito.", "example": "false", "type": "string" }, "name": { "description": "Nome do item.", "example": "Big Rocket", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_price" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "big_rocket", "type": "string" }, "type": { "description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`.", "example": "bundle", "type": "string" }, "virtual_prices": { "description": "Preços virtuais.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_7": { "description": "Objeto com itens.", "properties": { "items": { "example": [ { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": "Big Rocket - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "name": "Big Rocket", "quantity": 100, "sku": "big_rocket", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "name": "VC Name first package", "price": { "amount": "2.0000", "amount_without_discount": "2.0000", "currency": "USD" }, "sku": "vc_package_1", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": "description", "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "name": "SHOTGUN FOR TRUE RAIDERS", "quantity": 200, "sku": "shotgun_raider", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "name": "VC Name third package", "price": { "amount": "4.0000", "amount_without_discount": "4.0000", "currency": "USD" }, "sku": "vc_package_3", "type": "bundle", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_7_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_5_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "description": { "description": "Descrição do item.", "example": "Big Rocket - description", "type": "string" }, "groups": { "description": "Grupos aos quais o item pertence.", "example": [ { "external_id": "accessory", "name": "Accessory" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL da imagem.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "inventory_options": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options" }, "is_free": { "description": "Se `true`, o item é gratuito.", "example": false, "type": "boolean" }, "name": { "description": "Nome do item.", "example": "Big Rocket", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_price" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "big_rocket", "type": "string" }, "type": { "description": "Tipo de item: `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Tipo de item virtual.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "Preços virtuais.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_5": { "description": "Objeto com itens virtuais.", "properties": { "items": { "example": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "description": "description", "groups": [ { "external_id": "hair", "name": "Hair" } ], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test_2", "type": "virtual_currency" } ] }, { "attributes": [], "description": "description", "groups": [], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider_2", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_8_virtual_prices": { "description": "Preço virtual.", "properties": { "amount": { "description": "Preço do item com desconto em moedas virtuais.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Preço do item.", "example": 200, "type": "integer" }, "description": { "description": "Descrição da moeda virtual.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "example": "http://image.png", "type": "string" }, "is_default": { "description": "Se o preço é padrão para um item ou não.", "example": true, "type": "boolean" }, "name": { "description": "Nome da moeda virtual.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "SKU do item de moeda virtual.", "example": "vc_test", "type": "string" }, "type": { "description": "Tipo de moeda virtual.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_8_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "description": { "description": "Descrição do item.", "example": "Big Rocket - description", "type": "string" }, "groups": { "description": "Grupos aos quais o item pertence.", "example": [ { "external_id": "accessory", "name": "Accessory" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL da imagem.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "inventory_options": { "$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options" }, "is_free": { "description": "Se `true`, o item é gratuito.", "example": "false", "type": "string" }, "name": { "description": "Nome do item.", "example": "Big Rocket", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_price" }, "sku": { "description": "ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.", "example": "big_rocket", "type": "string" }, "type": { "description": "Tipo de item: `consumable`/`expiration`/`permanent`/`lootboxes`/`physical`.", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Tipo de item virtual.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non_consumable", "type": "string" }, "virtual_prices": { "description": "Preços virtuais.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_8_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_8": { "properties": { "items": { "example": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] } ], "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" } ] }, { "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" ] } ], "description": "description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test_2", "type": "virtual_currency" } ] } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_8_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_404_2": { "properties": { "errorCode": { "example": 4403, "type": "integer" }, "errorMessage": { "example": "[0401-4403]: Item group not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } }, "requestBodies": { "fill-cart-json-model": { "content": { "application/json": { "schema": { "example": [ { "quantity": 123, "sku": "booster_mega_1" } ], "properties": { "currency": { "$ref": "#/components/schemas/Cart-Payment_settings_currency" }, "items": { "description": "Lista de itens.", "items": { "minItems": 1, "properties": { "quantity": { "default": 123, "type": "number" }, "sku": { "default": "booster_mega_1", "type": "string" } }, "required": [ "quantity", "sku" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object" } } } }, "put-item-by-cart-id-json-model": { "content": { "application/json": { "schema": { "properties": { "currency": { "$ref": "#/components/schemas/Cart-Payment_settings_currency" }, "quantity": { "default": 123, "description": "Quantidade do item.", "type": "number" } }, "type": "object" } } } }, "create-order-model": { "content": { "application/json": { "schema": { "example": { "geotype": 13038 }, "properties": { "currency": { "$ref": "#/components/schemas/Cart-Payment_settings_currency" }, "geotype": { "description": "ID do parceiro distribuidor do lado da Xsolla.", "type": "number" }, "quantity": { "description": "Quantidade do item.", "example": 1, "type": "integer" } }, "required": [ "geotype", "currency" ], "type": "object" } } }, "description": "Objeto com dados de criação de pedidos.", "required": true }, "post-user-token-json-model": { "content": { "application/json": { "schema": { "properties": { "user": { "$ref": "#/components/schemas/email-required", "description": "Detalhes do usuário.", "type": "object" } }, "required": [ "user" ], "type": "object" } } } } }, "examples": { "200-get-bundle-list": { "value": { "items": [ { "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" } ] }, "bundle_type": "standard", "content": [ { "attributes": { "external_id": "size", "name": "Size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Large" } ] }, "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "name": "Big Rocket", "price": { "amount": 10.99, "amount_without_discount": 10.99, "currency": "USD" }, "quantity": 100, "sku": "big_rocket", "type": "virtual_currency", "virtual_item_type": "non_consumable", "virtual_prices": [] } ], "description": "pricePoint_44056_1", "groups": [], "is_free": false, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "price": { "amount": 9.99, "amount_without_discount": 9.99, "currency": "USD" }, "sku": "kg_1", "total_content_price": { "amount": 10.99, "amount_without_discount": 10.99, "currency": "USD" }, "type": "bundle", "virtual_prices": [] } ] } }, "200-get-bundle": { "value": { "attributes": [], "bundle_type": "standard", "content": [ { "attributes": [], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "name": "Big Rocket", "price": { "amount": 10.99, "amount_without_discount": 10.99, "currency": "USD" }, "quantity": 100, "sku": "big_rocket", "type": "virtual_currency", "virtual_prices": [] } ], "description": "pricePoint_44056_1.", "groups": [], "is_free": false, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "price": { "amount": 9.99, "amount_without_discount": 9.99, "currency": "USD" }, "sku": "kg_1", "total_content_amount": { "amount": 10.99, "amount_without_discount": 10.99, "currency": "USD" }, "type": "bundle", "virtual_prices": [] } } } }, "x-tagGroups": [ { "name": "Carrinho", "tags": [ "cart" ] }, { "name": "Catálogo", "tags": [ "game keys", "virtual items & currency", "bundles" ] }, { "name": "Comum", "tags": [ "user token" ] }, { "name": "Notificações", "tags": [ "notifications" ] }, { "name": "Pedido", "tags": [ "order" ] } ] }