Envio de pedidos realizados na plataforma iFood: Este módulo permite que os merchants enviem pedidos feitos na plataforma iFood (Pedidos que já possuem um orderId). Isso é especialmente útil para merchants que possuem seus próprios entregadores, mas que podem precisar do serviço de entrega do iFood em situações de sobrecarga ou falta de entregadores.

Para utilizar esta modalidade de serviço deve ser contratado através do menu Serviços do Portal do Parceiro. Caso contrário, não será possível registrar pedidos, verificar disponibilidade de entrega ou solicitar entregador.

Envio de pedidos realizados através de outros canais de venda: O módulo também permite que os merchants enviem pedidos que foram realizados através de outros canais de venda, como telefone, WhatsApp, aplicativo ou site próprio (Pedidos que não possuem um orderId pré-existente). Para maiores informações sobre o Sob Demanda, acesse https://news.ifood.com.br/entrega-facil-o-delivery-do-ifood-fora-do-app/

Definições

Pedidos na plataforma iFood e fora dela

Pedidos na plataforma iFood são aqueles que já possuem um orderId, contendo as informações necessárias do restaurante e do cliente para realizar a cotação e solicitação.

Por outro lado, pedidos fora da plataforma iFood não possuem um orderId pré-existente, pois não são originados internamente. Nesse caso, informações adicionais são necessárias para efetuar a cotação e solicitação.

Contratação do serviço

Para utilizar o módulo, o Sob Demanda deve ser contratado através do menu Serviços do Portal do Parceiro. Caso contrário, não será possível registrar pedidos, verificar disponibilidade de entrega ou solicitar entregador.

Critérios para homologação

Esses critérios são aplicáveis somente para integradoras que desejam integrar exclusivamente com o módulo Shipping ao contratar serviços de entrega para pedidos fora da plataforma iFood. Para as integradoras que desejam utilizar também o módulo de Orders, aplica-se o critério de homologação de Orders. Para aquelas que já estão homologadas, apesar de não ser obrigatória, recomenda-se que para utilizar o módulo Shipping a homologação também seja feita, a fim de validar se as requisições estão sendo feitas corretamente e detectar eventuais problemas.

O aplicativo deve ser capaz de

• Fazer requests no endpoint de /polling regularmente a cada 30 segundos;
• Enviar /acknowledgment para todos os eventos recebidos imediatamente após a request de polling;
• Receber e confirmar um pedido Sob Demanda para agora (orderType = DELIVERY / orderTiming = IMMEDIATE / salesChannel = POS);
• Receber e cancelar um pedido delivery para agora (orderType = DELIVERY / orderTiming = IMMEDIATE / salesChannel = POS). Antes de solicitar um cancelamento é obrigatório a consulta dos códigos/motivos disponíveis para o momento do pedido através do endpoint /cancellationReasons, esta lista de códigos/motivos deverá ser disponibilizada no sistema de PDV, para o usuário do PDV escolher qual motivo usar;
• Atualizar o status de um pedido cancelado pelo cliente ou pelo iFood;
• Atualizar o status de um pedido que pode ter sido confirmado/cancelado por outro aplicativo como por exemplo o Gestor de Pedidos;
• Receber um mesmo evento mais de uma vez no polling e descartá-lo caso esse evento tenha sido entregue mais de uma vez;
• Aceitar ou rejeitar uma alteração de endereço.
• Deve ser capaz de verificar o código de confirmação de entrega e saber se o código foi validado.
• Deve ser capaz de verificar o código de coleta e saber se o código foi validado.

Requisitos não funcionais

• Renovar o token somente quando estiver prestes a expirar ou imediatamente após a expiração.
• O aplicativo deve respeitar as políticas de rate limit de cada endpoint.

Desejável

• A comanda impressa seguir o modelo sugerido na documentação é um requisito desejável.
• Informar na tela e/ou comanda impressa a informação de indicar qualquer observação sobre a entrega do pedido (que vem no campo delivery.observations)

Pedidos fora da plataforma iFood

