Skip to content

Obtém o conector de e-commerce da conta

Request

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.).

Para que serve

O conector diz o que a plataforma integrada é capaz de fazer. Duas contas Genius podem ter comportamentos completamente diferentes conforme a plataforma e o que foi contratado. Antes de oferecer qualquer opção ao consumidor, consulte este endpoint e use os campos permiteEstorno, permiteGerarValeCompras, permiteBuscaPedidoPorNumero e permiteBuscaPedidoPorEmail para decidir o que exibir.

Como o front Genius usa

É uma das primeiras chamadas do fluxo, logo após a autenticação. O front:

  1. Consulta o conector e guarda o resultado na sessão;
  2. Habilita o campo de busca de pedido por número e/ou por e-mail conforme as flags;
  3. Esconde a opção "receber em vale-compra" quando permiteGerarValeCompras é false;
  4. Esconde a opção de estorno automático quando permiteEstorno é false;
  5. Usa prazoEmDiasParaEstornoAutomatico para calcular até quando o estorno automático ainda é possível no meio de pagamento original.

Observações

  • Credenciais da plataforma (apiKey, apiToken) nunca são retornadas.
  • Se a conta não possui conector ativo para a loja informada, entidade volta null com registros: 0 — trate como "integração não configurada", e não como erro.
Security
BearerAuth
Query
geniusVirtualStoreIdinteger or null, (int64)

Id da loja virtual (subconta) na Genius Returns. Informe apenas se a conta opera múltiplas lojas virtuais e você quer o conector de uma loja específica. Omitindo o parâmetro, retorna o conector da conta que não está atribuído a nenhuma loja virtual.

curl -i -X GET \
  'https://apidocs.geniusreturns.com.br/_mock/openapi/v2/pvt/ecommerce/obter-conector?geniusVirtualStoreId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Conector localizado (ou entidade nula quando não há conector).

Bodyapplication/json
dataHoraRespostastring, (date-time)

Data e hora da resposta, em UTC.

registrosinteger, (int32)

Quantidade de registros retornados em entidade.

httpStatusstring

Código HTTP da resposta, em texto.

erroCodigostring or null

Código do erro, quando houver.

erroDescricaostring or null

Mensagem do erro, quando houver.

erroDetalhadostring or null

Detalhamento técnico do erro, quando houver.

erroTipostring or null

Classificação do erro. Útil para distinguir falha de integração com a plataforma de e-commerce (04) de erro de domínio ou erro comum (00).

entidadeobject(ConectorEcommModel)

Conector que liga a conta Genius Returns à plataforma de e-commerce. As flags permite* descrevem o que a plataforma integrada suporta e devem guiar quais opções sua aplicação oferece ao consumidor.

Response
{
  "dataHoraResposta": "2026-09-18T13:20:11.4821Z",
  "registros": 1,
  "httpStatus": "200",
  "entidade": {
    "id": 42,
    "nome": "VTEX - Loja Oficial",
    "ativo": true,
    "accountName": "lojaoficial",
    "hostname": "lojaoficial.vtexcommercestable.com.br",
    "statusPermitidos": "invoiced,handling",
    "permiteEstorno": true,
    "permiteGerarValeCompras": true,
    "permiteBuscaPedidoPorNumero": true,
    "permiteBuscaPedidoPorEmail": true,
    "feedDePedidosConfigurado": true,
    "valeCompraPossuiCodigo": true,
    "prazoEmDiasParaEstornoAutomatico": 90,
    "useStoreCredit": false,
    "restrictedToOwnerGiftcard": true,
    "lojaVirtual": { … }
  }
}