Buscar na documentação

Módulos

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Soluções

Logistics

Estrutura do pedido

Use GET logistics/orders/{id} para obter detalhes completos do pedido.Um pedido contém:

Informações gerais: ID, tipo, data de criação
Merchant: Dados da loja
Customer: Dados do cliente
Items: Quantidade e peso dos produtos
Payments: Formas e valores de pagamento
Delivery: Endereço e método de entrega
Schedule: Horário agendado (quando aplicável)

Referência de campos

Informações gerais

Campo	Tipo	Descrição
id	uuid	Identificador único do pedido
displayId	string	ID amigável para exibir na interface da loja
orderType	enum	Tipo de pedido: `DELIVERY` ou `TAKEOUT`
orderTiming	enum	Momento da entrega: `IMMEDIATE` ou `SCHEDULED`
createdAt	date	Data e hora de criação do pedido
isTest	boolean	Indica se é pedido de teste

Exemplo:

{
  "id": "32c15e00-9861-4548-b5f0-15580defc999",
  "displayId": "fc999",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "isTest": false
}

merchant

Campo	Tipo	Descrição
id	uuid	Identificador único da loja
name	string	Nome da loja

Exemplo:

{
  "merchant": {
    "id": "50647eee-5eb6-41a2-b2d8-999998ed677f",
    "name": "Nome da Loja"
  }
}

merchant.merchantAddress

Campo	Tipo	Descrição
country	string	Código do país
state	string	Estado
city	string	Cidade
district	string	Bairro
street	string	Rua
number	string	Número
postalCode	string	CEP
latitude	number	Coordenada latitude
longitude	number	Coordenada longitude

Exemplo:

{
  "merchantAddress": {
    "country": "BR",
    "state": "AC",
    "city": "Bujari",
    "district": "Bujari",
    "street": "Ramal Bujari",
    "number": "122",
    "postalCode": "12345678",
    "latitude": -9.822384,
    "longitude": -67.948589
  }
}

customer

Campo	Tipo	Descrição
id	uuid	Identificador único do cliente
name	string	Nome do cliente
phone.number	string	Telefone do cliente ou 0800 do iFood
phone.localizer	string	Código localizador para usar ao ligar para o 0800
phone.localizerExpiration	date	Data de expiração do localizador

Campo phone é opcionalO campo phone expira 3 horas após a data de entrega do pedido.

Exemplo:

{
  "customer": {
    "name": "Murilo Gontijo",
    "phone": {
      "number": "0800 705 3040",
      "localizer": "75159000",
      "localizerExpiration": "2024-01-09T00:44:42.547Z"
    }
  }
}

items

Campo	Tipo	Descrição
index	integer	Posição do item na lista
quantity	integer	Quantidade
weight.unit	string	Unidade: `GRAMS` ou `LITERS`
weight.value	number	Valor do peso

Exemplo:

"items": [
  {
    "index": 1,
    "quantity": 1,
    "weight": {
      "unit": "GRAMS",
      "value": 750
    }
  },
  {
    "index": 2,
    "quantity": 1,
    "weight": {
      "unit": "LITERS",
      "value": 2
    }
  }
]

payments

Campo	Tipo	Descrição
prepaid	double	Valor já pago (online)
pending	double	Valor a cobrar na entrega
methods.value	double	Valor do pagamento
methods.currency	string	Moeda (ex: `BRL`)
methods.method	enum	Método: `CASH`, `CREDIT`, `DEBIT`, `MEAL_VOUCHER`, `FOOD_VOUCHER`, `GIFT_CARD`, `DIGITAL_WALLET`, `PIX`, `OTHER`
methods.type	string	Tipo: `ONLINE` ou `OFFLINE`
methods.prepaid	boolean	Indica se já foi pago
methods.cash.changeFor	double	Valor para troco (quando pagamento em dinheiro)

Exemplo:

"payments": {
  "prepaid": 0,
  "pending": 103.99,
  "methods": [
    {
      "value": 103.99,
      "currency": "BRL",
      "method": "CASH",
      "prepaid": false,
      "type": "OFFLINE",
      "cash": {
        "changeFor": 150
      }
    }
  ]
}

delivery

Campo	Tipo	Descrição
mode	enum	Modo de entrega: `DEFAULT` (padrão) ou `EXPRESS`
deliveredBy	enum	Responsável: `MERCHANT` (entrega própria)
deliveryDateTime	date	Data e hora estimada da entrega
observations	string	Observações do cliente sobre a entrega
deliveryAddress	object	Endereço de entrega