Fluxo de integração

Disponibilidade de entrega

Antes de registrar um pedido de fora do iFood, é importante consultar a disponibilidade de entrega. É possível que o endereço não esteja dentro da área de cobertura e mesmo que o endereço esteja dentro da área , é possível que exista alguma indisponibilidade temporária na região, como raio de entrega reduzido temporariamente. Através dessa consulta é possível obter também a janela de tempo estimada para a entrega do pedido para informar o cliente.

Para consultar a disponibilidade logística, basta realizar a requisição GET /deliveryAvailabilities passando os seguintes parâmetros:

• merchantId - ID do merchant que irá solicitar a entrega
• latitude - coordenada latitudinal do endereço de entrega
• longitude - coordenada longitudinal do endereço de entrega

/shipping/v1.0/merchants/<merchantId>/deliveryAvailabilities?latitude=<latitude>&longitude=<longitude>

Respostas

Sucesso

Este endpoint retorna o http status code 200 OK caso a logística esteja disponível. O corpo da resposta contém:

• id - id da cotação
• expirationAt - data e hora expiração da contação UTC
• createdAt - data e hora da criação da cotação UTC
• quote.grossValue - valor bruto da entrega
• quote.discount - valor do desconto da entrega
• quote.raise - valor do acréscimo
• quote.netValue - valor líquido da entrega
• deliveryTime.min - tempo mínimo estimado para entrega em segundos
• deliveryTime.max - tempo máximo estimado para entrega em segundos
• distance - raio de distância de entrega em metros (1000, 2000, 3000...)
• preparationTime - tempo de preparo
• hasPaymentMethods - informa se há métodos de pagamento disponíveis
• paymentMethods.id - id do método de pagamento
• paymentMethods.brand - bandeira do cartão de crédito/débito
• paymentMethods.liability - responsável por receber o pagamento (IFOOD)
• paymentMethods.paymentType - tipo de pagamento ex.: OFFLINE
• paymentMethods.method - método de pagamento CREDIT, DEBIT ou CASH

{
  "id": "57cd1046-2e06-446f-a2dd-18a518212c3c",
  "expirationAt": "2023-08-18T19:49:06Z",
  "createdAt": "2023-08-17T19:49:06Z",
  "distance": 3000,
  "preparationTime": 60,
  "quote": {
    "grossValue": 7.99,
    "discount": 0,
    "raise": 0,
    "netValue": 7.99
  },
  "deliveryTime": {
    "min": 1200,
    "max": 1800
  },
  "hasPaymentMethods": true,
  "paymentMethods": [
    {
      "id": "21c65a8c-f29e-463f-b0bd-240edeb593c4",
      "brand": "CardBrand",
      "liability": "IFOOD",
      "paymentType": "OFFLINE",
      "method": "CREDIT"
    },
    {
      "liability": "IFOOD",
      "paymentType": "OFFLINE",
      "method": "CASH",
      "id": "93c1c7c7-61f1-4dd9-bb84-62a03254701d"
    }
  ]
}

Erro

Este endpoint retorna o http status code 400 Bad Request caso a logística não esteja disponível para entregar o pedido nessa localização ou para esse merchant.

