Recuperar dados de pedido

Este endpoint é responsável por recuperar os dados do pedido.

Método: GET

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

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.

Nome da propriedade	Descrição	Tipo	Obrigatoriedade
SupplierOrderId	Identificador único do pedido fornecedor que está sendo consultado.	string	optional
OrderId	Identificador único do pedido que está sendo consultado.	string	required

Exemplo de Requisição:

https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/order?OrderId=123

Possíveis Respostas

Códigos de Resposta e seus significados:

Status Code	Descrição
200	Sucesso na consulta.
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: 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):

{
  "order": {
    "orderId": 0,
    "status": "string",
    "updatedAt": "2024-05-06T20:46:22.873Z",
    "totalPrice": 0,
    "shippingValue": 0,
    "paymentMethod": "string",
    "bankSlipUrl": "string",
    "billingAddress": {
      "country": "string",
      "city": "string",
      "state": "string",
      "streetName": "string",
      "district": "string",
      "complement": "string",
      "number": "string",
      "postalCode": "string",
      "reference": "string"
    },
    "shippingAddress": {
      "country": "string",
      "city": "string",
      "state": "string",
      "streetName": "string",
      "district": "string",
      "complement": "string",
      "number": "string",
      "postalCode": "string",
      "reference": "string"
    },
    "customer": {
      "name": "string",
      "email": "string",
      "birthDate": "2024-05-06T20:46:22.873Z",
      "phoneNumber": "string",
      "documentType": "string",
      "documentId": "string"
    },
    "items": [
      {
        "productId": 0,
        "deliveryType": "string",
        "supplierName": "string",
        "ean": "string",
        "sku": "string",
        "name": "string",
        "unitPrice": 0,
        "quantity": 0,
        "financialDiscount": 0,
        "deliveryForecastDate": "2024-05-06T20:46:22.873Z",
        "supplierOrderId": "string",
        "prescription": {
          "prescriptionUrl": "string"
        }
      }
    ],
    "shippings": [
      {
        "shippingId": 0,
        "tracking": {
          "status": "string",
          "date": "2024-05-06T20:46:22.873Z"
        },
        "trackings": [
          {
            "status": "string",
            "date": "2024-05-06T20:46:22.873Z"
          }
        ],
        "totalValue": 0,
        "deliveryTime": "2024-05-06T20:46:22.873Z",
        "invoices": [
          {
            "url": "string",
            "type": "string",
            "documentDate": "2024-05-06T20:46:22.873Z",
            "documentNumber": "string",
            "danfe": "string"
          }
        ],
        "items": [
          {
            "idItemOrder": 0,
            "sku": "string",
            "price": 0,
            "quantity": 0,
            "productId": 0,
            "productTypeId": 0
          }
        ]
      }
    ]
  }
}

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

Como acessar no portal do parceiro

Observação

Todas as informações exibidas neste fluxo são apenas para consulta e não podem ser alteradas diretamente no portal.

Saiba como acessar aos registros dos produtos desde o Portal do Parceiro.

1. Faça login no "Portal Parceiro".
2. No menu, clique no botão "Pedidos".
3. Na tela, você poderá visualizar uma lista detalhada dos pedidos cadastrados assim como o status de cada item, adicione o Id do pedido no campo de busca e clique em "Pesquisar".

4. Clique na linha do pedido cadastrado e veja mais detalhes sobre o mesmo.