Exemplo:

"delivery": {
  "mode": "DEFAULT",
  "deliveredBy": "MERCHANT",
  "deliveryDateTime": "2020-01-01T00:00:00.000Z",
  "observations": "Deixar na portaria",
  "deliveryAddress": {...}
}

deliveryAddress

Campo	Tipo	Descrição
streetName	string	Nome da rua
streetNumber	string	Número (pode conter letras)
formattedAddress	string	Endereço formatado completo
neighborhood	string	Bairro
complement	string	Complemento (apartamento, bloco, etc)
reference	string	Ponto de referência
postalCode	string	CEP (opcional, pode vir zerado)
city	string	Cidade
state	string	Estado
country	string	País
coordinates.latitude	double	Coordenada latitude
coordinates.longitude	double	Coordenada longitude

Exemplo:

"deliveryAddress": {
  "streetName": "RUA X",
  "streetNumber": "20A",
  "formattedAddress": "RUA X, 20A",
  "neighborhood": "Bairro",
  "complement": "Apto 101",
  "reference": "Perto da praça",
  "postalCode": "99999999",
  "city": "SAO PAULO",
  "state": "SP",
  "country": "BR",
  "coordinates": {
    "latitude": -26.999999,
    "longitude": -48.999999
  }
}

schedule

Presente apenas em pedidos agendados (orderTiming: SCHEDULED).

Campo	Tipo	Descrição
deliveryDateTimeStart	date	Início da janela de entrega
deliveryDateTimeEnd	date	Fim da janela de entrega

Exemplo:

"schedule": {
  "deliveryDateTimeStart": "2020-01-01T00:20:00.000Z",
  "deliveryDateTimeEnd": "2020-01-01T01:20:00.000Z"
}

Exemplos de cenários

1. Entrega imediata com pagamento offline (cartão de crédito)

{
  "id": "4934a1e8-2071-4ac7-9ff6-6e634bb6008d",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "displayId": "9843",
  "createdAt": "2024-03-20T14:33:08.052Z",
  "isTest": true,
  "merchant": {
    "id": "b0954b6b-f99c-44b6-ba1e-987f32b2b22a",
    "name": "Teste - murilogontijo",
    "merchantAddress": {
      "country": "BR",
      "state": "AC",
      "city": "Bujari",
      "district": "Bujari",
      "street": "Ramal Bujari",
      "number": "122",
      "postalCode": "12345678",
      "latitude": -9.822384,
      "longitude": -67.948589
    }
  },
  "customer": {
    "name": "PEDIDO DE TESTE - Murilo Gontijo",
    "phone": {
      "number": "0800 705 4050",
      "localizer": "89121704",
      "localizerExpiration": "2024-03-20T18:33:08.052Z"
    }
  },
  "items": [
    {
      "index": 1,
      "quantity": 3,
      "weight": {
        "unit": "GRAMS",
        "value": 2250
      }
    },
    {
      "index": 2,
      "quantity": 1,
      "weight": {
        "unit": "GRAMS",
        "value": 200
      }
    }
  ],
  "payments": {
    "prepaid": 0,
    "pending": 323.99,
    "methods": [
      {
        "value": 323.99,
        "currency": "BRL",
        "method": "CREDIT",
        "prepaid": false,
        "type": "OFFLINE"
      }
    ]
  },
  "delivery": {
    "mode": "DEFAULT",
    "deliveredBy": "MERCHANT",
    "deliveryDateTime": "2024-04-01T15:18:04.801Z",
    "observations": "PEDIDO DE TESTE! NÃO ENTREGAR",
    "deliveryAddress": {
      "streetName": "Rua TESTE",
      "streetNumber": "999999",
      "formattedAddress": "Rua TESTE, 999999",
      "neighborhood": "Bairro TESTE",
      "complement": "Complemento TESTE",
      "postalCode": "99999999",
      "city": "TESTE",
      "state": "XX",
      "country": "XX",
      "reference": "TESTE",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    }
  }
}

2. Entrega imediata com pagamento online (já pago)