{
  "code": "DeliveryDistanceTooHigh",
  "message": "Sob Demanda indisponivel: o endereço da entrega esta a mais de 10 Km da sua loja.",
  "details": ["Delivery distance too high"]
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao registrar esse pedido.

{
  "code": "InternalServerError",
  "message": "Ops. Houve uma falha. Tente novamente em alguns instantes.",
  "details": ["Internal server error"]
}

Registro de pedidos

Para registrar um pedido e solicitar um entregador parceiro, basta realizar a requisição POST /orders passando no corpo as informações do pedido.

Código de Confirmação de Entrega

Para garantir a segurança das entregas evitando casos de extravio do pedido, um código de confirmação de entrega será gerado, esse código é composto pelos 4 últimos dígitos do telefone do consumidor final informado no pedido. O entregador iFood solicitará essa sequência de números ao efetuar a entrega.

Não desejo que meu pedido tenha o Código de Confirmação de Entrega

Caso não tenha acesso ao telefone do cliente ou não deseje informá-lo, será necessário enviar o customer.phone.type=”STORE” para que o código de confirmação de entrega não seja solicitado.

Como habilitar o Código de Confirmação de Entrega

Para que o pedido tenha o código de confirmação de entrega habilitado é necessário que o telefone do cliente seja informado e este telefone seja válido, pois somente assim o cliente conseguirá informar o código de confirmação de entrega correto ao entregador iFood.

Parceiros que utilizam a página de rastreio do iFood

O código de confirmação será disponibilizado na página de rastreio do iFood para que o consumidor final possa informar o código correto ao entregador iFood.

Parceiros que não utilizam a página de rastreio do iFood

Para disponibilizar o código de confirmação caso não use a página de rastreio do ifood, será necessário consumir o atributo metadata.CODE do evento DELIVERY_DROP_CODE_REQUESTED para que o código seja repassado ao consumidor final. Esse evento será propagado apenas em situações onde o código de confirmação for obrigatório, portanto caso o evento não seja enviado, significa que a confirmação de entrega não será necessária.

Detalhes do pedido

Seguem abaixo todos os campos do pedido para ser registrado no iFood.

Observação: Campos marcados com asterisco (*) são obrigatórios.

Exemplos

{
  "customer": {
    "name": "Customer Name",
    "phone": {
      "type": "CUSTOMER",
      "countryCode": "55",
      "areaCode": "11",
      "number": "999999999"
    }
  },
  "delivery": {
    "merchantFee": 0,
    "deliveryAddress": {
      "postalCode": "69923000",
      "streetNumber": "100",
      "streetName": "Ramal Bujari",
      "complement": "",
      "neighborhood": "Centro",
      "city": "Bujari",
      "state": "AC",
      "country": "BR",
      "reference": "Perto da padaria",
      "coordinates": {
        "latitude": -9.822159,
        "longitude": -67.948475
      }
    }
  },
  "items": [
    {
      "id": "7b956744-38f6-418a-90fa-22676b53e6d1",
      "name": "Produto Teste",
      "externalCode": "123456",
      "quantity": 1,
      "unitPrice": 1,
      "price": 1,
      "optionsPrice": 0,
      "totalPrice": 1,
      "options": []
    }
  ],
  "payments": {
    "methods": [
      {
        "method": "CREDIT",
        "type": "OFFLINE",
        "value": 1,
        "card": {
          "brand": "CardBrand"
        }
      }
    ]
  },
  "displayId": "AB3D",
  "metadata": {
    "additionalProp1": "string"
  }
}

Formas de Pagamento

Pagamentos offline o entregador irá receber o valor do pedido na entrega via maquininha do iFood ou em dinheiro a depender do método enviado, é necessário enviar o objeto de payment. É necessário que a cotação tenha esse método de pagamento na lista de paymentMethods, caso contrário será retornado um erro.

Para pagamentos online não processamos pagamentos online, esse pagamento é arrecadado pelo Merchant, logo não é necessário o envio do objeto payment.

Metadata

O campo metadata, permite adicionar informações complementares ao pedido, essas informações não são repassadas ao app do driver ou ao gestor de pedidos.

Respostas

Sucesso

Este endpoint retorna o http status code 202 Accepted caso o pedido seja registrado com sucesso e o entregador parceiro alocado sem problemas. O corpo da resposta contém:

• id - ID do pedido criado
• trackingUrl - url da página de acompanhamento do pedido

{
  "id": "522e4d7e-0ce1-44f3-8cc7-73a9f190a5e8",
  "trackingUrl": "https://meupedido.ifood.com.br/522e4d7e-0ce1-44f3-8cc7-73a9f190a5e8"
}

Erros

Este endpoint retorna o http status code 400 Bad Request caso a logística não esteja disponível para entregar o pedido ou ocorra alguma falha ao registrar esse pedido.

{
  "code": "DeliveryDistanceTooHigh",
  "message": "Sob Demanda indisponivel: o endereço da entrega esta a mais de 10 Km da sua loja.",
  "details": ["Delivery distance too high"]
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao registrar esse pedido.

{
  "code": "InternalServerError",
  "message": "Ops. Houve uma falha. Tente novamente em alguns instantes.",
  "details": ["Internal server error"]
}

Confirmação ou alteração do endereço de entrega

Através deste fluxo o cliente poderá confirmar o seu endereço ou solicitar a alteração do mesmo. Nos casos em que houver alteração do endereço de entrega, ocorrerá um processo de validação pelo parceiro, onde será deliberada a aprovação ou recusa da solicitação.

Parceiros que utilizam a página de rastreio do iFood

Os clientes que acompanham seus pedidos por meio da página de rastreio fornecida pelo iFood têm a opção de confirmar o endereço de entrega ou solicitar a sua alteração. Para que isso seja possível, é necessário que o pedido não tenha sido criado com o atributo customer.phone.type=”STORE”.

Parceiros que não utilizam a página de rastreio do iFood

Os parceiros que optarem por criar a sua própria experiência de confirmação ou solicitação de alteração do endereço de entrega devem implementar os endpoints responsáveis por este fluxo.

Confirmação do Endereço

Para confirmar o endereço basta realizar a requisição POST /userConfirmAddress passando os seguintes parâmetros:

• orderId - ID do do pedido que terá o endereço confirmado

/shipping/v1.0/orders/<orderId>/userConfirmAddress

Respostas

Sucesso

Esse endpoint retorna HTTP Status 202, sem nada no corpo da resposta O polling receberá um evento de DELIVERY_ADDRESS_CHANGE_USER_CONFIRMED quando a solicitação for um sucesso.

Erro

Este endpoint retorna o http status code 400 Bad Request caso os parâmetros esperados não sejam fornecidos.

{
  "code": "BadRequest",
  "message": "Houve um problema na leitura de informações. Verifique as informações enviadas.",
  "details": ["Campo 'OrderID' deve estar no formato uuid."]
}

Este endpoint retorna o http status code 404 Not Found caso o pedido não seja encontrado, esteja concluído ou cancelado, ou tenha sido criado a mais de 8 horas.

{
  "code": "OrderNotFound",
  "message": "Pedido não encontrado.",
  "details": []
}

Este endpoint retorna o http status code 409 Operation Conflict caso ocorra um conflito na operação, como tentar confirmar o endereço de um pedido com alteração pendente/confirmada/rejeitada.

{
  "code": "ChangeAddressOperationConflict",
  "message": "Existe um conflito na confirmação/solicitação de alteração de endereço desse pedido, ela já pode ter o endereço confirmado pelo cliente, ou uma solicitação de alteração pendente/concluida",
  "details": []
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao registrar esse pedido.

Solicitação de alteração de endereço

Quando for solicitada uma alteração do endereço de entrega, um evento DELIVERY_ADDRESS_CHANGE_REQUESTED será gerado e enviado por meio do polling. Este evento indica que foi solicitada a alteração do endereço, e o novo endereço solicitado estará disponível no atributo metadata.address.

Para solicitar a alteração de endereço basta realizar a requisição POST /deliveryAddressChangeRequest passando os seguintes parâmetros:

Os parametros marcados com * são obrigatórios

• orderId* o ID do pedido que terá o endereço confirmado
• streetName* nome da rua para qual o endereço será alterado.
• streetNumber número da rua para qual o endereço será alterado.
• complement complemento do endereço para qual será alterado.
• reference referência do endereço para qual será alterado.
• neighborhood* bairro para qual o endereço será alterado.
• city* cidade para qual o endereço será alterado.
• state* estado para qual o endereço será alterado.
• country* para qual o endereço será alterado.
• coordinates* coordenadas para quais o endereço será alterado.
• coordinates.latitude* latitude para qual o endereço será alterado.
• coordinates.longitude* longitude para qual o endereço será alterado.

/shipping/v1.0/orders/<orderId>/deliveryAddressChangeRequest

Respostas

Sucesso

Esse endpoint retorna HTTP Status 202, sem nada no corpo da resposta O polling receberá um evento de DELIVERY_ADDRESS_CHANGE_REQUESTED quando a solicitação for um sucesso.

Erro

Este endpoint retorna o http status code 400 Bad Request caso os parâmetros esperados não sejam fornecidos.

{
  "code": "BadRequest",
  "message": "Houve um problema na leitura de informações. Verifique as informações enviadas.",
  "details": [
    "Campo 'StreetName' é obrigatório.",
    "Campo 'Neighborhood' é obrigatório.",
    "Campo 'City' é obrigatório.",
    "Campo 'State' é obrigatório.",
    "Campo 'Country' é obrigatório.",
    "Campo 'Latitude' é obrigatório.",
    "Campo 'Longitude' é obrigatório."
  ]
}

Este endpoint retorna o http status code 404 Not Found caso o pedido não seja encontrado, esteja concluído ou cancelado, ou tenha sido criado a mais de 8 horas.

{
  "code": "OrderNotFound",
  "message": "Pedido não encontrado.",
  "details": []
}

Este endpoint retorna o http status code 409 Operation Conflict caso ocorra um conflito na operação, como tentar confirmar o endereço de um pedido com alteração pendente/confirmada/rejeitada.

{
  "code": "ChangeAddressOperationConflict",
  "message": "Existe um conflito na confirmação/solicitação de alteração de endereço desse pedido, ela já pode ter o endereço confirmado pelo cliente, ou uma solicitação de alteração pendente/concluida",
  "details": []
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao registrar esse pedido.

Aprovação de alteração de endereço

Para aprovar a alteração de endereço basta realizar a requisição POST /acceptDeliveryAddressChange passando os seguintes parâmetros:

• orderId - ID do do pedido que terá o endereço de entrega alterado

/shipping/v1.0/orders/<orderId>/acceptDeliveryAddressChange

Respostas

Sucesso

Esse endpoint retorna HTTP Status 202, sem nada no corpo da resposta O polling receberá um evento de DELIVERY_ADDRESS_CHANGE_ACCEPTED quando a solicitação for um sucesso.

Erro

Este endpoint retorna o http status code 400 Bad Request caso os parâmetros esperados não sejam fornecidos.

{
  "code": "BadRequest",
  "message": "Houve um problema na leitura de informações. Verifique as informações enviadas.",
  "details": ["Campo 'OrderID' deve estar no formato uuid."]
}

Este endpoint retorna o http status code 404 Not Found caso o pedido não seja encontrado, esteja concluído ou cancelado, ou tenha sido criado a mais de 8 horas.

{
  "code": "OrderNotFound",
  "message": "Pedido não encontrado.",
  "details": []
}

Este endpoint retorna o http status code 409 Operation Conflict caso ocorra um conflito na operação, como tentar confirmar o endereço de um pedido com alteração pendente/confirmada/rejeitada.

{
  "code": "ChangeAddressOperationConflict",
  "message": "Existe um conflito na confirmação/solicitação de alteração de endereço desse pedido, ela já pode ter o endereço confirmado pelo cliente, ou uma solicitação de alteração pendente/concluida",
  "details": []
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao registrar esse pedido.

Rejeição de alteração de endereço

Para rejeitar a alteração de endereço basta realizar a requisição POST /denyDeliveryAddressChange passando os seguintes parâmetros:

• orderId - ID do do pedido que terá a solicitação de alteração de endereço rejeitada

/shipping/v1.0/orders/<orderId>/denyDeliveryAddressChange

Respostas

Sucesso

Esse endpoint retorna HTTP Status 202, sem nada no corpo da resposta O polling receberá um evento de DELIVERY_ADDRESS_CHANGE_DENIED quando a solicitação for um sucesso.

Erro

Este endpoint retorna o http status code 400 Bad Request caso os parâmetros esperados não sejam fornecidos.

{
  "code": "BadRequest",
  "message": "Houve um problema na leitura de informações. Verifique as informações enviadas.",
  "details": ["Campo 'OrderID' deve estar no formato uuid."]
}

Este endpoint retorna o http status code 404 Not Found caso o pedido não seja encontrado, esteja concluído ou cancelado, ou tenha sido criado a mais de 8 horas.

{
  "code": "OrderNotFound",
  "message": "Pedido não encontrado.",
  "details": []
}

Este endpoint retorna o http status code 409 Operation Conflict caso ocorra um conflito na operação, como tentar confirmar o endereço de um pedido com alteração pendente/confirmada/rejeitada.

{
  "code": "ChangeAddressOperationConflict",
  "message": "Existe um conflito na confirmação/solicitação de alteração de endereço desse pedido, ela já pode ter o endereço confirmado pelo cliente, ou uma solicitação de alteração pendente/concluida",
  "details": []
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao registrar esse pedido.

Cancelamento

Para cancelar uma solicitação de entrega para pedidos que não são da plataforma iFood, é crucial entender algumas condições. Primeiramente, apenas os pedidos com o atributo salesChannel definido como POS podem ser cancelados. Qualquer pedido que não se enquadre neste contexto não poderá ser cancelado através do módulo de Shipping. Caso um motorista já tenha sido designado para o pedido, a responsabilidade pelo cancelamento deixa de ser do módulo de Shipping e passa a ser do módulo de Orders. Para obter mais informações sobre o processo de cancelamento e as responsabilidades envolvidas, consulte a documentação do iFood no Guia de Cancelamento de Pedido, disponível através do seguinte link: Guia de Cancelamento de Pedido iFood.

Para obter a lista de códigos de cancelamento válidos para um pedido, você pode usar o endpoint GET /cancellationReasons.

Para realizar o cancelamento, você deve fazer uma requisição para o endpoint POST /cancel, passando os seguintes parâmetros:

• orderID - Id do pedido
• reason - Texto com a descrição do motivo
• cancellationCode - Código de cancelamento

/shipping/v1.0/orders/<orderId>/cancel

Respostas

Sucesso

Esse endpoint retorna HTTP Status 202, sem nada no corpo da resposta O polling receberá um evento de CANCELLATION_REQUESTED quando a solicitação for um sucesso e posteriormente os eventos de CANCELLED ou CANCELLATION_REQUEST_FAILED em caso de sucesso ou falha.

Erro

Este endpoint retorna o http status code 400 Bad Request caso os parâmetros esperados não sejam fornecidos.

{
  "code": "BadRequest",
  "message": "Houve um problema na leitura de informações. Verifique as informações enviadas.",
  "details": ["Campo 'OrderID' deve estar no formato uuid."]
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao solicitar o cancelamento da entrega.

{
  "code": "InternalServerError",
  "message": "Ops. Houve uma falha. Tente novamente em alguns instantes.",
  "details": ["Internal server error"]
}

Nível de confiança na entrega

Para aprimorar a segurança da sua entrega, desenvolvemos um conjunto de regras que nos permitem qualificar o nível de confiança na entrega. Essa qualificação é baseada nos parâmetros informados durante a criação do pedido e na alteração ou confirmação do endereço realizadas pelo cliente após a criação do pedido.

Teremos os seguintes níveis de confiança na entrega

E o cálculo do nível de confiança na entrega será feita baseado nas seguintes regras

Exemplos de como ficariam os níveis de confiança na entrega

Pedido com customer_phone_is_valid:false terá um score LOW.

Pedido com customer_phone_is_fixed:true terá um score MODERATE.

Pedido com customer_phone_is_fixed:true e customer_address_confirmed:true teria um score VERY_HIGH.

Pedido com customer_phone_is_valid:true terá um score HIGH.

Pedido com customer_phone_is_valid:true e customer_address_change_requested:true e merchant_address_change_approved:true terá um score VERY_HIGH .

Pedido com customer_phone_is_valid:true e customer_address_change_requested:true e merchant_address_change_denied:true terá um score LOW.

Consulta do nível de confiança na entrega

Para descobrir qual o nível de confiança na entrega do seu pedido, basta enviar a requisição GET /safeDelivery passando os seguintes parâmetros.

• orderId - ID do do pedido a ser consultado o nível de segurança na entrega.

/shipping/v1.0/orders/:orderId/safeDelivery

Respostas

Sucesso

Este endpoint retorna o http status code 200 OK caso o pedido seja elegível a segurança na entrega. O corpo da resposta contém:

• rules - contém um map do tipo [string]boolean contendo a regra e situação.
• score - nível de confiança da entrega do pedido gerado com base nas regras definidas no campo rules.

{
  "rules": {
    "customer_address_change_requested": false,
    "customer_address_confirmed": false,
    "customer_phone_is_fixed": false,
    "customer_phone_valid": true,
    "merchant_address_change_approved": false,
    "merchant_address_change_denied": false
  },
  "score": "HIGH"
}

Erro

Este endpoint retorna o http status code 400 Bad Request caso os parâmetros esperados não sejam fornecidos.

BadRequest

{
  "code": "BadRequest",
  "message": "Houve um problema na leitura de informações. Verifique as informações enviadas.",
  "details": ["Campo 'OrderID' deve estar no formato uuid."]
}

OrderWithoutSafeDelivery

{
  "code": "OrderWithoutSafeDelivery",
  "message": "Pedido sem regras de confiança na entrega.",
  "details": []
}

Este endpoint retorna o http status code 404 Not Found caso o pedido não seja encontrado.

{
  "code": "OrderNotFound",
  "message": "Pedido não encontrado.",
  "details": []
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao consultar esse pedido.

{
  "code": "InternalServerError",
  "message": "Ops. Houve uma falha. Tente novamente em alguns instantes.",
  "details": ["Internal server error"]
}

Pedidos na plataforma do iFood

Fluxo de integração

Disponibilidade de entrega

Antes de registrar uma solicitação de entrega é importante consultar a cotação/disponibilidade de entrega. É possível que o endereço não esteja dentro da área de cobertura e mesmo que o endereço esteja dentro da área, é possível que exista alguma indisponibilidade temporária na região, como raio de entrega reduzido temporariamente. Através dessa consulta é possível obter também a janela de tempo estimada para a entrega do pedido para informar o cliente.

Para consultar a cotação da logística para um pedido pré-existente dentro da plataforma iFood, basta realizar a requisição GET /deliveryAvailabilities passando os seguintes parâmetros:

• orderId - ID do pedido já existente na plataforma ifood para solicitar a entrega

/shipping/v1.0/orders/<orderId>/deliveryAvailabilities

Respostas

Sucesso

Este endpoint retorna o http status code 200 OK caso a logística esteja disponível. O corpo da resposta contém:

• id - id da cotação
• expirationAt - data e hora expiração da contação UTC
• createdAt - data e hora da criação da cotação UTC
• quote.grossValue - valor bruto da entrega
• quote.discount - valor do desconto da entrega
• quote.raise - valor do acréscimo
• quote.netValue - valor líquido da entrega
• deliveryTime.min - tempo mínimo estimado para entrega em segundos
• deliveryTime.max - tempo máximo estimado para entrega em segundos
• distance - raio de distância de entrega em metros (1000, 2000, 3000...)
• preparationTime - tempo de preparo
• hasPaymentMethods - informa se há métodos de pagamento disponíveis
• paymentMethods.id - id do método de pagamento
• paymentMethods.brand - bandeira do cartão de crédito/débito
• paymentMethods.liability - responsável por receber o pagamento (IFOOD)
• paymentMethods.paymentType - tipo de pagamento ex.: OFFLINE
• paymentMethods.method - método de pagamento CREDIT ou DEBIT

{
  "id": "57cd1046-2e06-446f-a2dd-18a518212c3c",
  "expirationAt": "2023-08-18T19:49:06Z",
  "createdAt": "2023-08-17T19:49:06Z",
  "distance": 3000,
  "preparationTime": 60,
  "quote": {
    "grossValue": 7.99,
    "discount": 0,
    "raise": 0,
    "netValue": 7.99
  },
  "deliveryTime": {
    "min": 1200,
    "max": 1800
  },
  "hasPaymentMethods": true,
  "paymentMethods": [
    {
      "id": "21c65a8c-f29e-463f-b0bd-240edeb593c4",
      "brand": "CardBrand",
      "liability": "IFOOD",
      "paymentType": "OFFLINE",
      "method": "CREDIT"
    }
  ]
}

Erro

Este endpoint retorna o http status code 400 Bad Request caso a logística não esteja disponível para entregar o pedido nessa localização ou para esse merchant.

{
  "code": "DeliveryDistanceTooHigh",
  "message": "Sob Demanda indisponivel: o endereço da entrega esta a mais de 10 Km da sua loja.",
  "details": ["Delivery distance too high"]
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao registrar esse pedido.

{
  "code": "InternalServerError",
  "message": "Ops. Houve uma falha. Tente novamente em alguns instantes.",
  "details": ["Internal server error"]
}

Solicitação de entrega

Para solicitar o entregador concordando com a cotação retornada, utilize o seguinte endpoint POST /requestDriver passando no corpo as informações do pedido.

Esse endpoint é assíncrono. Quando sua requisição for processada você receberá um evento REQUEST_DRIVER confirmando que a requisição foi feita e em seguida o resultado da solicitação, que pode ser: REQUEST_DRIVER_SUCCESS ou REQUEST_DRIVER_FAILED.

• orderId - ID do pedido já existente na plataforma ifood para solicitar a entrega
• quoteId - ID da cotação solicitada anteriormente para solicitar a entrega

/shipping/v1.0/orders/<orderId>/requestDriver

Respostas

Sucesso

Este endpoint retorna o http status code 202 Accepted caso o solicitação seja registrada com sucesso.

Erros

Este endpoint retorna o http status code 400 Bad Request caso a logística não esteja disponível para entregar o pedido ou ocorra alguma falha ao registrar esse pedido.

{
  "code": "DeliveryDistanceTooHigh",
  "message": "Sob Demanda indisponivel: o endereço da entrega esta a mais de 10 Km da sua loja.",
  "details": ["Delivery distance too high"]
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao registrar esse pedido.

{
  "code": "InternalServerError",
  "message": "Ops. Houve uma falha. Tente novamente em alguns instantes.",
  "details": ["Internal server error"]
}

Cancelamento

Para cancelar a solicitação de um entregador iFood sem a necessidade de cancelar o pedido, o cancelamento da entrega deve ser realizado através do endpoint POST /orders/{id}/cancelRequestDriver.

O cancelamento só será efetuado se ele for solicitado antes do aceite do entregador, neste caso nenhuma taxa será cobrada da loja. Caso seja necessário realizar o cancelamento após do aceite do entregador, deve seguir as regras estabelecidas em Cancelamento de pedido.

/shipping/v1.0/orders/<orderId>/cancelRequestDriver

Respostas

Sucesso

Esse endpoint retorna HTTP Status 202, sem nada no corpo da resposta O polling receberá um evento de DELIVERY_CANCELLATION_REQUESTED quando a solicitação for enviada com sucesso.

Erro

Este endpoint retorna o http status code 400 Bad Request caso os parâmetros esperados não sejam fornecidos.

{
  "code": "BadRequest",
  "message": "Houve um problema ao solicitar a entrega. Verifique as informações enviadas.",
  "details": ["Campo 'OrderID' deve estar no formato uuid."]
}

Este endpoint retorna o http status code 500 Internal Server Error caso ocorra alguma falha ao solicitar o cancelamento da entrega.

{
  "code": "InternalServerError",
  "message": "Ops. Houve uma falha. Tente novamente em alguns instantes.",
  "details": ["Internal server error"]
}