Retorna as informações da loja do fornecedor

Este endpoint é responsável por retornar as informações da loja do fornecedor.

Método: GET

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

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

{
  "staticInformation": {
    "storeUrl": "string",
    "aboutCompany": "string",
    "deliveryPolicy": "string",
    "returnPolicy": "string",
    "storeImageUrl": "string",
    "createDate": "2024-07-01T15:16:28.602Z",
    "lastUpdateDate": "2024-07-01T15:16:28.602Z"
  }
}

Descrição das propriedades:

Nome da propriedade	Descrição	Tipo
staticInformation	Objeto da resposta	object
storeUrl	Url da sua loja personalizada na Orbia (https://orbia.ag/loja/SUA_MARCA)	string
aboutCompany	Sobre a Empresa	string
deliveryPolicy	Política de Entrega	string
returnPolicy	Política de Devolução	string
storeImageUrl	url do endpoint GET: orbia-marketplace-hub/v1/file	string
createDate	Data de criação do dado	string
lastUpdateDate	Última atualização do dado	string

:::Tip Importante

A propriedade storeImageUrl receberá a URL indicando o endpoint GET : orbia-marketplace-hub/v1/file. Caso queira recuperar a imagem, deverá realizar uma requisição nesse endpoint.

:::

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

Casos de uso

1. Vamos recuperar os dados da loja do fornecedor.

Agora vamos recuperar o base64 da imagem logo da loja

Vamos usar o endpoint GET : file