Pular para o conteúdo principal
GET
/
api
/
partner
/
v1
/
orders
/
{order_id}
{
  "id": 123,
  "display_id": 123,
  "external_display_id": "<string>",
  "external_order_id": "<string>",
  "external_merchant_id": "<string>",
  "external_merchant_name": "<string>",
  "merchant_id": 123,
  "customer_origin": "insta",
  "table_number": "<string>",
  "estimated_time": 123,
  "cancellation_reason": "<string>",
  "fiscal_document": "70887267009",
  "observation": "<string>",
  "delivery_fee": 0,
  "service_fee": 0,
  "additional_fee": 0,
  "total": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "schedule": {
    "scheduled_date_time_start": "2023-06-27T07:40:00-04:00",
    "scheduled_date_time_end": "2023-06-27T07:50:00-04:00"
  },
  "user": {
    "id": 123,
    "name": "<string>"
  },
  "customer": {
    "id": 123,
    "name": "<string>",
    "phone": "11998765432",
    "ddi": "55"
  },
  "delivery_address": {
    "street": "<string>",
    "number": "<string>",
    "address_block": "<string>",
    "address_lot": "<string>",
    "neighborhood": "<string>",
    "complement": "Bloco K, Apto 100",
    "reference": "Ao lado do posto de saúde.",
    "postal_code": "49042143",
    "city": "<string>",
    "state": "RJ",
    "latitude": "-10.2627",
    "longitude": "-48.3997"
  },
  "items": [
    {
      "item_id": 123,
      "order_item_id": 123,
      "external_code": "<string>",
      "name": "<string>",
      "quantity": 1,
      "unit_price": 1,
      "total_price": 1,
      "status": "<string>",
      "observation": "Retirar cebola.",
      "options": [
        {
          "option_id": 123,
          "external_code": "<string>",
          "name": "<string>",
          "quantity": 1,
          "unit_price": 1,
          "option_group_id": 123,
          "option_group_name": "<string>",
          "option_group_total_selected_options": 123
        }
      ],
      "user": {
        "id": "<string>",
        "name": "<string>"
      }
    }
  ],
  "discounts": [
    {
      "total": 1,
      "total_points": 0,
      "coupon_id": 123,
      "coupon_name": "<string>",
      "coupon_code": "<string>",
      "item_id": 123,
      "item_name": "<string>"
    }
  ],
  "payments": [
    {
      "total": 1,
      "payment_fee": 0,
      "change_for": 1,
      "status": "pending",
      "card_brand": "<string>",
      "card_number": "<string>",
      "observation": "<string>"
    }
  ]
}

Autorizações

​
X-API-KEY
string
header
obrigatório

Token específico do estabelecimento integrado. Disponível na seção de integrações do Portal do estabelecimento.

Parâmetros de caminho

​
order_id
string
obrigatório

ID do pedido

Resposta

Retorna o pedido desejado.

Para obter mais detalhes sobre a estrutura de um pedido, consulte nossa seção exclusiva sobre o assunto.

Estrutura de um pedido

​
id
integer

Identificador exclusivo do pedido.

​
display_id
integer

Número mais amigável para identificação do pedido. Ele não é exclusivo.

​
external_display_id
string | null

Número mais amigável para identificação de pedidos de marketplaces. Ele não é exclusivo.

​
external_order_id
string | null

Identificador exclusivo do pedido no marketplace.

​
external_merchant_id
string | null

Identificador exclusivo da loja no marketplace.

​
external_merchant_name
string | null

Nome da loja no marketplace.

​
merchant_id
integer

Identificador exclusivo do estabelecimento ao qual o pedido pertence.

​
status
enum<string>

Status do pedido.

  • waiting_confirmation: pedido pendente.
  • pending_payment: pedido de balcão com pagamento pendente. Disponível apenas se sales_channel for store_front_catalog.
  • pending_online_payment: pedido aguardando confirmação de um pagamento online. Usado no caso de pedidos com pagamento por pix automático.
  • scheduled_confirmed: pedido agendado confirmado. Disponível apenas se order_timing for scheduled.
  • confirmed: pedido confirmado e em preparação.
  • ready: pedido pronto, mas ainda não está disponível para retirada e nem saiu para entrega.
  • released: pedido saiu para entrega. Disponível apenas se order_type for delivery.
  • waiting_to_catch: pedido pronto e esperando retirada. Disponível apenas se order_type for takeout ou onsite.
  • delivered: pedido entregue. Disponível apenas se order_type for delivery.
  • canceling: pedido em processo de cancelamento. Uma vez nesse status o pedido irá para o status canceled ou então voltará para o status anterior. Usado no caso de pedidos com pagamento por cartão de crédito online.
  • canceled: pedido cancelado.
  • closed: pedido finalizado.