{
  "id": "63ec432e-4f0d-4097-b4fe-11bc2dac14af",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "displayId": "1728",
  "createdAt": "2024-04-01T15:18:04.801Z",
  "isTest": true,
  "merchant": {
    "id": "b0954b6b-f99c-44b6-ba1e-987f32b2b22a",
    "name": "Teste - murilogontijo",
    "merchantAddress": {
      "country": "BR",
      "state": "AC",
      "city": "Bujari",
      "district": "Bujari",
      "street": "Ramal Bujari",
      "number": "0",
      "postalCode": "12345678",
      "latitude": -9.822384,
      "longitude": -67.948589
    }
  },
  "customer": {
    "name": "PEDIDO DE TESTE - Murilo Gontijo",
    "phone": {
      "number": "0800 705 4050",
      "localizer": "83984177",
      "localizerExpiration": "2024-04-01T19:18:04.801Z"
    }
  },
  "items": [
    {
      "index": 1,
      "quantity": 1
    },
    {
      "index": 2,
      "quantity": 1
    }
  ],
  "delivery": {
    "mode": "DEFAULT",
    "deliveredBy": "MERCHANT",
    "deliveryDateTime": "2024-04-01T15:18:04.801Z",
    "observations": "PEDIDO DE TESTE! NÃO ENTREGAR",
    "deliveryAddress": {
      "streetName": "Rua TESTE",
      "streetNumber": "999999",
      "formattedAddress": "Rua TESTE, 999999",
      "neighborhood": "Bairro TESTE",
      "complement": "Complemento TESTE",
      "postalCode": "99999999",
      "city": "TESTE",
      "state": "XX",
      "country": "XX",
      "reference": "TESTE",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    }
  }
}

3. Entrega agendada com pagamento em dinheiro (com troco)

{
  "id": "5076514a-2ad1-49fe-b38c-e849b4cbeaab",
  "orderType": "DELIVERY",
  "orderTiming": "SCHEDULED",
  "displayId": "9305",
  "createdAt": "2024-01-08T20:44:42.547Z",
  "isTest": false,
  "schedule": {
    "deliveryDateTimeStart": "2024-01-16T18:00:00.000Z",
    "deliveryDateTimeEnd": "2024-01-16T18:30:00.000Z"
  },
  "merchant": {
    "id": "b0954b6b-f99c-44b6-ba1e-987f32b2b22a",
    "name": "Teste - murilogontijo",
    "merchantAddress": {
      "country": "BR",
      "state": "AC",
      "city": "Bujari",
      "district": "Bujari",
      "street": "Ramal Bujari",
      "number": "122",
      "postalCode": "12345678",
      "latitude": -9.822384,
      "longitude": -67.948589
    }
  },
  "customer": {
    "name": "PEDIDO DE TESTE - Murilo Gontijo",
    "phone": {
      "number": "0800 705 3040",
      "localizer": "75159000",
      "localizerExpiration": "2024-01-09T00:44:42.547Z"
    }
  },
  "items": [
    {
      "index": 1,
      "quantity": 1,
      "weight": {
        "unit": "GRAMS",
        "value": 750
      }
    },
    {
      "index": 2,
      "quantity": 1,
      "weight": {
        "unit": "LITERS",
        "value": 2
      }
    }
  ],
  "payments": {
    "prepaid": 0,
    "pending": 103.99,
    "methods": [
      {
        "value": 103.99,
        "currency": "BRL",
        "method": "CASH",
        "prepaid": false,
        "type": "OFFLINE",
        "cash": {
          "changeFor": 150
        }
      }
    ]
  },
  "delivery": {
    "mode": "DEFAULT",
    "deliveredBy": "MERCHANT",
    "deliveryDateTime": "2024-01-08T22:14:42.547Z",
    "observations": "PEDIDO DE TESTE! NÃO ENTREGAR",
    "deliveryAddress": {
      "streetName": "Rua TESTE",
      "streetNumber": "999999",
      "formattedAddress": "Rua TESTE, 999999",
      "neighborhood": "Bairro TESTE",
      "complement": "Complemento TESTE",
      "postalCode": "99999999",
      "city": "TESTE",
      "state": "XX",
      "country": "XX",
      "reference": "TESTE",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    }
  }
}

Esta página foi útil?

Avalie sua experiência no novo Developer portal:

Nesta página

merchant.merchantAddress

1. Entrega imediata com pagamento offline (cartão de crédito)

2. Entrega imediata com pagamento online (já pago)

3. Entrega agendada com pagamento em dinheiro (com troco)

Conteúdo lido0%