Obter detalhes do pedido

O evento só avisa que algo mudou. Para saber o que foi pedido, para quem e como vai ser pago, busque o pedido em GET /merchant/v3/orders/{orderId}, ou direto na orderURL do evento. Faça isso antes de confirmar, para que a loja possa conferir se tem os itens e se atende o endereço.

Requisição

curl 'https://api.deliveryvip.com.br/merchant/v3/orders/{orderId}' \
  --header 'Authorization: Bearer {token}'

const response = await fetch(`https://api.deliveryvip.com.br/merchant/v3/orders/${orderId}`, {
  headers: { Authorization: `Bearer ${token}` },
})
const order = await response.json()

response = requests.get(
    f"https://api.deliveryvip.com.br/merchant/v3/orders/{order_id}",
    headers={"Authorization": f"Bearer {token}"},
)
order = response.json()

uuid

obrigatório

O orderId do evento.

string

Envie optionGroups para receber as opções agrupadas por grupo em items[].optionGroups, em vez da lista simples items[].options.

/merchant/v3/orders/{orderId}?views[]=optionGroups

Status	Quando
`200 OK`	O pedido.
`404 Not Found`	O pedido não existe, é de uma loja que o token não alcança ou ainda aguarda a confirmação do pagamento online.

Pedidos com pagamento online só ficam disponíveis depois que o pagamento é aprovado. Até lá, a busca responde 404.

O que tem num pedido

Identificação

id, type, displayId, orderTiming, lastEvent

Itens

Produtos, opções e preços

Valores

Taxas, descontos e total

Pagamento

Valores pagos, a pagar e formas

Cliente

Nome, documento e contato

Entrega e retirada

delivery, takeout, indoor, schedule

Campos do pedido

Campos opcionais só aparecem quando têm conteúdo. Valores monetários são objetos { "value": número, "currency": "BRL" }, e datas seguem ISO 8601 com o fuso da loja.

Identificação

uuid

obrigatório

Identificador do pedido.

string

obrigatório

DELIVERY, TAKEOUT ou INDOOR. Veja tipos de pedido.

string

obrigatório

Código curto do pedido para a loja identificá-lo. Exiba-o na interface do seu sistema.

string

obrigatório

Canal de venda: STORE, MARKETPLACE, TABLET, QRCODE ou TAB.

string

obrigatório

INSTANT ou SCHEDULED. Pedidos agendados trazem o bloco schedule.

datetime

obrigatório

Quando o pedido foi criado.

datetime

obrigatório

Recomendação de início do preparo. Hoje é igual a createdAt; em pedidos agendados, guie-se pelo schedule.

string

Situação atual do pedido: CREATED, CONFIRMED, READY_FOR_PICKUP, CONCLUDED ou CANCELLED.

object

obrigatório

A loja do pedido.

Mostrar propriedades

string

obrigatório

Identificador da loja: o merchantId que você configurou para ela, quando houver, ou o id da loja na DeliveryVip.

string

obrigatório

Nome da loja.

string

Observação do cliente sobre o pedido.

Itens

object[]

obrigatório

Produtos do pedido.

Mostrar propriedades

uuid

obrigatório

Identificador do item no pedido.

integer

obrigatório

Posição do item no pedido, a partir de 0.

string

obrigatório

Nome do produto.

string

Código do produto no seu sistema, configurado no catálogo.

string

Código de barras do produto.

string

obrigatório

Unidade de medida. Hoje sempre UN.

integer

obrigatório

Quantidade.

string

Observação do cliente sobre o item.

object

obrigatório

Preço unitário do produto, sem as opções.

object

Soma das opções do item. Só vem quando o item tem opções.

object

obrigatório

(unitPrice + optionsPrice) × quantity.

object[]

Opções escolhidas (sabores, adicionais, bordas). Opções iguais do mesmo grupo vêm numa só entrada, com a quantity somada. Não vem quando você pede views[]=optionGroups.

Mostrar propriedades

uuid

obrigatório

Identificador da opção no pedido.

integer

obrigatório

Posição da opção no item.

string

obrigatório

Nome da opção.

string

Código da opção no seu sistema, configurado no catálogo.

string

obrigatório

Hoje sempre UN.

integer

obrigatório

