Recupera os dados detalhados da remessa

Este endpoint é responsável por recuperar os dados da remessa.

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.

• ShipmentId(int, obrigatória, query): Identificador único da remessa que está sendo consultado.

Exemplo de Requisição:

https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/shipment/shipmentDetail?ShipmentId=1

Respostas Possíveis

Códigos de Resposta e seus significados:

Status Code	Descrição	Observação	Corpo da resposta
200	Sucesso na operação	Retorna em qualquer tipo de requisição com sucesso	Sim
400	Bad Request: Erro de validação ou processamento da requisição.	Verifique o corpo da requisição.	Sim
401	Unauthorized: Autenticação necessária e não fornecida.	Verifique seu ClientId, ClientSecret e o Token enviado	Não
403	Forbidden: A requisição foi autenticada, mas o usuário não tem permissões para a ação.	Verifique suas configurações de rede ou VPN	Não
502	Bad Gateway: 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	Verifique sua requisição	Não

Exemplos de Respostas:

• OK (200):

{
  "trackings": [
    {
      "status": "string",
      "date": "2024-05-07T12:56:45.862Z"
    }
  ],
  "totalValue": 0,
  "deliveryTime": "2024-05-07T12:56:45.862Z",
  "invoices": [
    {
      "url": "string",
      "type": "string",
      "documentDate": "2024-05-07T12:56:45.862Z",
      "documentNumber": "string",
      "danfe": "string"
    }
  ],
  "items": [
    {
      "idItemOrder": 0,
      "sku": "string",
      "price": 0,
      "quantity": 0,
      "productId": 0,
      "productTypeId": 0
    }
  ]
}

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"]
  }
}

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

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.