> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Documentação das APIs da DeliveryVip, em português. Regras que mais quebram integrações: (1) Merchant API: faça polling em GET /merchant/v3/events:polling no máximo a cada 30 s por token; confirme todo evento recebido com POST /merchant/v3/events/acknowledgment e corpo [{"id": "<eventId>"}] (o campo lido é id, não eventId), inclusive eventos repetidos ou que o sistema não trata; deduplique por eventId; o evento é só um aviso, busque o pedido na orderURL. (2) Tokens client_credentials valem 24 h e não têm refresh_token: peça outro ao receber 401. (3) Webhooks: valide a assinatura HMAC sobre o corpo bruto e responda 2xx rápido; o polling é a reconciliação. (4) Open Delivery: host od.deliveryvip.com.br, um client_secret por loja, datas em UTC. (5) Fidelidade: o operador implementa 5 rotas assinadas com HMAC e chama o config push; o estorno precisa ser idempotente. (6) Partner API: scope dv.partner. Não invente endpoints: use a referência gerada das specs OpenAPI.

# Obter detalhes do pedido

> Busque itens, cliente, entrega, pagamento e totais de um pedido e entenda cada campo da resposta.

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

```bash cURL theme={null}
curl 'https://api.deliveryvip.com.br/merchant/v3/orders/{orderId}' \
  --header 'Authorization: Bearer {token}'
```

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

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

**orderId** `uuid` *required*

O `orderId` do evento.

**views\[]** `string`

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

```text theme={null}
/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. |

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

## O que tem num pedido

> [card] [Identificação](#identificação)
>
> `id`, `type`, `displayId`, `orderTiming`, `lastEvent`

> [card] [Itens](#itens)
>
> Produtos, opções e preços

> [card] [Valores](#valores)
>
> Taxas, descontos e total

> [card] [Pagamento](#pagamento)
>
> Valores pagos, a pagar e formas

> [card] [Cliente](#cliente)
>
> Nome, documento e contato

> [card] [Entrega e retirada](#entrega-retirada-e-indoor)
>
> `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

**id** `uuid` *required*

Identificador do pedido.

**type** `string` *required*