Quantidade da opção.

object

obrigatório

Preço unitário da opção.

object

obrigatório

unitPrice × quantity.

object[]

Só com views[]=optionGroups: as opções agrupadas pelo grupo do catálogo.

Mostrar propriedades

uuid

obrigatório

Identificador do grupo no pedido.

string

obrigatório

Nome do grupo, como “Sabores” ou “Bordas”.

string

Código do grupo no seu sistema.

object

obrigatório

Soma das opções do grupo.

object[]

obrigatório

As opções do grupo, com os mesmos campos de options. Aqui cada opção vem com quantity: 1.

Exemplo de item com optionGroups

"optionGroups": [
  {
    "id": "3e94cbcf-359a-4ed3-bcdb-c36a15b48971",
    "name": "Sabores Pizza",
    "totalPrice": { "value": 12.0, "currency": "BRL" },
    "options": [
      {
        "id": "4e4faed4-aea0-48dd-b25e-fdff503c98f0",
        "index": 0,
        "name": "Chocolate Preto M&Ms",
        "externalCode": "23",
        "unit": "UN",
        "quantity": 1,
        "unitPrice": { "value": 6.0, "currency": "BRL" },
        "totalPrice": { "value": 6.0, "currency": "BRL" }
      },
      {
        "id": "ae909b21-d1dc-45f1-880b-bcba53a7afa8",
        "index": 1,
        "name": "Bombom Chocolate Branco",
        "externalCode": "8",
        "unit": "UN",
        "quantity": 1,
        "unitPrice": { "value": 6.0, "currency": "BRL" },
        "totalPrice": { "value": 6.0, "currency": "BRL" }
      }
    ]
  }
]

Valores

object[]

Taxas cobradas no pedido. Só vem em pedidos DELIVERY.

Mostrar propriedades

string

obrigatório

Nome da taxa. Hoje igual ao type.

string

obrigatório

DELIVERY_FEE, SERVICE_FEE, TIP ou MIN_ORDER_FEE.

string

obrigatório

Quem recebe a taxa: MERCHANT, MARKETPLACE ou LOGISTIC_SERVICES.

string

Documento de quem recebe. Só aparece em pedidos antigos, sem o detalhamento de taxas.

object

obrigatório

Valor da taxa.

object[]

Descontos aplicados. Só vem quando o pedido tem desconto.

Mostrar propriedades

string

obrigatório

Onde o desconto incide: CART (subtotal) ou DELIVERY_FEE (taxa de entrega).

object

obrigatório

Valor do desconto.

object[]

obrigatório

Quem paga o desconto.

Mostrar propriedades

string

obrigatório

MERCHANT ou MARKETPLACE.

string

Identificação do desconto, como o código do cupom.

object

obrigatório

Parte do desconto paga por esse patrocinador.

object

obrigatório

Resumo dos valores.

Mostrar propriedades

object

obrigatório

Soma dos itens.

object

obrigatório

Soma das taxas.

object

obrigatório

Soma dos descontos.

object

obrigatório

Total do pedido: itemsPrice + otherFees - discount.

object

Só para apps com a extensão de fidelidade, quando o cliente tem conta vinculada ao seu programa. Traz accountId, programId e, se houve resgate neste pedido, redemption. Veja Acúmulo.

Pagamento

object

obrigatório

Mostrar propriedades

number

obrigatório

Valor já pago online pelo cliente.

number

obrigatório

Valor que a loja ainda precisa receber, na entrega ou na retirada.

object[]

obrigatório

Formas de pagamento.

Mostrar propriedades

number

obrigatório

Valor pago nessa forma.

string

obrigatório

BRL.

string

obrigatório

PREPAID (pago online) ou PENDING (a receber).

string

obrigatório

CREDIT, DEBIT, MEAL_VOUCHER, FOOD_VOUCHER, DIGITAL_WALLET, PIX, CASH, CREDIT_DEBIT, COUPON, REDEEM, PREPAID_REDEEM ou OTHER.

string

Detalhe da forma de pagamento, como o nome cadastrado pela loja.

string

Bandeira do cartão: 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 ou OTHER.

number

Valor para o qual o cliente precisa de troco. Só em CASH, quando informado.

Cliente

object

Quem fez o pedido. Só vem quando o cliente informou o nome.

