{"items":[{"type":"link","label":"Genius Returns - API reference","link":"/openapi","routeSlug":"/openapi"},{"type":"separator","label":"Endpoints"},{"type":"group","label":"Segurança","link":"/openapi/seguranca","routeSlug":"/openapi/seguranca","items":[{"label":"Autenticar","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/seguranca/autenticar","routeSlug":"/openapi/seguranca/autenticar","metadata":{"seo":{"title":"Autenticar","description":"Autentica a integração usando cabeçalhos GeniusKey e GeniusToken e retorna um JWT. O token deve ser enviado nos endpoints protegidos usando o header Authorization: Bearer {token}."}},"httpPath":"/v1/pvt/seguranca/autenticar"}]},{"type":"group","label":"Configuração","link":"/openapi/configuracao","routeSlug":"/openapi/configuracao","items":[{"label":"Obtém o conector de e-commerce da conta","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuracao/obterconectorecommerce","routeSlug":"/openapi/configuracao/obterconectorecommerce","metadata":{"seo":{"title":"Obtém o conector de e-commerce da conta","description":"Retorna o conector de e-commerce configurado para a conta autenticada, ou seja,a ligação entre a Genius Returns e a plataforma de loja (VTEX, Shopify, AnyMarket,Magento etc.)."}},"httpPath":"/v2/pvt/ecommerce/obter-conector"}]},{"type":"group","label":"Processos","link":"/openapi/processos","routeSlug":"/openapi/processos","items":[{"label":"Obtém um processo por ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/processos/getprocessobyid","routeSlug":"/openapi/processos/getprocessobyid","metadata":{"seo":{"title":"Obtém um processo por ID","description":"Obtém um processo por ID"}},"httpPath":"/v3/pvt/processo/{id-processo}"},{"label":"Listar processos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/processos/listarprocessos","routeSlug":"/openapi/processos/listarprocessos","metadata":{"seo":{"title":"Listar processos","description":"Retorna uma lista paginada de processos conforme filtros informados. Observação: os filtros também podem ser enviados no corpo (JSON), conforme exemplo de curl, caso seu cliente HTTP suporte body em requisições GET."}},"httpPath":"/v3/pvt/processo"},{"label":"Integração do pedido ao fluxo de devolução","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/processos/integrateflow","routeSlug":"/openapi/processos/integrateflow","metadata":{"seo":{"title":"Integração do pedido ao fluxo de devolução","description":"Endpoint utilizado para integrar um pedido da loja virtual à plataforma Genius Returns. Um link será disponibilizado pela API e poderá ser utilizado para redirecionar o usuário solicitante à interface Genius Returns de solicitação de troca ou devolução, diretamente ao estágio de seleção itens."}},"httpPath":"/v3/pvt/processo/integrar/fluxo"},{"label":"Importa uma solicitação de troca ou devolução","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/processos/processos_enviarsolicitacao","routeSlug":"/openapi/processos/processos_enviarsolicitacao","metadata":{"seo":{"title":"Importa uma solicitação de troca ou devolução","description":"Importa uma solicitação de troca ou devolução"}},"httpPath":"/v1/pvt/processo/enviar-solicitacao"},{"label":"Avalia se um pedido pode abrir uma solicitação de troca ou devolução","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/processos/avaliarregraspedido","routeSlug":"/openapi/processos/avaliarregraspedido","metadata":{"seo":{"title":"Avalia se um pedido pode abrir uma solicitação de troca ou devolução","description":"Aplica as regras de negócio configuradas na conta sobre um pedido e devolve overedito: o consumidor pode ou não seguir com a troca/devolução dos itens escolhidos,e qual mensagem deve ser exibida a ele."}},"httpPath":"/v1/pvt/processo/avaliar-regras-pedido"}]},{"type":"group","label":"Produtos","link":"/openapi/produtos","routeSlug":"/openapi/produtos","items":[{"label":"Informar o rating de um ou mais produtos de uma solicitação de troca ou devolução","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/produtos/informarratingproduto","routeSlug":"/openapi/produtos/informarratingproduto","metadata":{"seo":{"title":"Informar o rating de um ou mais produtos de uma solicitação de troca ou devolução","description":"Informar o rating de um ou mais produtos de uma solicitação de troca ou devolução"}},"httpPath":"/v3/pvt/Produto/rating"},{"label":"Consulta um produto na loja virtual, com SKUs, preço e estoque em tempo real","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/produtos/obterprodutodoconector","routeSlug":"/openapi/produtos/obterprodutodoconector","metadata":{"seo":{"title":"Consulta um produto na loja virtual, com SKUs, preço e estoque em tempo real","description":"Busca um produto diretamente na plataforma de e-commerce integrada (via conector),retornando suas variações (SKUs), preços e disponibilidade no momento da consulta."}},"httpPath":"/v1/pvt/pedido/obter-produto-do-conector"}]},{"type":"group","label":"Financeiro","link":"/openapi/financeiro","routeSlug":"/openapi/financeiro","items":[{"label":"Verifica se o consumidor pode \"manter o item\" em vez de devolvê-lo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/financeiro/verificarelegibilidademanteritem","routeSlug":"/openapi/financeiro/verificarelegibilidademanteritem","metadata":{"seo":{"title":"Verifica se o consumidor pode \"manter o item\" em vez de devolvê-lo","description":"Informa se, para o e-mail consultado, a conta permite a modalidade \"mantenha oitem\" — o consumidor recebe o reembolso e fica com o produto, sem precisarpostá-lo de volta."}},"httpPath":"/v1/pvt/financeiro/verificar-elegibilidade-manter-item"},{"label":"Calcula o valor do reembolso e o texto a exibir ao consumidor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/financeiro/calcularvaloretextoestorno","routeSlug":"/openapi/financeiro/calcularvaloretextoestorno","metadata":{"seo":{"title":"Calcula o valor do reembolso e o texto a exibir ao consumidor","description":"Calcula quanto será devolvido em um processo, aplicando a regra de frete configuradana conta, e devolve junto a frase pronta para exibição ao consumidor."}},"httpPath":"/v1/pvt/financeiro/calcular-valor-etexto-estorno"},{"label":"Calcula a quebra do reembolso por forma de devolução (estorno × vale-compra)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/financeiro/calcularvaloresestornoporitem","routeSlug":"/openapi/financeiro/calcularvaloresestornoporitem","metadata":{"seo":{"title":"Calcula a quebra do reembolso por forma de devolução (estorno × vale-compra)","description":"Dado o conjunto de itens devolvidos e as transações de pagamento do pedido original,calcula quanto vai para cada destino: estorno no meio de pagamento, estorno automático,vale-compra, frete e cashback."}},"httpPath":"/v1/pvt/financeiro/calcular-valores-estorno-por-item"},{"label":"Verifica se as transações do pedido permitem estorno automático","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/financeiro/verificarpermissaoestornoautomaticoporitem","routeSlug":"/openapi/financeiro/verificarpermissaoestornoautomaticoporitem","metadata":{"seo":{"title":"Verifica se as transações do pedido permitem estorno automático","description":"Analisa as transações de pagamento do pedido e informa se o estorno pode serexecutado automaticamente na plataforma de e-commerce/adquirente, sem intervençãomanual do time de atendimento."}},"httpPath":"/v1/pvt/financeiro/verificar-permissao-estorno-automatico-por-item"},{"label":"Verifica se um pedido é elegível a estorno automático","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/financeiro/verificarelegibilidadeestornoautomatico","routeSlug":"/openapi/financeiro/verificarelegibilidadeestornoautomatico","metadata":{"seo":{"title":"Verifica se um pedido é elegível a estorno automático","description":"Versão \"pedido inteiro\" da verificação de estorno automático: recebe o pedido e o valorpretendido do reembolso e responde se ele pode ser estornado automaticamente, conformea configuração da conta e as características do pagamento."}},"httpPath":"/v1/pvt/financeiro/verificar-elegibilidade-estorno-automatico"}]},{"type":"group","label":"Vale-compra","link":"/openapi/vale-compra","routeSlug":"/openapi/vale-compra","items":[{"label":"Obtém as definições de vale-compra da conta","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/vale-compra/obtervalecomprasdocliente","routeSlug":"/openapi/vale-compra/obtervalecomprasdocliente","metadata":{"seo":{"title":"Obtém as definições de vale-compra da conta","description":"Retorna as regras de vale-compra configuradas na conta — até duas, identificadaspela ordem (ValeCompra1 e ValeCompra2)."}},"httpPath":"/v1/pvt/vale-compra/obter-vale-compras-do-cliente"}]},{"type":"group","label":"Logística","link":"/openapi/logistica","routeSlug":"/openapi/logistica","items":[{"label":"Lista as transportadoras ativas para a logística reversa","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/logistica/obtertransportadorasativas","routeSlug":"/openapi/logistica/obtertransportadorasativas","metadata":{"seo":{"title":"Lista as transportadoras ativas para a logística reversa","description":"Lista as transportadoras habilitadas na conta, com as modalidades de coleta/postagemque cada uma aceita e, quando informado o CEP de origem, apenas as que atendem àquelaregião."}},"httpPath":"/v1/pvt/logistica/obter-transportadoras"},{"label":"Lista as lojas físicas ativas para devolução presencial","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/logistica/listarlojasfisicasativas","routeSlug":"/openapi/logistica/listarlojasfisicasativas","metadata":{"seo":{"title":"Lista as lojas físicas ativas para devolução presencial","description":"Lista as lojas físicas ativas da conta, com endereço completo e as regras quedeterminam quando cada uma pode ser usada."}},"httpPath":"/v1/pvt/loja-fisica/listar-lojas-ativas"},{"label":"Calcula a rota de entrega expressa mais barata até uma loja física","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/logistica/obterentregaexpressamaisbarata","routeSlug":"/openapi/logistica/obterentregaexpressamaisbarata","metadata":{"seo":{"title":"Calcula a rota de entrega expressa mais barata até uma loja física","description":"A partir do endereço do consumidor, calcula qual das lojas físicas da conta resultana rota de entrega expressa mais barata, retornando o valor e o endereço de destino."}},"httpPath":"/v1/pvt/logistica/obter-entrega-expressa-mais-barata"}]},{"type":"group","label":"Notas de devolução","link":"/openapi/notas-de-devolucao","routeSlug":"/openapi/notas-de-devolucao","items":[{"label":"Adiciona uma nota fiscal de devolução","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notas-de-devolucao/addnotadevolucao","routeSlug":"/openapi/notas-de-devolucao/addnotadevolucao","metadata":{"seo":{"title":"Adiciona uma nota fiscal de devolução","description":"Adiciona uma nota fiscal de devolução ao processo informado. Retorna BadRequest caso o processo não seja encontrado ou já exista uma nota com o mesmo número."}},"httpPath":"/v3/pvt/Fiscal/{processoId}"},{"label":"Atualiza uma nota fiscal de devolução","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notas-de-devolucao/updatenotadevolucao","routeSlug":"/openapi/notas-de-devolucao/updatenotadevolucao","metadata":{"seo":{"title":"Atualiza uma nota fiscal de devolução","description":"Atualiza uma nota fiscal de devolução. Retorna BadRequest caso não sejam encontrados o processo ou a nota, ou já exista outra nota com o mesmo número. A nota atualizada será automaticamente ativada, caso esteja inativa."}},"httpPath":"/v3/pvt/Fiscal/{processoId}/{notaFiscalId}"},{"label":"Inativa uma nota fiscal de devolução","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notas-de-devolucao/inativarnotadevolucao","routeSlug":"/openapi/notas-de-devolucao/inativarnotadevolucao","metadata":{"seo":{"title":"Inativa uma nota fiscal de devolução","description":"Inativa uma nota fiscal de devolução. Retorna BadRequest caso o processo ou a nota não sejam encontrados pelos identificadores informados."}},"httpPath":"/v3/pvt/Fiscal/{processoId}/{notaFiscalId}"},{"label":"Lista as notas fiscais de devolução por processo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notas-de-devolucao/listarnotasdevolucaoporprocesso","routeSlug":"/openapi/notas-de-devolucao/listarnotasdevolucaoporprocesso","metadata":{"seo":{"title":"Lista as notas fiscais de devolução por processo","description":"Lista as notas fiscais de devolução por processo"}},"httpPath":"/v3/pvt/fiscal"},{"label":"Obtém uma nota de devolução por ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notas-de-devolucao/getnotadevolucaoporid","routeSlug":"/openapi/notas-de-devolucao/getnotadevolucaoporid","metadata":{"seo":{"title":"Obtém uma nota de devolução por ID","description":"Obtém uma nota de devolução por ID"}},"httpPath":"/v3/pvt/fiscal/{id}"}]}]}