Skip to main content

Check Seller

Este endpoint é responsável por Verificar o distribuidor parceiro.

Método: GET

URI do Endpoint: https://integration-loyalt.orbia.nom.co/prwapi/accrual-invoice/check-seller

Requisição e Tipos de Dados​

Tipo de Conteúdo da Requisição: application/json

Corpo da Requisição:​

Para verificar um distribuidor, devemos informar:

  • Os parâmetros de entrada clientId e clientSecret, que são os que foram enviados pela Orbia para ser usados no ambiente correspondente.

  • clientVersion: "1.0.0" , Indica a versão da API, neste caso da /check-seller a ultima versão é a 1.0.0

  • culture: "pt-BR", indica o Idioma de onde o distribuidor tem seu cadastro junto a Orbia.

  • campaign: "BRBAY", indica a campanha, fixo BRBAY

  • document: "CNPJ_do_Distribuidor", CNPJ cadastrado na Orbia.

Exemplo de Requisição:​

{ 
  "clientId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX", 
  "clientSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX", 
  "clientVersion": "1.0.0", 
  "culture": "pt-BR", 
  "campaign": "BRBAY", 
  "parameters": { 
    "document": "CNPJ_do_Distribuidor", 
  } 
}

Cómo Testar o Endpoint​

Para testar este endpoint, você pode usar ferramentas como Postman ou cURL. Siga as instruções abaixo:

  1. Abra o Postman.

  2. Selecione o método GET e insira a URL do endpoint.

  3. No corpo da requisição, insira o JSON do exemplo fornecido.

  4. Envie a requisição e observe a resposta.

Importante

Para um teste bem-sucedido, certifique-se de que você tem as credenciais corretas (se necessário) e que o corpo da requisição está corretamente formatado conforme o exemplo.

Este documento serve como um guia básico para entender e testar o endpoint específico. Ajuste as seções conforme necessário para se adequar ao seu ambiente de negócios e práticas de desenvolvimento.