Pular para o conteúdo

Detalhes do pedido

Requisição

Host: Keeta. Principais campos da resposta 200:

CampoDescrição
id, displayIdID do pedido e código exibido ao cliente
typeDELIVERY, TAKEOUT, INDOOR (na prática, DELIVERY)
categoryFOOD, GROCERY, DRUGSTORE, PETSTORE
createdAt, lastEventCriação e último evento
orderTimingINSTANT, SCHEDULED, ONDEMAND
preparationStartDateTimeSugestão de início do preparo
merchantid, name
items[]id, index, name, externalCode (código PDV), unit, quantity, specialInstructions, unitPrice, originalPrice, optionsPrice, subtotalPrice, totalPrice = quantity × (unitPrice + optionsPrice), options[]
otherFees[]name, type (DELIVERY_FEE, SERVICE_FEE, TIP, MIN_ORDER_FEE), receivedBy (MARKETPLACE, MERCHANT, LOGISTIC_SERVICES), price, observation
discounts[]amount, target (CART, DELIVERY_FEE, ITEM), targetId, sponsorshipValues[] (name: MARKETPLACE, MERCHANT, CHAIN; amount; discountCode)
totalitemsPrice, otherFees, discount, orderAmount = itens + taxas − descontos
paymentsprepaid, pending, methods[] (value, currency, type: PREPAID/PENDING, method, brand, methodInfo, transaction, changeFor)
customerid, name, documentNumber, phone.number (criptografado), email, ordersCountOnMerchant
deliverydeliveredBy (MERCHANT/MARKETPLACE), deliveryAddress, estimatedDeliveryDateTime, deliveryDateTime, pickupCode
schedulescheduledDateTimeStart, scheduledDateTimeEnd (só pedidos agendados)
orderPriorityPRIORITY1 … PRIORITY5
sendPreparing, sendDelivered, sendPickedUp, sendTrackingIndicam se o Software Service deve chamar os endpoints correspondentes
taxInvoice, extraInfoNota fiscal e informações extras

Valores monetários: objeto { "value": 29.9, "currency": "BRL" } (até 4 casas decimais).

payments.methods[].method: CREDIT, DEBIT, MEAL_VOUCHER, FOOD_VOUCHER, DIGITAL_WALLET, PIX, CASH, CREDIT_DEBIT, COUPON, REDEEM, PREPAID_REDEEM, OTHER.

brand (cartões): VISA, MASTERCARD, DINERS, AMEX, HIPERCARD, ELO, AURA, DISCOVER, VR_BENEFICIOS, SODEXO, TICKET, GOOD_CARD, BANESCARD, SOROCARD, POLICARD, VALECARD, AGICARD, JCB, CREDSYSTEM, CABAL, GREEN_CARD, VEROCHEQUE, AVISTA, OTHER.

delivery.deliveryAddress: country, state (BR-XX), city, district (bairro), street, number, complement, reference, formattedAddress, postalCode (CEP), coordinates{latitude, longitude}.

Erros: 400, 401, 403, 404, 503.

Apêndice A — Exemplo de pedido (Brasil)

Pedido de entrega própria (merchant), em São Paulo, pago via PIX. Campos criptografados mostrados com ENC_.

