Recuperação de arquivos na estrutura

Este endpoint é responsável por recuperar arquivos vinculados a uma entidade em nossa estrutura, ele retornará o arquivo no formato Base64

Método: GET

URI do Endpoint: https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/shipment/shipmentDetail

Requisição e Tipos de Dados

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

Corpo da Requisição:

Para recuperar os dados do pedido, devemos informar o id do pedido.

• FileType(int, obrigatória, query): Identificador do tipo de arquivo que será retornado.
• EntityId(int, obrigatória, query): Identificador da entidade relacionada ao arquivo.

Tipos de Documentos Armazenados	ID
Receituário agrícola	1
Nota fiscal	2
Imagem da loja	3
Boleto	4
Dados Bancários	6
Documento do produto (bulas, rótulos, fispq, fe)	9

Observação: Em grande maioria, nossos endpoints irão retornar essa url quando se tratar de recuperação de algum documento

Exemplo:

• Ao chamar outro endpoint, de recuperação de pedido no caso, ele pode retornar a url do receituário atrelada ao pedido e irá realizar da seguinte maneira

Exemplo de Requisição:

https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/file?FileType=1&EntityId=

Possíveis Respostas

Códigos de Resposta e seus significados:

Status Code	Descrição
200	Sucesso.
400	Bad Request: Erro de validação ou processamento 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	BadGateway: indica que ele, enquanto atuando como um servidor intermediário, recebeu uma resposta inválida do servidor para o qual a requisição foi encaminhada.

Exemplos de Respostas:

• Sucesso (200):

{
  "fileName": "string",
  "mimeType": "string",
  "base64": "string"
}

• Erro (400):

{
  "statusCode": 400,
  "message": "Erro de validação.",
  "errors": {
    "additionalProp1": ["Erro específico 1"],
    "additionalProp2": ["Erro específico 2"],
    "additionalProp3": ["Erro específico 3"]
  }
}

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.