Mostrar propriedades

uuid

obrigatório

Identificador do cliente.

string

obrigatório

Nome.

string

CPF ou CNPJ, quando informado. Se o cliente pediu nota fiscal com documento, é o documento da nota.

object

{ "number": "5511999990000" }: telefone com DDI e DDD, só dígitos.

string

E-mail. Não vem para clientes que compraram sem cadastro.

integer

obrigatório

Quantos pedidos esse cliente já fez na loja. Clientes sem cadastro sempre vêm com 1.

Entrega, retirada e indoor

Cada pedido traz o bloco do seu type, e pedidos agendados trazem também schedule.

object

Só em pedidos DELIVERY.

Mostrar propriedades

string

obrigatório

Hoje sempre MERCHANT: a loja faz a entrega.

datetime

Previsão de entrega.

object

obrigatório

Endereço de entrega.

Mostrar propriedades

string

Sigla do país, como BR.

string

Sigla do estado, como SP.

string

Cidade.

string

Bairro.

string

Rua.

string

Número.

string

Complemento, quando informado.

string

Ponto de referência, quando informado.

string

CEP.

string

Endereço completo em uma linha.

object

latitude e longitude do endereço.

object

Só em pedidos TAKEOUT.

Mostrar propriedades

string

obrigatório

Hoje sempre DEFAULT: o cliente retira no balcão.

datetime

Previsão de retirada.

object

Só em pedidos INDOOR.

Mostrar propriedades

string

obrigatório

TAB (comanda), PLACE (mesa ou local) ou DEFAULT (consumo no local pedido pelo cardápio de delivery).

datetime

Previsão de o pedido ficar pronto.

string

Nome do local de entrega, como “Mesa 10”. Mesmo valor de placeName.

string

Nome do local de entrega.

string

Identificador do local de entrega.

string

Código da comanda. Mesmo valor de tabCode. Só no modo TAB.

uuid

Identificador da comanda. Só no modo TAB.

string

Código da comanda. Só no modo TAB.

string

Nome ou número da comanda. Só no modo TAB.

object

Só quando orderTiming é SCHEDULED.

Mostrar propriedades

datetime

obrigatório

Início da janela agendada.

datetime

obrigatório

Fim da janela agendada.

O que o seu sistema deve informar

Estes campos dizem quais ações a DeliveryVip espera do seu sistema neste pedido.

boolean

obrigatório

Sempre true: informe preparing quando o preparo começar.

boolean

obrigatório

true quando não há um parceiro de logística externo cuidando da entrega: o seu sistema informa delivered.

boolean

obrigatório

true em pedidos TAKEOUT e de consumo no local pelo cardápio de delivery: informe pickedUp quando o cliente retirar.

boolean

obrigatório

true quando o seu sistema pode enviar dados de rastreio.

Exemplos

Delivery imediato
Delivery agendado
Retirada imediata
Retirada agendada
Indoor (comanda)