{
  "id": "783441058793308",
  "type": "DELIVERY",
  "displayId": "4821",
  "sourceAppId": "Keeta",
  "category": "FOOD",
  "createdAt": "2026-10-13T20:41:05Z",
  "lastEvent": "CREATED",
  "orderTiming": "INSTANT",
  "preparationStartDateTime": "2026-10-13T20:41:05Z",
  "merchant": { "id": "LOJA-SP-001", "name": "Lanchonete Moema" },
  "items": [
    {
      "id": "it-1", "index": 0, "name": "Coxinha de frango com catupiry", "externalCode": "PDV-1001",
      "unit": "UN", "quantity": 4,
      "unitPrice": { "value": 7.9, "currency": "BRL" },
      "optionsPrice": { "value": 1.0, "currency": "BRL" },
      "totalPrice": { "value": 35.6, "currency": "BRL" },
      "specialInstructions": "Bem quentinha, por favor",
      "options": [
        { "id": "op-1", "name": "Molho de pimenta", "externalCode": "PDV-9001", "unit": "UN", "quantity": 1,
          "unitPrice": { "value": 1.0, "currency": "BRL" }, "totalPrice": { "value": 1.0, "currency": "BRL" } }
      ]
    },
    {
      "id": "it-2", "index": 1, "name": "Guaraná Antarctica lata 350 ml", "externalCode": "PDV-3005",
      "unit": "UN", "quantity": 2,
      "unitPrice": { "value": 6.5, "currency": "BRL" },
      "totalPrice": { "value": 13.0, "currency": "BRL" }
    }
  ],
  "otherFees": [
    { "name": "Taxa de entrega", "type": "DELIVERY_FEE", "receivedBy": "MERCHANT", "price": { "value": 7.99, "currency": "BRL" } }
  ],
  "discounts": [
    { "amount": { "value": 5.0, "currency": "BRL" }, "target": "CART",
      "sponsorshipValues": [ { "name": "MERCHANT", "amount": { "value": 5.0, "currency": "BRL" }, "discountCode": "BEMVINDO5" } ] }
  ],
  "total": {
    "itemsPrice": { "value": 48.6, "currency": "BRL" },
    "otherFees": { "value": 7.99, "currency": "BRL" },
    "discount": { "value": 5.0, "currency": "BRL" },
    "orderAmount": { "value": 51.59, "currency": "BRL" }
  },
  "payments": {
    "prepaid": 51.59, "pending": 0,
    "methods": [ { "value": 51.59, "currency": "BRL", "type": "PREPAID", "method": "PIX" } ]
  },
  "customer": {
    "id": "cust-90817", "name": "Mariana", "phone": { "number": "ENC_#MQesaE=#1#" }, "ordersCountOnMerchant": 3
  },
  "delivery": {
    "deliveredBy": "MERCHANT",
    "deliveryAddress": {
      "country": "BR", "state": "BR-SP", "city": "São Paulo",
      "district": "ENC_#Xp91ab=#1#", "street": "Rua Domingos de Morais", "number": "ENC_#Lk20qz=#1#",
      "complement": "ENC_#Tt77wa=#1#", "reference": "Próximo à estação Santa Cruz",
      "formattedAddress": "ENC_#Aa13fx=#1#", "postalCode": "04010-100",
      "coordinates": { "latitude": -23.5874, "longitude": -46.6343 }
    },
    "estimatedDeliveryDateTime": "2026-10-13T21:25:00Z"
  },
  "sendDelivered": true,
  "sendTracking": true
}

Conta de conferência: itens 35,60 + 13,00 = R$ 48,60; + entrega R$ 7,99 − desconto R$ 5,00 = R$ 51,59. Horários em UTC (20:41Z = 17:41 em Brasília).

Segurança
OAuth2(Escopos obrigatórios: od.all) and Sig
Caminho
orderIdstringobrigatório

The unique identifier of the order. The order ID is generated by Keeta.

curl -i -X GET \
  'https://open.mykeeta.com/api/open/opendelivery/v1/orders/{orderId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-App-Signature: YOUR_API_KEY_HERE'

Respostas

Order returning success.

Corpoapplication/json
idstringobrigatório

Identificador único do pedido. O ID do pedido é gerado pela Keeta.

typestringobrigatório

DELIVERY — pedidos entregues no endereço do cliente. TAKEOUT — pedidos retirados pelo cliente no estabelecimento. INDOOR — pedidos consumidos no estabelecimento.

Enum:"DELIVERY""TAKEOUT""INDOOR"
displayIdstringobrigatório

ID do pedido exibido ao cliente na interface da Keeta.

sourceAppIdstring

AppId da Keeta que originou o pedido. Ajuda aplicações que atuam como Hub e intermediam as solicitações entre a Keeta e o Software Service.

salesChannelstring

Canal de vendas de origem do pedido.

virtualBrandstring

ID alternativo do merchant quando o mesmo merchant possui identificações ou marcas diferentes, como dark kitchens. A Keeta ou o Software Hub deve conhecer este ID previamente.

categorystring

Categoria do pedido.

Padrão:"FOOD"
Enum:"FOOD""GROCERY""DRUGSTORE""PETSTORE"
createdAtstring, (date-time)obrigatório

Data e hora UTC de criação do pedido.

lastEventstring

Último evento válido recebido por polling, tenha sido confirmado ou não, ou enviado por webhook. Consulte a definição de cada tipo em Eventos de pedidos.

Enum:"CREATED""CONFIRMED""DISPATCHED""READY_FOR_PICKUP""PICKED_UP""DELIVERED""CONCLUDED""CANCELLATION_REQUESTED""CANCELLED""USER_REFUND_REQUEST"
orderTimingstringobrigatório

Momento de início do pedido:

INSTANT: pedido que deve ser preparado imediatamente. SCHEDULED: pedido agendado para uma data e hora específicas. Sempre acompanhado do objeto schedule. ONDEMAND: pedido entregue quando o consumidor indicar que irá retirá-lo. Nesse caso, o Software Service recebe um evento PREPARATION_REQUESTED para iniciar o preparo.

