Detalhes de Pedidos

Esta seção contém informações sobre os endpoints de detalhes de pedidos da API OpenDelivery. Através destas rotas, é possível consultar informações detalhadas sobre pedidos específicos.

Visão Geral

O módulo de detalhes de pedidos permite que aplicações externas obtenham informações completas sobre um pedido, incluindo itens, valores, status atual e histórico de eventos, seguindo o padrão OpenDelivery.

Endpoints Principais

Método	Endpoint	Descrição
GET	/opendelivery/v1/orders/{orderId}	Obtém detalhes completos de um pedido específico

Parâmetros de Consulta

Consulta de Pedido Específico

Parâmetro	Localização	Tipo	Descrição
orderId	path	string	ID único do pedido (UUID)

Limites de Uso (Rate Limiting)

Este endpoint possui as seguintes restrições de uso:

Limite	Janela de Tempo
100 requisições	1 minuto

Quando o limite é excedido, a API retorna o código de status HTTP 429 (Too Many Requests).

Estrutura de Dados

Os detalhes de um pedido incluem as seguintes informações principais:

• Informações básicas: ID do pedido, status atual, datas de criação e atualização
• Itens: Lista de produtos solicitados, com quantidades e valores
• Valor total: Soma dos valores dos itens e taxas adicionais
• Informações do cliente: Nome, endereço, telefone (quando disponíveis)
• Informações de entrega: Endereço, horário estimado, instruções especiais (para pedidos de entrega)

Exemplo de Resposta

{
    "id": "00cf66ff-429d-4c61-9872-0fa5f2a3b66a",
    "type": "TAKEOUT",
    "items": [
        {
            "id": "19277",
            "ean": "",
            "name": "Água",
            "unit": "UN",
            "index": 0,
            "indoor": {
                "productionPoint": ""
            },
            "options": [],
            "quantity": 1,
            "unitPrice": {
                "value": 1.5,
                "currency": "BRL"
            },
            "totalPrice": {
                "value": 1.5,
                "currency": "BRL"
            },
            "externalCode": "",
            "optionsPrice": {
                "value": 0,
                "currency": "BRL"
            },
            "originalPrice": {
                "value": 1.5,
                "currency": "BRL"
            },
            "subtotalPrice": {
                "value": 1.5,
                "currency": "BRL"
            },
            "scalePriceApplied": false,
            "specialInstructions": ""
        }
    ],
    "total": {
        "discount": {
            "value": 0,
            "currency": "BRL"
        },
        "otherFees": {
            "value": 0,
            "currency": "BRL"
        },
        "itemsPrice": {
            "value": 1.5,
            "currency": "BRL"
        },
        "orderAmount": {
            "value": 1.5,
            "currency": "BRL"
        }
    },
    "takeout": {
        "mode": "DEFAULT",
        "takeoutDateTime": "2025-06-24T16:53:54.416Z"
    },
    "customer": {
        "id": "443401",
        "name": "gvyvyuhv buvivbivbi",
        "email": "",
        "phone": {
            "number": "+5515998555464",
            "extension": ""
        },
        "documentNumber": "",
        "ordersCountOnMerchant": 0
    },
    "merchant": {
        "id": "2241",
        "name": "Kaffe Cafeteria Aoba"
    },
    "payments": {
        "methods": [
            {
                "type": "PENDING",
                "brand": "",
                "value": 1.5,
                "method": "OTHER",
                "currency": "BRL",
                "changeFor": 0,
                "methodInfo": "",
                "transaction": {
                    "acquirerDocument": "",
                    "authorizationCode": ""
                }
            }
        ],
        "pending": 1.5,
        "prepaid": 0
    },
    "createdAt": "2025-06-24T16:53:52.922Z",
    "displayId": "443401",
    "lastEvent": "DELIVERED",
    "orderTiming": "SCHEDULED",
    "preparationStartDateTime": "2025-06-24T16:53:52.922Z"
}

Códigos de Status

Código	Descrição
200	Sucesso
400	Requisição inválida
401	Não autorizado
404	Pedido não encontrado
429	Limite de requisições excedido

Documentação Completa

Para informações detalhadas sobre parâmetros, payload e exemplos adicionais, consulte a documentação técnica completa.