Docs Logistics Detalhes de Pedidos

Introdução

Um pedido contém as seguintes informações:

Informações gerais - id, tipo, data de criação do pedido dentre outros.
Merchant - identificação do merchant (loja)
Customer - identificação do cliente que deve receber o pedido
Itens - quantidade e pesos
Payments - detalhes sobre as formas de pagamento
Delivery - informações sobre a forma de entrega do pedido e o endereço
Schedule - informações sobre agendamento do pedido

Através do endpoint GET logistics/orders/{id} você pode obter todos os detalhes de um pedido.

Abaixo temos a descrição e os detalhes de cada propriedade do Pedido.

Campos

Informações Gerais

Campo	Tipo	Descrição
id	uuid	Identificador único do pedido
displayId	string	Id amigável para facilitar a identificação do pedido pela loja. Deve ser exibido na interface do seu aplicativo.
orderType	enum	tipo de pedido
orderTiming	enum	momento de entrega do pedido
createdAt	date	data de criação do pedido
isTest	boolean	indica se é um pedido de teste ou não

Exemplo:

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

merchant

Campo	Tipo	Descrição
id	uuid	identificador único do merchant (loja)
name	string	nome do merchant (loja)

Exemplo:

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

merchant.merchantAddress

Campo	Tipo	Descrição
country	string	País do merchant (loja)
state	string	Estado do merchant (loja)
city	string	Cidade do merchant (loja)
district	string	Bairro do merchant (loja)
street	string	Rua do merchant (loja)
number	string	Número do merchant (loja)
postalCode	string	CEP do merchant (loja)
latitude	number	Latitude do merchant (loja)
longitude	number	Longitude do merchant (loja)

Exemplo:

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

customer

Campo	Tipo	Descrição
id	uuid	identificador único do customer
name	string	nome do cliente
phone.number	string	número de telefone do cliente ou do 0800 fornecido pelo iFood
phone.localizer	string	código localizador que deve ser informado ao ligar para o número 0800
phone.localizerExpiration	date	data de expiração do localizador do 0800

Exemplo:

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

Campo phone é opcional O campo phone é opcional, e deixará de funcionar 3 horas após a data de entrega designada para o pedido.

items

Campo	Tipo	Descrição
index	integer	posição/ordem dos itens
quantity	integer	Quantidade do item
weight.unit	string	Unidade do peso do item
weight.value	number	Valor do peso do item

Exemplo:

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

payments

Campo	Tipo	Descrição
prepaid	double	valor que já foi pago (ONLINE)
pending	double	valor pendente que deve ser cobrado no ato da entrega (OFFLINE)
methods.value	double	valor do pagamento
methods.currency	string	moeda
methods.method	enum	método de pagamento (CASH / CREDIT / DEBIT / MEAL_VOUCHER / FOOD_VOUCHER / GIFT_CARD / DIGITAL_WALLET / PIX / OTHER)
methods.type	string	tipo de pagamento: OFFLINE (pagamento deve ser feito no ato da entrega do pedido)
methods.prepaid	double	valor que já foi pago (ONLINE)
methods.cash.changeFor	double	valor do troco em caso de 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	método de entrega do pedido. Valores possíveis: DEFAULT/EXPRESS. DEFAULT: método de entrega padrão;
deliveredBy	enum	responsável por fazer a entrega: MERCHANT (entrega própria)
deliveryDateTime	date	data e horário da entrega
observations	string	observações sobre a entrega (Ex: "Não tem porteiro. Favor interfonar.")
deliveryAddress	--	endereço onde o pedido deve ser entregue

Exemplo:

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

deliveryAddress

Campo	Tipo	Descrição
streetName	string	nome da rua ou avenida
streetNumber	string	número (Obs: pode conter letras)
formattedAddress	string	endereço formatado (Rua + Número)
neighborhood	string	bairro ou setor
complement	string	complemento (Ex: Apartamento, Quadra, Lote)
reference	string	ponto de referência
postalCode	string	código postal (CEP). Campo opcional, eventualmente pode ser enviado zerado
city	string	cidade
state	string	estado
country	string	país
coordinates.latitude	double	latitude
coordinates.longitude	double	longitude

Exemplo:

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

scheduled

Campo	Tipo	Descrição
schedule.deliveryDateTimeStart	date	início do horário (intervalo) agendado
schedule.deliveryDateTimeEnd	date	fim do horário (intervalo) agendado

Exemplo:

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

Exemplos

Pedido de entrega imediata, com pagamento em cartão de crédito na entrega:

{
  "id": "4934a1e8-2071-4ac7-9ff6-6e634bb6008d",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "displayId": "9843",
  "createdAt": "2024-03-20T14:33:08.052Z",
  "isTest": true,
  "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
      }
    }
  },
  "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
      }
    },
    {
      "index": 3,
      "quantity": 1,
      "weight": {
        "unit": "GRAMS",
        "value": 2
      }
    }
  ],
  "payments": {
    "prepaid": 0,
    "pending": 323.99,
    "methods": [
      {
        "value": 323.99,
        "currency": "BRL",
        "method": "CREDIT",
        "prepaid": false,
        "type": "OFFLINE"
      }
    ]
  }
}

Pedido de entrega imediata, onde o pagamento já foi realizado online:

{
  "id": "63ec432e-4f0d-4097-b4fe-11bc2dac14af",
  "orderType": "DELIVERY",
  "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
      }
    }
  },
  "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, 122, 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
    }
  ]
}

Pedido de entrega agendada, com pagamento em dinheiro na entrega e com troco:

{
  "id": "5076514a-2ad1-49fe-b38c-e849b4cbeaab",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "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"
  },
  "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
      }
    }
  },
  "items": [
    {
      "index": 1,
      "quantity": 1,
      "weight": {
        "unit": "GRAMS",
        "value": 750
      }
    },
    {
      "index": 2,
      "quantity": 1,
      "weight": {
        "unit": "LITTERS",
        "value": 2
      }
    }
  ],
  "merchant": {
    "id": "b0954b6b-f99c-44b6-ba1e-987f32b2b22a",
    "name": "Teste - murilogontijo",
    "merchantAddress": {
      "country": "BR",
      "state": "AC",
      "city": "Bujari",
      "district": "Bujari",
      "street": "Ramal Bujari, 122, 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"
    }
  },
  "payments": {
    "prepaid": 0,
    "pending": 103.99,
    "methods": [
      {
        "value": 103.99,
        "currency": "BRL",
        "method": "CASH",
        "prepaid": false,
        "type": "OFFLINE",
        "cash": {
          "changeFor": 150
        }
      }
    ]
  }
}