{
  "id": "dc8d922c-eaeb-4d52-aadf-d1771365eb8b",
  "type": "DELIVERY",
  "displayId": "AGNCYO",
  "salesChannel": "STORE",
  "createdAt": "2026-10-24T14:39:28-03:00",
  "orderTiming": "INSTANT",
  "preparationStartDateTime": "2026-10-24T14:39:28-03:00",
  "lastEvent": "CREATED",
  "merchant": {
    "id": "fc5cda2a-6391-4001-9e53-2be75049e0fd",
    "name": "Meu Delivery"
  },
  "items": [
    {
      "id": "3684f036-f738-4c44-bf04-f04a430ebc75",
      "index": 0,
      "name": "Pizza Gigante",
      "externalCode": "104",
      "unit": "UN",
      "quantity": 1,
      "unitPrice": {
        "value": 92.0,
        "currency": "BRL"
      },
      "optionsPrice": {
        "value": 10.0,
        "currency": "BRL"
      },
      "totalPrice": {
        "value": 102.0,
        "currency": "BRL"
      },
      "options": [
        {
          "id": "0296eeee-c6aa-47c7-be96-384513cd25a2",
          "index": 0,
          "name": "Marguerita",
          "externalCode": "40",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 0.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 0.0,
            "currency": "BRL"
          }
        },
        {
          "id": "1618523f-210e-4640-b91b-946cab227ecb",
          "index": 1,
          "name": "Portuguesa",
          "externalCode": "51",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 0.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 0.0,
            "currency": "BRL"
          }
        },
        {
          "id": "25dce2bb-1fcf-4834-9c07-26a63928ae33",
          "index": 2,
          "name": "Borda Doce de Leite",
          "externalCode": "67",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 10.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 10.0,
            "currency": "BRL"
          }
        }
      ]
    }
  ],
  "otherFees": [
    {
      "name": "DELIVERY_FEE",
      "type": "DELIVERY_FEE",
      "receivedBy": "MERCHANT",
      "price": {
        "value": 8.0,
        "currency": "BRL"
      }
    }
  ],
  "total": {
    "itemsPrice": {
      "value": 102.0,
      "currency": "BRL"
    },
    "otherFees": {
      "value": 8.0,
      "currency": "BRL"
    },
    "discount": {
      "value": 0.0,
      "currency": "BRL"
    },
    "orderAmount": {
      "value": 110.0,
      "currency": "BRL"
    }
  },
  "payments": {
    "prepaid": 0.0,
    "pending": 110.0,
    "methods": [
      {
        "value": 110.0,
        "currency": "BRL",
        "type": "PENDING",
        "method": "CREDIT",
        "methodInfo": "Master Crédito",
        "brand": "MASTERCARD"
      }
    ]
  },
  "customer": {
    "id": "b66b6abb-5098-4a03-b624-b72b911e8128",
    "name": "Consumidor",
    "documentNumber": "000.000.000-00",
    "phone": {
      "number": "5511900000000"
    },
    "email": "consumidor@exemplo.com",
    "ordersCountOnMerchant": 3
  },
  "delivery": {
    "deliveredBy": "MERCHANT",
    "estimatedDeliveryDateTime": "2026-10-24T15:24:28-03:00",
    "deliveryAddress": {
      "country": "BR",
      "state": "SP",
      "city": "São Paulo",
      "district": "Moema",
      "street": "Rua Diamante",
      "number": "240",
      "complement": "Apto 12",
      "formattedAddress": "Rua Diamante, 240, Moema, São Paulo, SP",
      "postalCode": "04000-000",
      "coordinates": {
        "latitude": -23.6,
        "longitude": -46.66
      }
    }
  },
  "sendDelivered": true,
  "sendPreparing": true,
  "sendPickedUp": false,
  "sendTracking": true,
  "extraInfo": "Sem cebola, por favor"
}