`DELIVERY`, `TAKEOUT` ou `INDOOR`. Veja [tipos de pedido](/docs/guides/merchant/order/definicoes.md#tipos-de-pedido).

**displayId** `string` *required*

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

**salesChannel** `string` *required*

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

**orderTiming** `string` *required*

`INSTANT` ou `SCHEDULED`. Pedidos agendados trazem o bloco [`schedule`](#entrega-retirada-e-indoor).

**createdAt** `datetime` *required*

Quando o pedido foi criado.

**preparationStartDateTime** `datetime` *required*

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

**lastEvent** `string`

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

**merchant** `object` *required*

A loja do pedido.

**propriedades**

**id** `string` *required*

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

**name** `string` *required*

Nome da loja.

**extraInfo** `string`

Observação do cliente sobre o pedido.

### Itens

**items** `object[]` *required*

Produtos do pedido.

**propriedades**

**id** `uuid` *required*

Identificador do item no pedido.

**index** `integer` *required*

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

**name** `string` *required*

Nome do produto.

**externalCode** `string`

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

**ean** `string`

Código de barras do produto.

**unit** `string` *required*

Unidade de medida. Hoje sempre `UN`.

**quantity** `integer` *required*

Quantidade.

**specialInstructions** `string`

Observação do cliente sobre o item.

**unitPrice** `object` *required*

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

**optionsPrice** `object`

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

**totalPrice** `object` *required*

`(unitPrice + optionsPrice) × quantity`.

**options** `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`.

**propriedades**

**id** `uuid` *required*

Identificador da opção no pedido.

**index** `integer` *required*

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

**name** `string` *required*

Nome da opção.

**externalCode** `string`

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

**unit** `string` *required*

Hoje sempre `UN`.

**quantity** `integer` *required*

Quantidade da opção.

**unitPrice** `object` *required*

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

**totalPrice** `object` *required*

`unitPrice × quantity`.

**optionGroups** `object[]`

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

**propriedades**

**id** `uuid` *required*

Identificador do grupo no pedido.

**name** `string` *required*

Nome do grupo, como "Sabores" ou "Bordas".

**externalCode** `string`

Código do grupo no seu sistema.

**totalPrice** `object` *required*

Soma das opções do grupo.

**options** `object[]` *required*

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

> [accordion] Exemplo de item com optionGroups
>
> ```json theme={null}
> "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

**otherFees** `object[]`

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

**propriedades**

**name** `string` *required*

Nome da taxa. Hoje igual ao `type`.

**type** `string` *required*

`DELIVERY_FEE`, `SERVICE_FEE`, `TIP` ou `MIN_ORDER_FEE`.

**receivedBy** `string` *required*

Quem recebe a taxa: `MERCHANT`, `MARKETPLACE` ou `LOGISTIC_SERVICES`.

**receiverDocument** `string`

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

**price** `object` *required*

Valor da taxa.

**discounts** `object[]`

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

**propriedades**

**target** `string` *required*

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

**amount** `object` *required*

Valor do desconto.

**sponsorshipValues** `object[]` *required*

Quem paga o desconto.

**propriedades**

**name** `string` *required*

`MERCHANT` ou `MARKETPLACE`.

**discountCode** `string`

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

**amount** `object` *required*

Parte do desconto paga por esse patrocinador.

**total** `object` *required*

Resumo dos valores.

**propriedades**

**itemsPrice** `object` *required*

Soma dos itens.

**otherFees** `object` *required*

Soma das taxas.

**discount** `object` *required*

Soma dos descontos.

**orderAmount** `object` *required*

Total do pedido: `itemsPrice + otherFees - discount`.

**loyalty** `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](/docs/guides/merchant/loyalty/acumulo.md).

### Pagamento

**payments** `object` *required*

**propriedades**

**prepaid** `number` *required*

Valor já pago online pelo cliente.

**pending** `number` *required*

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

**methods** `object[]` *required*

Formas de pagamento.

**propriedades**

**value** `number` *required*

Valor pago nessa forma.

**currency** `string` *required*

`BRL`.

**type** `string` *required*

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

**method** `string` *required*

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

**methodInfo** `string`

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

**brand** `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`.

**changeFor** `number`

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

### Cliente

**customer** `object`

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

**propriedades**

**id** `uuid` *required*

Identificador do cliente.

**name** `string` *required*

Nome.

**documentNumber** `string`

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

**phone** `object`

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

**email** `string`

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

**ordersCountOnMerchant** `integer` *required*

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

**delivery** `object`

Só em pedidos `DELIVERY`.

**propriedades**

**deliveredBy** `string` *required*

Hoje sempre `MERCHANT`: a loja faz a entrega.

**estimatedDeliveryDateTime** `datetime`

Previsão de entrega.

**deliveryAddress** `object` *required*

Endereço de entrega.

**propriedades**

**country** `string`

Sigla do país, como `BR`.

**state** `string`

Sigla do estado, como `SP`.

**city** `string`

Cidade.

**district** `string`

Bairro.

**street** `string`

Rua.

**number** `string`

Número.

**complement** `string`

Complemento, quando informado.

**reference** `string`

Ponto de referência, quando informado.

**postalCode** `string`

CEP.

**formattedAddress** `string`

Endereço completo em uma linha.

**coordinates** `object`

`latitude` e `longitude` do endereço.

**takeout** `object`

Só em pedidos `TAKEOUT`.

**propriedades**

**mode** `string` *required*

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

**takeoutDateTime** `datetime`

Previsão de retirada.

**indoor** `object`

Só em pedidos `INDOOR`.

**propriedades**

**mode** `string` *required*

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

**indoorDateTime** `datetime`

Previsão de o pedido ficar pronto.

**place** `string`

Nome do local de entrega, como "Mesa 10". Mesmo valor de `placeName`.

**placeName** `string`

Nome do local de entrega.

**placeId** `string`

Identificador do local de entrega.

**tab** `string`

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

**tabId** `uuid`

Identificador da comanda. Só no modo `TAB`.

**tabCode** `string`

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

**tabName** `string`

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

**schedule** `object`

Só quando `orderTiming` é `SCHEDULED`.

**propriedades**

**scheduledDateTimeStart** `datetime` *required*

Início da janela agendada.

**scheduledDateTimeEnd** `datetime` *required*

Fim da janela agendada.

### O que o seu sistema deve informar

Estes campos dizem quais [ações](/docs/guides/merchant/order/fluxo-de-integracao/acoes-de-pedidos.md) a DeliveryVip espera do seu sistema neste pedido.

**sendPreparing** `boolean` *required*

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

**sendDelivered** `boolean` *required*

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

**sendPickedUp** `boolean` *required*

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

**sendTracking** `boolean` *required*

`true` quando o seu sistema pode enviar dados de [rastreio](/docs/guides/merchant/order/fluxo-de-integracao/acoes-de-pedidos.md#tracking).

## Exemplos

> [tab] Delivery imediato
>
> ```json theme={null}
> {
>   "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"
> }
> ```

> [tab] Delivery agendado
>
> ```json theme={null}
> {
>   "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"
> }
> ```

> [tab] Retirada imediata
>
> ```json theme={null}
> {
>   "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
> }
> ```

> [tab] Retirada agendada
>
> ```json theme={null}
> {
>   "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
> }
> ```

> [tab] Indoor (comanda)
>
> ```json theme={null}
> {
>   "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
> }
> ```

## Próximos passos

> [card] [Ações de pedidos](/docs/guides/merchant/order/fluxo-de-integracao/acoes-de-pedidos.md)
>
> Confirme, prepare, despache e entregue o pedido.

> [card] [Listar pedidos](/docs/guides/merchant/order/listar-pedidos.md)
>
> Consulte o histórico de pedidos da loja.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.