Retorna os dados comerciais do fornecedor

Este endpoint é responsável por retornar dados comerciais cadastrados do fornecedor.

Método: GET

URI do Endpoint: https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/supplierConfiguration/supplierData

Requisição

Esse endpoint não tem parâmetro para requisição, isso é feito pelas credenciais.

Possíveis Respostas

Códigos de Resposta e seus significados:

Status Code	Descrição
200	Sucesso: A requisição foi bem-sucedida.
400	Bad Request: Erro de validação ou processamento da requisição. Verifique o corpo da requisição.
401	Unauthorized: Autenticação necessária e não fornecida.
403	Forbidden: A requisição foi autenticada, mas o usuário não tem permissões para a ação.
502	Bad Gateway: O servidor, atuando como gateway ou proxy, recebeu uma resposta inválida do servidor upstream.

Exemplos de Respostas:

• Sucesso (200):

{
  "supplierData": {
    "document": "string",
    "stateRegistration": "string",
    "companyName": "string",
    "commercialName": "string",
    "commercialPhone": "string",
    "webSite": "string",
    "email": "string",
    "taxRegime": "string"
  }
}

Descrição das propriedades:

Nome da propriedade	Descrição	Tipo
supplierData	Objeto da resposta	object
document	Documento “CPF” ou “CNPJ”	string
stateRegistration	Registro estadual	string
companyName	Nome da empresa	string
commercialName	Nome comercial	string
commercialPhone	Data de nascimento do contato financeiro	string
webSite	Site do fornecedor	string
email	Email de contato do fornecedor	string
taxRegime	Regime tributário da empresa	string

• Erro (400):

{
  "statusCode": 0,
  "message": "string",
  "errors": {
    "additionalProp1": ["string"],
    "additionalProp2": ["string"],
    "additionalProp3": ["string"]
  }
}

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.