{
  "id": "dc8d922c-eaeb-4d52-aadf-d1771365eb8b",
  "type": "DELIVERY",
  "displayId": "AGNCYO",
  "salesChannel": "STORE",
  "createdAt": "2026-10-24T14:39:28-03:00",
  "orderTiming": "SCHEDULED",
  "preparationStartDateTime": "2026-10-24T14:39:28-03:00",
  "lastEvent": "CREATED",
  "merchant": {
    "id": "fc5cda2a-6391-4001-9e53-2be75049e0fd",
    "name": "Meu Delivery"
  },
  "items": [
    {
      "id": "3684f036-f738-4c44-bf04-f04a430ebc75",
      "index": 0,
      "name": "Pizza Gigante",
      "externalCode": "104",
      "unit": "UN",
      "quantity": 1,
      "unitPrice": {
        "value": 92.0,
        "currency": "BRL"
      },
      "optionsPrice": {
        "value": 10.0,
        "currency": "BRL"
      },
      "totalPrice": {
        "value": 102.0,
        "currency": "BRL"
      },
      "options": [
        {
          "id": "0296eeee-c6aa-47c7-be96-384513cd25a2",
          "index": 0,
          "name": "Marguerita",
          "externalCode": "40",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 0.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 0.0,
            "currency": "BRL"
          }
        },
        {
          "id": "1618523f-210e-4640-b91b-946cab227ecb",
          "index": 1,
          "name": "Portuguesa",
          "externalCode": "51",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 0.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 0.0,
            "currency": "BRL"
          }
        },
        {
          "id": "25dce2bb-1fcf-4834-9c07-26a63928ae33",
          "index": 2,
          "name": "Borda Doce de Leite",
          "externalCode": "67",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 10.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 10.0,
            "currency": "BRL"
          }
        }
      ]
    }
  ],
  "otherFees": [
    {
      "name": "DELIVERY_FEE",
      "type": "DELIVERY_FEE",
      "receivedBy": "MERCHANT",
      "price": {
        "value": 8.0,
        "currency": "BRL"
      }
    }
  ],
  "total": {
    "itemsPrice": {
      "value": 102.0,
      "currency": "BRL"
    },
    "otherFees": {
      "value": 8.0,
      "currency": "BRL"
    },
    "discount": {
      "value": 0.0,
      "currency": "BRL"
    },
    "orderAmount": {
      "value": 110.0,
      "currency": "BRL"
    }
  },
  "payments": {
    "prepaid": 0.0,
    "pending": 110.0,
    "methods": [
      {
        "value": 110.0,
        "currency": "BRL",
        "type": "PENDING",
        "method": "CREDIT",
        "methodInfo": "Master Crédito",
        "brand": "MASTERCARD"
      }
    ]
  },
  "customer": {
    "id": "b66b6abb-5098-4a03-b624-b72b911e8128",
    "name": "Consumidor",
    "documentNumber": "000.000.000-00",
    "phone": {
      "number": "5511900000000"
    },
    "email": "consumidor@exemplo.com",
    "ordersCountOnMerchant": 3
  },
  "schedule": {
    "scheduledDateTimeStart": "2026-10-25T19:00:00-03:00",
    "scheduledDateTimeEnd": "2026-10-25T19:30:00-03:00"
  },
  "delivery": {
    "deliveredBy": "MERCHANT",
    "estimatedDeliveryDateTime": "2026-10-24T15:24:28-03:00",
    "deliveryAddress": {
      "country": "BR",
      "state": "SP",
      "city": "São Paulo",
      "district": "Moema",
      "street": "Rua Diamante",
      "number": "240",
      "complement": "Apto 12",
      "formattedAddress": "Rua Diamante, 240, Moema, São Paulo, SP",
      "postalCode": "04000-000",
      "coordinates": {
        "latitude": -23.6,
        "longitude": -46.66
      }
    }
  },
  "sendDelivered": true,
  "sendPreparing": true,
  "sendPickedUp": false,
  "sendTracking": true,
  "extraInfo": "Sem cebola, por favor"
}

{
  "id": "dc8d922c-eaeb-4d52-aadf-d1771365eb8b",
  "type": "TAKEOUT",
  "displayId": "AGNCYO",
  "salesChannel": "STORE",
  "createdAt": "2026-10-24T14:39:28-03:00",
  "orderTiming": "INSTANT",
  "preparationStartDateTime": "2026-10-24T14:39:28-03:00",
  "lastEvent": "CREATED",
  "merchant": {
    "id": "fc5cda2a-6391-4001-9e53-2be75049e0fd",
    "name": "Meu Delivery"
  },
  "items": [
    {
      "id": "3684f036-f738-4c44-bf04-f04a430ebc75",
      "index": 0,
      "name": "Pizza Gigante",
      "externalCode": "104",
      "unit": "UN",
      "quantity": 1,
      "unitPrice": {
        "value": 92.0,
        "currency": "BRL"
      },
      "optionsPrice": {
        "value": 10.0,
        "currency": "BRL"
      },
      "totalPrice": {
        "value": 102.0,
        "currency": "BRL"
      },
      "options": [
        {
          "id": "0296eeee-c6aa-47c7-be96-384513cd25a2",
          "index": 0,
          "name": "Marguerita",
          "externalCode": "40",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 0.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 0.0,
            "currency": "BRL"
          }
        },
        {
          "id": "1618523f-210e-4640-b91b-946cab227ecb",
          "index": 1,
          "name": "Portuguesa",
          "externalCode": "51",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 0.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 0.0,
            "currency": "BRL"
          }
        },
        {
          "id": "25dce2bb-1fcf-4834-9c07-26a63928ae33",
          "index": 2,
          "name": "Borda Doce de Leite",
          "externalCode": "67",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 10.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 10.0,
            "currency": "BRL"
          }
        }
      ]
    }
  ],
  "total": {
    "itemsPrice": {
      "value": 102.0,
      "currency": "BRL"
    },
    "otherFees": {
      "value": 0.0,
      "currency": "BRL"
    },
    "discount": {
      "value": 0.0,
      "currency": "BRL"
    },
    "orderAmount": {
      "value": 102.0,
      "currency": "BRL"
    }
  },
  "payments": {
    "prepaid": 0.0,
    "pending": 102.0,
    "methods": [
      {
        "value": 102.0,
        "currency": "BRL",
        "type": "PENDING",
        "method": "PIX"
      }
    ]
  },
  "customer": {
    "id": "b66b6abb-5098-4a03-b624-b72b911e8128",
    "name": "Consumidor",
    "documentNumber": "000.000.000-00",
    "phone": {
      "number": "5511900000000"
    },
    "email": "consumidor@exemplo.com",
    "ordersCountOnMerchant": 3
  },
  "takeout": {
    "mode": "DEFAULT",
    "takeoutDateTime": "2026-10-24T15:09:28-03:00"
  },
  "sendDelivered": true,
  "sendPreparing": true,
  "sendPickedUp": true,
  "sendTracking": true
}