Opções disponíveis:
waiting_confirmation,
pending_payment,
pending_online_payment,
scheduled_confirmed,
confirmed,
ready,
released,
waiting_to_catch,
delivered,
canceling,
canceled,
closed
​
order_type
enum<string>

Tipo de pedido.

  • delivery: pedido de delivery.
  • takeout: pedido de retirada.
  • onsite: pedido de consumo no local.
  • closed_table: pedido de mesa ou comanda.
Opções disponíveis:
delivery,
takeout,
onsite,
closed_table
​
order_timing
enum<string>

Momento de entrega do pedido.

  • immediate: pedido deve ser preparado o mais breve possível.
  • scheduled: pedido deve ficar pronto apenas na data agendada, que é enviada no campo schedule.
Opções disponíveis:
immediate,
scheduled
​
sales_channel
enum<string>

Indica por qual canal o pedido foi feito.

  • catalog: cardápio digital padrão (delivery e retirada).
  • store_front_catalog: cardápio digital de balcão (apenas retirada).
  • portal: portal de gestão.
  • whatsapp_extension: extensão do Google Chrome para WhatsApp.
  • ifood: pedidos recebidos através da integração com o iFood.
Opções disponíveis:
catalog,
store_front_catalog,
portal,
whatsapp_extension,
ifood
​
customer_origin
string | null

Campo livre que permite identificar de forma personalizada a origem do pedido por meio de diferentes versões do link do cardápio digital. Essa funcionalidade possibilita, por exemplo, identificar pedidos feitos através do link divulgado no Instagram, no Facebook, no WhatsApp, em uma propagando paga, através de algum influencer, etc.

Exemplo:

"insta"

​
delivered_by
enum<string>

Indica o responsável pela entrega dos pedidos iFood:

  • merchant: Estabelecimento.
  • ifood: iFood.
  • ifood_shipping: iFood Sob Demanda.
  • foody_delivery: Foody Delivery.
  • food99: 99Food.
  • keeta: Keeta.
  • aiqfome: Aiqfome.

Será null se o order_type não for delivery.

Opções disponíveis:
merchant,
ifood,
ifood_shipping,
foody_delivery,
food99,
keeta,
aiqfome
​
table_number
string | null

Número da mesa ou comanda associada ao pedido. Disponível apenas para pedidos de mesa ou comanda (order_type deve ser closed_table).

​
estimated_time
integer | null

Previsão de entrega do pedido em minutos a partir da data de criação.

​
cancellation_reason
string | null

Motivo do cancelamento. Preenchido apenas para pedidos cancelados, podendo ser nulo se nenhum motivo for informado.

​
fiscal_document
string | null

CPF ou CNPJ para ser utilizado na emissão de cupom fiscal, sem formatação.

Exemplo:

"70887267009"

​
observation
string | null

Observações gerais sobre o pedido.

​
delivery_fee
number
padrão:0

Taxa de entrega. Disponível apenas se order_type for delivery.

Intervalo obrigatório: x >= 0
​
service_fee
number
padrão:0

Taxa de serviço (R$). Disponível apenas se order_type for closed_table.

Intervalo obrigatório: x >= 0
​
additional_fee
number
padrão:0

Taxa adicional (R$). Campo livre para o estabelecimento cobrar um valor adicional.

Intervalo obrigatório: x >= 0
​
total
number

Valor total do pedido. É possível ter pedidos com o valor total zerado.

total = sum(items.total_price)
 + delivery_fee 
 + service_fee 
 + additional_fee 
 + sum(payments.payment_fee) 
 - sum(discounts.total)
Intervalo obrigatório: x >= 0
​
created_at
string<date-time>

Data e hora em que o pedido foi criado.

​
updated_at
string<date-time>

Data e hora da última vez que o pedido foi modificado.

​
schedule
object

Informações sobre a data de agendamento do pedido. Disponível apenas para pedidos agendados (order_timing deve ser scheduled).

​
user
object

Informações do usuário responsável pelo pedido. Por enquanto, disponível apenas para pedidos de mesas/comandas.

​
customer
object

Informações sobre o cliente que fez o pedido. Pedidos feitos pelo Portal (sales_channel igual a portal) ou pela Extensão para WhatsApp (sales_channel igual a whatsapp_extension) podem não ter um cliente.

​
delivery_address
object

Endereço onde o pedido deve ser entregue. Disponível apenas para pedidos de delivery (order_type deve ser delivery).

​
items
object[]

Itens do pedido.

​
discounts
object[]

Descontos aplicados ao pedido.

​
payments
object[]

Informações de pagamento do pedido.

Última modificação em 27 de junho de 2026