Enum:"INSTANT""SCHEDULED""ONDEMAND"
preparationStartDateTimestring, (date-time)obrigatório

Sugestão de horário para iniciar o preparo após a criação do pedido. A Keeta pode usar este campo para solicitar atraso no início do preparo. O padrão é o horário de criação do pedido, em UTC.

merchantobjectobrigatório

Informações do merchant.

itemsArray of objectsobrigatório

Itens do pedido.

otherFeesArray of objects

Outras taxas que podem ser aplicadas.

discountsArray of objects

Descontos que podem ser aplicados.

totalobjectobrigatório

Conjunto de campos com a soma dos valores descritos anteriormente no pedido.

paymentsobjectobrigatório

Informações de pagamento, incluindo métodos, valores pagos antecipadamente e troco.

taxInvoiceobject

Informações da nota fiscal.

customerobject

Informações do cliente. Obrigatório quando type for DELIVERY.

scheduleobject

Informações de pedidos agendados. Obrigatório quando orderTiming for SCHEDULED.

orderPrioritystring

Define a prioridade de preparo e entrega deste pedido em relação aos demais pedidos da mesma Keeta. Quanto menor o valor, mais rapidamente o pedido deve ser atendido. Observação: depende do suporte da Keeta e do merchant.

Enum:"PRIORITY1""PRIORITY2""PRIORITY3""PRIORITY4""PRIORITY5"
deliveryobject

Informações de pedidos DELIVERY. Obrigatório quando type for DELIVERY.

takeoutobject

Informações de pedidos TAKEOUT. Obrigatório quando type for TAKEOUT.

indoorobject

Informações de pedidos INDOOR. Obrigatório quando type for INDOOR.

sendPreparingboolean

Indica se o Software Service deve chamar POST /v1/orders/{orderId}/preparing para informar à Keeta que o pedido está em preparo. true: a Keeta aguarda a chamada. false ou não informado: a chamada não é necessária.

sendDeliveredboolean

Indica se o Software Service deve chamar POST /v1/orders/{orderId}/delivered para informar à Keeta que o pedido foi entregue. true: a Keeta aguarda a chamada. false ou não informado: a chamada não é necessária.

sendPickedUpboolean

Indica se o Software Service deve chamar POST /v1/orders/{orderId}/pickedUp para informar à Keeta que o pedido foi retirado pelo cliente. true: a Keetaaguarda a chamada.false` ou não informado: a chamada não é necessária.

sendTrackingboolean

Indica se o Software Service deve chamar POST /v1/orders/{orderId}/tracking para informar atualizações da entrega à Keeta. true: a Keeta aguarda a chamada. false ou não informado: a chamada não é necessária.

extraInfostring

Informações adicionais, se necessário.

Resposta
{ "id": "string", "type": "DELIVERY", "displayId": "string", "sourceAppId": "string", "salesChannel": "string", "virtualBrand": "string", "category": "FOOD", "createdAt": "2019-08-24T14:15:22Z", "lastEvent": "CREATED", "orderTiming": "INSTANT", "preparationStartDateTime": "2019-08-24T14:15:22Z", "merchant": { "id": "22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824", "name": "Pizza Plaza" }, "items": [ { … } ], "otherFees": [ { … } ], "discounts": [ { … } ], "total": { "itemsPrice": { … }, "otherFees": { … }, "discount": { … }, "orderAmount": { … } }, "payments": { "prepaid": 0, "pending": 0, "methods": [ … ] }, "taxInvoice": { "issued": false, "taxInvoiceURL": "string" }, "customer": { "id": "string", "name": "string", "documentNumber": "string", "phone": { … }, "email": "string", "ordersCountOnMerchant": 0 }, "schedule": { "scheduledDateTimeStart": "2019-08-24T14:15:22Z", "scheduledDateTimeEnd": "2019-08-24T14:15:22Z" }, "orderPriority": "PRIORITY1", "delivery": { "deliveredBy": "MERCHANT", "deliveryAddress": { … }, "estimatedDeliveryDateTime": "2019-08-24T14:15:22Z", "deliveryDateTime": "2019-08-24T14:15:22Z", "pickupCode": "string" }, "takeout": { "mode": "DEFAULT", "takeoutDateTime": "2019-08-24T14:15:22Z" }, "indoor": { "mode": "DEFAULT", "indoorDateTime": "2019-08-24T14:15:22Z", "place": "string", "tab": "string", "seat": "string", "waiterCode": "string" }, "sendPreparing": true, "sendDelivered": true, "sendPickedUp": true, "sendTracking": true, "extraInfo": "string" }