{
  "id": "dc8d922c-eaeb-4d52-aadf-d1771365eb8b",
  "type": "TAKEOUT",
  "displayId": "AGNCYO",
  "salesChannel": "STORE",
  "createdAt": "2026-10-24T14:39:28-03:00",
  "orderTiming": "SCHEDULED",
  "preparationStartDateTime": "2026-10-24T14:39:28-03:00",
  "lastEvent": "CREATED",
  "merchant": {
    "id": "fc5cda2a-6391-4001-9e53-2be75049e0fd",
    "name": "Meu Delivery"
  },
  "items": [
    {
      "id": "3684f036-f738-4c44-bf04-f04a430ebc75",
      "index": 0,
      "name": "Pizza Gigante",
      "externalCode": "104",
      "unit": "UN",
      "quantity": 1,
      "unitPrice": {
        "value": 92.0,
        "currency": "BRL"
      },
      "optionsPrice": {
        "value": 10.0,
        "currency": "BRL"
      },
      "totalPrice": {
        "value": 102.0,
        "currency": "BRL"
      },
      "options": [
        {
          "id": "0296eeee-c6aa-47c7-be96-384513cd25a2",
          "index": 0,
          "name": "Marguerita",
          "externalCode": "40",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 0.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 0.0,
            "currency": "BRL"
          }
        },
        {
          "id": "1618523f-210e-4640-b91b-946cab227ecb",
          "index": 1,
          "name": "Portuguesa",
          "externalCode": "51",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 0.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 0.0,
            "currency": "BRL"
          }
        },
        {
          "id": "25dce2bb-1fcf-4834-9c07-26a63928ae33",
          "index": 2,
          "name": "Borda Doce de Leite",
          "externalCode": "67",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 10.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 10.0,
            "currency": "BRL"
          }
        }
      ]
    }
  ],
  "total": {
    "itemsPrice": {
      "value": 102.0,
      "currency": "BRL"
    },
    "otherFees": {
      "value": 0.0,
      "currency": "BRL"
    },
    "discount": {
      "value": 0.0,
      "currency": "BRL"
    },
    "orderAmount": {
      "value": 102.0,
      "currency": "BRL"
    }
  },
  "payments": {
    "prepaid": 0.0,
    "pending": 102.0,
    "methods": [
      {
        "value": 102.0,
        "currency": "BRL",
        "type": "PENDING",
        "method": "PIX"
      }
    ]
  },
  "customer": {
    "id": "b66b6abb-5098-4a03-b624-b72b911e8128",
    "name": "Consumidor",
    "documentNumber": "000.000.000-00",
    "phone": {
      "number": "5511900000000"
    },
    "email": "consumidor@exemplo.com",
    "ordersCountOnMerchant": 3
  },
  "schedule": {
    "scheduledDateTimeStart": "2026-10-25T19:00:00-03:00",
    "scheduledDateTimeEnd": "2026-10-25T19:30:00-03:00"
  },
  "takeout": {
    "mode": "DEFAULT",
    "takeoutDateTime": "2026-10-24T15:09:28-03:00"
  },
  "sendDelivered": true,
  "sendPreparing": true,
  "sendPickedUp": true,
  "sendTracking": true
}

{
  "id": "dc8d922c-eaeb-4d52-aadf-d1771365eb8b",
  "type": "INDOOR",
  "displayId": "AGNCYO",
  "salesChannel": "TAB",
  "createdAt": "2026-10-24T14:39:28-03:00",
  "orderTiming": "INSTANT",
  "preparationStartDateTime": "2026-10-24T14:39:28-03:00",
  "lastEvent": "CREATED",
  "merchant": {
    "id": "fc5cda2a-6391-4001-9e53-2be75049e0fd",
    "name": "Meu Delivery"
  },
  "items": [
    {
      "id": "3684f036-f738-4c44-bf04-f04a430ebc75",
      "index": 0,
      "name": "Pizza Gigante",
      "externalCode": "104",
      "unit": "UN",
      "quantity": 1,
      "unitPrice": {
        "value": 92.0,
        "currency": "BRL"
      },
      "optionsPrice": {
        "value": 10.0,
        "currency": "BRL"
      },
      "totalPrice": {
        "value": 102.0,
        "currency": "BRL"
      },
      "options": [
        {
          "id": "0296eeee-c6aa-47c7-be96-384513cd25a2",
          "index": 0,
          "name": "Marguerita",
          "externalCode": "40",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 0.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 0.0,
            "currency": "BRL"
          }
        },
        {
          "id": "1618523f-210e-4640-b91b-946cab227ecb",
          "index": 1,
          "name": "Portuguesa",
          "externalCode": "51",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 0.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 0.0,
            "currency": "BRL"
          }
        },
        {
          "id": "25dce2bb-1fcf-4834-9c07-26a63928ae33",
          "index": 2,
          "name": "Borda Doce de Leite",
          "externalCode": "67",
          "unit": "UN",
          "quantity": 1,
          "unitPrice": {
            "value": 10.0,
            "currency": "BRL"
          },
          "totalPrice": {
            "value": 10.0,
            "currency": "BRL"
          }
        }
      ]
    }
  ],
  "total": {
    "itemsPrice": {
      "value": 102.0,
      "currency": "BRL"
    },
    "otherFees": {
      "value": 0.0,
      "currency": "BRL"
    },
    "discount": {
      "value": 0.0,
      "currency": "BRL"
    },
    "orderAmount": {
      "value": 102.0,
      "currency": "BRL"
    }
  },
  "payments": {
    "prepaid": 0.0,
    "pending": 102.0,
    "methods": [
      {
        "value": 102.0,
        "currency": "BRL",
        "type": "PENDING",
        "method": "OTHER"
      }
    ]
  },
  "indoor": {
    "mode": "TAB",
    "indoorDateTime": "2026-10-24T14:59:28-03:00",
    "tab": "SA51LWb3wCZWCHHgpVRnRZwu",
    "tabId": "fd7ea0c8-143b-4949-8182-a94c07d0d9c3",
    "tabCode": "SA51LWb3wCZWCHHgpVRnRZwu",
    "tabName": "0001"
  },
  "sendDelivered": true,
  "sendPreparing": true,
  "sendPickedUp": false,
  "sendTracking": true
}

Visão geral

Pedidos

Catálogo

Indoor

Descontos

Ferramentas

Referência

Requisição

O que tem num pedido

Identificação

Itens

Valores

Pagamento

Cliente

Entrega e retirada

Campos do pedido

Identificação

Itens

Valores

Pagamento

Cliente

Entrega, retirada e indoor

O que o seu sistema deve informar

Exemplos

Próximos passos

Ações de pedidos

Listar pedidos

​Requisição

​O que tem num pedido

Identificação

Itens

Valores

Pagamento

Cliente

Entrega e retirada

​Campos do pedido

​Identificação

​Itens

​Valores

​Pagamento

​Cliente

​Entrega, retirada e indoor

​O que o seu sistema deve informar

​Exemplos

​Próximos passos

Ações de pedidos

Listar pedidos

Requisição

O que tem num pedido

Campos do pedido

Identificação

Itens

Valores

Pagamento

Cliente

Entrega, retirada e indoor

O que o seu sistema deve informar

Exemplos

Próximos passos