Nova política de Mudanças
Para aumentar a transparência e fortalecer a confiança, implementamos novas regras para o lançamento de novas funcionalidades, conforme detalhado a seguir:Mudanças Obrigatórias
Mudanças obrigatórias são aquelas que exigem que o aplicativo da integradora esteja adaptado antes da mudança ser implantada em produção. Caso o aplicativo não seja adaptado dentro do prazo, pode impactar gravemente na operação dos parceiros, como por exemplo gerar perda de pedidos/receita. Este período permite que nossos parceiros tenham tempo suficiente para analisar os impactos, desenvolver as adaptações e atualizar toda a sua base de usuários.Mudanças Opcionais com Impacto
Mudanças opcionais que não quebram a integração, mas podem impactar regras ou políticas relevantes para nossos parceiros. Este prazo é estabelecido para garantir que os parceiros tenham a oportunidade de avaliar o impacto dessas mudanças, e avaliar junto aos seus usuários se é necessário se adaptar e se conseguem continuar operando sem se adaptar e sem gerar impactos para os usuários.Mudanças Opcionais sem Impacto Negativo
Para mudanças opcionais que não afetam a integração diretamente e não trazem impactos negativos para os seus usuários. Essas mudanças geralmente incluem melhorias ou adições que podem beneficiar os usuários sem exigir ajustes significativos por parte dos parceiros.Tipo de Mudança | Prazo de Comunicação |
---|
Mudanças Obrigatórias | Mínimo de 90 dias. |
Mudanças Opcionais com Impacto | Mínimo de 60 dias. |
Mudanças Opcionais sem Impacto Negativo | Mínimo de 15 dias. |
Mudanças Planejadas
2025/06/17
[Módulo de Financial] Descontinuação API Sales 2.1
A versão legada Sales 2.1 será desligada em 17 de junho de 2025, portanto, recomendamos fortemente que iniciem o processo de migração assim que possível.Mudanças Recentes
2025/05/05
[Módulo de Orders] Atualização da documentação com nova orientação para impressão de comanda- Adicionada orientação para não imprimir endereço de entrega e CPF em comandas de entregas parceiras. saiba mais aqui
2025/05/02
[Eventos via Webhook] Desconsideração de respostas 4xx
Entregas de evento via Webhook passarão a desconsiderar respostas 4xx (exceto 429 Too Many Requests) em 29 de abril de 2025 em seu fluxo de retentativa de entrega.2025/04/30
[Módulo da Maquinona] Atualização da documentação com novos campos para fluxos de pagamento, estorno e impressão- Foram adicionados novos campos opcionais na integração com a Maquinona, para os fluxos existente de Pagamento, Estorno e Impressão.
2025/04/02
[Módulo de Review] Inclusão de dois campos opcionais na resposta Review API V2- Foi adicionado os campos opcionais previousScore e hasScoreChanged na resposta dos endpoints
/merchants/{merchantId}/reviews
e /merchants/{merchantId}/reviews/{reviewId}
da versão V2 da APi de Review.
2025/04/01
[Módulo de Financial] Inclusão na documentação do campo parcela_pagamento2025/03/31
[Módulo de Catalog] Atualização sobre combo de terceiro nível
Atualização das datas de homologação e informações sobre combo de terceiro nível2025/03/31
[Módulo de Financial] Documentação Sales: API Financial Events v32025/03/20
[Módulo de Catalog] Inclusão de novo campo de produtos
Inclusão de campo industrialized nas consultas e respostas de produtos.2025/03/18
[Módulo de Groceries] Adição de novo campo de VerificationCodes
Novo campo VerificationCodes2025/03/17
[Módulo de Promotion] Nova feature "reset" no post de Groceries Promotions
Documentação do novo parametro no post de promotion e melhorias no detalhamento da doc baseado em feedbacks dos parceiros. Não haverá breakingChanges.2025/03/17
[Módulo de Financial] Lançamento nova versão Sales: API Sales v3
A partir de 06 de março de 2025, a versão beta está disponível em produção para que as integradoras possam iniciar os testes de integração.
A partir de 17 de março de 2025, a versão oficial estará disponível, junto com a documentação completa no Portal do Desenvolvedor.2025/03/14
[Módulo de Financial] Documentação Sales: API Sales v32025/03/11
[Módulo de Catalog] Inclusão de novos campos na consulta de categorias
Incluso o campo/objeto customizationModifiers na rota /merchants/{merchantId}/catalogs/{catalogId}/categories
.2025/03/10
[Módulo de Review] Inclusão da Review API V2- Apenas o contrato de resposta dos endpoints
/merchants/{merchantId}/reviews
e /merchants/{merchantId}/reviews/{reviewId}
foram alterados.
2025/03/01
[Módulo de Financial] Adição de uma nova coluna no arquivo de conciliacão V3Será adicionado uma nova coluna no arquivo de conciliacão do módulo de Financial V3 Parcela_pagamento.
Em compras parceladas, este campo especifica qual parcela está sendo paga.Exemplo:
"Se o cliente parcelou a compra em 3 vezes, o campo parcela_pagamento pode ter os valores 1, 2 ou 3, indicando a parcela correspondente."
A modalidade de pagamento parcelado está disponível apenas para lojas de Groceries atualmente.2025/02/21
[Módulo de Groceries] Adição de novos campos de Fees
Inclusão de todos os campos relacionados a Fees.2025/02/21
[Módulo de Promotion] Ajuste documentação do endpoint de Get Promotion
Ajustes de erro de digitação da rota /merchants/{merchantId}/promotions/{aggregationId}/items
.2025/02/20
[Módulo de Promotion] Inclusão de novo endpoint de Get Promotion e documentação associada
Incluso rota de get promotion, na versão v1. Documentação e nova collection.2025/02/11
[Módulo de Groceries] Inclusão de novos campos de benefícios
Incluindo campos de PBM nos benefícios do pedido.2025/02/11
[Módulo de Financial] Remoção da rota de conciliação sales v2
Removido a rota /sales da versão 2 do módulo de financial.2025/02/05
[Módulo de Eventos] Múltiplas Entregas para um único pedido
Serão incluídos 3 novos campos no metadata dos eventos logísticos (Grupo Delivery), que informarão se a entrega que está sendo executada é a entrega Principal ou de um Complemento do pedido.[Módulo de Shipping] Confirmação automática dos pedidos Sob Demanda
Todos os pedidos Sob Demanda no módulo Shipping terão confirmação automática (salesChannel=POS). Não é necessário que sua integradora realize qualquer ação adicional.[Publicado em 21/01/2025]2025/02/04
[Módulo de Catalog] Correções na documentação- Remoção do endpoint /merchants/{merchantId}/catalogs/{catalogId}/changelog que já estava obsoleto
- Remoção do módulo adicional Shelves, que já estava obsoleto
- Remoção do campo scalePrices, que já estava obsoleto
- Organização dos primeiros passos no ínicio da documentação
[Publicado em 04/02/2025]2025/01/27
[Publicado em 27/01/2025]2025/01/23
[Módulo de Financial] Remoção da v1 da API de Financial do API References
Foi removida do API References a API v1[Publicado em 27/01/2025]2025/01/23
- [Módulo de Item] Correção na documentação de Item: o exemplo de request body estava incorretamente apresentando o campo
channels
como um valor de string.
[Publicado em 23/01/2025]2025/01/22
[Módulo de Financial] Inclusão dos campos benefitIndustry e benefitChain na API Financeira v2
Foram incluídos os campos benefitIndustry e benefitChain na API Financeira v2[Publicado em 27/01/2025]2025/01/21
[Módulo de Financial] Inclusão da documentação da API de Antecipação
Foi incluída a documentação de Antecipação na API Financeira v3[Publicado em 22/01/2025]2025/01/20
[Módulo de Financial] Inclusão de novo campo no retorno da API de reconciliation v3
Foi incluído o campo product no retorno da API de reconciliation.[Publicado em 21/01/2025]2025/01/08
[Módulo de Eventos] Novos eventos para elegibilidade e validação do código de coleta
Foram adicionados os eventos DELIVERY_PICKUP_CODE_REQUESTED
e DELIVERY_PICKUP_CODE_VALIDATION_SUCCESS
para elegibilidade de validação do código de coleta dos pedidos.2024
2024/12/19
[Módulo de Financial] Desligamento das API’s V1 e Sales 2.0A partir do dia 20 de dezembro de 2024, as API’s V1 e Sales 2.0 serão desligadas. As API’s que ainda ficarão disponíveis são:- Sales 2.1 - disponível até junho/25
- Todas as outras API’s 2.0 (exceto Sales 2.0) - disponível até junho/25
- Todas API’s da V3 - versão mais atualizada e recomendada
- Acesse aqui a documentação da V3
2024/12/17
[Módulo de Reviews] Foram atualizados os critérios de homologação. A partir de agora, a consulta ao sumário de avaliação não será mais necessária, pois essa informação não é calculada para lojas de teste.2024/12/16
[Módulo de Order] Cancelamento de pedido
Foi adicionado novas informações de respostas de endpoint de cancelamento de pedidos.2024/12/12
[Módulo de Shipping] Novo endpoint para obter a lista de códigos de cancelamento para pedidos salesChannel=POS
Adicionado um novo endpoint no módulo de Shipping para obter a lista de códigos de cancelamento de um pedido. Esta melhoria fornece informações detalhadas sobre as opções de cancelamento disponíveis, aumentando a flexibilidade e a transparência no processo de cancelamento.2024/12/09
[Polling de Eventos] O evento BOX_ASSIGNED voltará a ser publicado no polling/webhook de eventos na próxima atualização. Mais detalhes na seção de eventos de pedidos.[Publicado em 09/12/2024]2024/12/06
[Publicado em 06/12/2024]2024/12/05
- [Módulo de Item] Correção na documentação de Informação dos Campos: a descrição dos valores válidos para o campo
channels[*]
estavam incorretamente listados como IFOOD
, IFOOD_SHOP
e WHITELABEL
. - [Módulo de Item] Correção na documentação de Canais: a descrição dos valores válidos para o campo
channels[*]
estavam incorretamente listados como IFOOD_APP
, IFOOD_SHOP
e WHITELABEL
.
[Publicado em 05/12/2024]2024/11/27
- [Módulo de Order] Inclusão de novos atributos de Informações de Transação de Pagamento (payment.methods.transaction.authorizationCode e payment.methods.transaction.acquirerDocument). Veja mais detalhes nesta seção
[Publicado em 27/11/2024]2024/11/26
- [Módulo de Catalog] Remoção da documentação dos campos referentes a promoções (
prices.promotionPrice
e scalePrices.*
) vinculados aos endpoints de gestão de catálogo (POST /ingestion/{merchantId}?reset={resetCatalog}
e PATCH /ingestion/{merchantId}
). Os endpoints continuarão a funcionar normalmente (com e sem os referidos campos). Esse foi apenas um ajuste na documentação para que novos clientes não utilizem essa forma de promocionar seus produtos.
[Publicado em 02/12/2024]2024/11/19
- [Módulo de Order] Adição das rotas
POST /orders/{id}/verifyDeliveryCode
e POST /orders/{id}/validatePickupCode
[Publicado em 19/11/2024]2024/11/18
- [Módulo de Picking - api reference] Remoção da rota substituição temporariamente.
- [Módulo de Picking - guides] Desligamento do link para rota substituição removida acima.
2024/11/18
- [Módulo de Groceries] Remoção do módulo de Groceries.
- [Módulo de Order] Adição da rota
GET /virtual-bag
e informações exclusivas para Mercado.
[Publicado em 18/11/2024]2024/11/14
[Publicado em 14/11/2024]2024/11/12
- [Módulo de Picking] Alteração na documentação de picking, e inclusão de nova rota de substituição.
[Publicado em 13/11/2024]2024/11/12
- [Módulo de Shipping] Ajuste do rate limit para 4000rpm por x-customer-id para as rotas (GET /merchants/{merchantId}/deliveryAvailabilities,
GET /orders/{orderId}/deliveryAvailabilities, POST /merchants/{merchantId}/order, POST /orders/{orderId}/requestDriver). Veja mais detalhes nesta seção
[Publicado em 12/11/2024]2024/11/11
- [Módulo de Promotion] Inclusão de alerta de validação de limite de percentual de desconto.
[Publicado em 11/11/2024]2024/11/06
[Publicado em 06/11/2024]2024/11/06
- [Módulo de Picking] Inclusão de fluxo de integração e alterações em edição de pedido
[Publicado em 06/11/2024]2024/10/30
- [Módulo de Groceries] Adicionado telefone localizador do cliente (campo
localizer.phone
) no endpoint GET /orders/{id}.
[Publicado em 30/10/2024]2024/10/25
- [Polling de Eventos] Adicionada documentação de referência de api para o parâmetro categories. Mais detalhes na seção de eventos de pedidos.
[Publicado em 28/10/2024]2024/10/24
[Publicado em 24/10/2024]2024/10/22
- [Módulo de Picking] Inclusão de aviso de módulo exclusivo, ciclo de vida de edição e ações do pedido
[Publicado em 22/10/2024]2024/10/15
[Módulo de Orders] Inclusão de novos valores para o campo delivery.mode e novo campo delivery.description[Publicado em 15/10/2024]2024/10/09
[Módulo de Shipping] Inclusão de novo atributo na solicitação de entrega- Inclusão do atributo
delivery.preparationTime
no registro de solicitação de entrega para pedidos fora da plataforma iFood
[Publicado em 09/10/2024]2024/10/09
- [Módulo de Promotion] Inclusão de novos tipos de promoções no módulo de Promotion v1.0
[Publicado em 09/10/2024]2024/09/30
- [Módulo de Orders] Correção na documentação de Detalhes de Pedidos: o campo
dineIn
estava incorretamente nomeado como dinein
.
[Publicado em 30/09/2024]2024/09/19
- [Módulo de Shipping] Inclusão de tracking no módulo de shipping
[Publicado em 19/09/2024]2024/09/18
- [Módulo de Orders] Inclusão do novo tipo de pedido DINE_IN. Foi adicionado um novo valor para campo orderType e também um novo nó nos Detalhes do Pedido
[Publicado em 18/09/2024]2024/09/16
- [Módulo de Picking] Inclusão de link para critérios de homologação de picking
[Publicado em 26/09/2024]2024/09/11
- [Módulo de Item] Publicação do Módulo de Item v1.0
[Publicado em 11/09/2024]2024/09/11
[Publicado em 11/09/2024]2024/09/10
[Módulo de Shipping] Remoção de critério de homologação: Foi removido o critério de homologação referente ao código de confirmação de entrega.[Publicado em 10/09/2024]2024/09/02
[Módulo de Orders] Novo nível de complementos no pedido: Inclusão de novos campos nos detalhes do pedido para identificar o terceiro nível de complementos do item. Essa informação é obrigatória para os parceiros que utilizarem o novo nível do complemento no catálogo dos itens.[Publicado em 02/09/2024]2024/08/29
[Módulo de Orders] Novo Sponsorship:
Foi adicionado um novo Sponsorship chamado CHAIN, que representa um subsídio de responsabilidade da rede (grupo de lojas)[Publicado em 29/08/2024]2024/08/05
- [Módulo de Groceries] Remoção de algumas rotas do módulo de groceries
- [Módulo de Picking] Adição do módulo de picking
[Publicado em 05/08/2024]2024/07/11
[Módulo de Financial] Atualização API v3:- Atualização em toda a documentação da v3 e inclusão de casos de usos
[Módulo de Orders] Inclusão de novos Tipos de Pedido:
Foi adicionado o campo category
no payload que apresenta informação do Tipo de Categoria de um pedido. De acordo com cada Categoria, o pedido poderá ter diferentes ciclos de vida. Mais detalhes na seção de categorias de pedido e também seção de ciclo de vida do pedido [Publicado em 11/07/2024]2024/07/04
[Polling de Eventos] O evento BOX_ASSIGNED será removido do polling de eventos na próxima atualização. Esta ação visa melhorar a performance da plataforma. Mais detalhes na seção de eventos de pedidos.[Publicado em 19/06/2024]2024/06/27
[Módulo de Financial] Inclusão de descrição ocorrências e impacto no repasse na reconciliação:
Foram adicionados os campos impacto_no_repasse
que apresenta informações se o evento financeiro tem ou não impacto no repasse do parceiro e descricao_ocorrencia
para os casos em que há ocorrência no pedido.[Publicado em 27/06/2024]2024/06/20
[Módulo de Catálogo] Criação de pizza via API v2 agora aceita que seja especificado a foto da pizza. Isso é feito através do
campo imagePath
nos produtos do tipo SIZE
na api PUT Item
. A documentação do fluxo de criação de pizza foi adequada
para exibir essa modificação.[Publicado em 20/06/2024]2024/06/07
[Módulo de Orders] As integradoras, junto aos parceiros integrados, terão até 7 de Junho de 2024 para realizar os ajustes necessários para a ativação da Rota Devolução de pedidos. Atenção para a adição dos eventos DELIVERY_RETURNING_TO_ORIGIN, DELIVERY_RETURNED_TO_ORIGIN e DELIVERY_RETURN_CODE_REQUESTED de status do delivery e código de confirmação da devolução. Mais detalhes na seção de eventos de pedidos e no artigo.[Publicado em 17/05/2024]2024/05/13
[Módulo de Catalog] Adicionado especificação para campo tags
no objeto GetItemDto
.
Mais detalhes na documentação de Catálogo.[Publicado em 16/05/2024]2024/05/01
[Módulo de Financial] Inclusão de pedidos cancelados antes de serem faturados no endpoint de sales:
A partir do dia 01/05/2024, estaremos disponibilizando no endpoint de sales os pedidos que foram cancelados antes de serem faturados pelo iFood.[Publicado em 24/04/2024]2024/04/30
[Módulo de Catalog] Criação da API v2.0 de Catalog- Nova versão da API de Catalog: Nesta versão simplificamos a estrutura das requisições possibilitando a criação de um item com apenas uma request, reformulamos a estrutura de pizzas deixando o processo de criação e alteração mais simples e unificamos a gestão de vários cardápios. Esta nova versão entra em vigor a partir do dia 30/04/2024, data em que será descontinuada a v1.0 da API de Catalog. Mais detalhes na seção Catalog V2
- Módulo Multisetup: O módulo de Multisetup será removido no dia 30/04/2024, todas as funcionalidades deste módulo estão englobadas na nova versão da API de Catalog.
[Publicado em 13/02/2024]2024/04/30
[Módulo de Catalog] Criação da API v2.0 de Catalog- Nova versão da API de Catalog: Nesta versão simplificamos a estrutura das requisições possibilitando a criação de um item com apenas uma request, reformulamos a estrutura de pizzas deixando o processo de criação e alteração mais simples e unificamos a gestão de vários cardápios. Esta nova versão entra em vigor a partir do dia 30/04/2024, data em que será descontinuada a v1.0 da API de Catalog. Mais detalhes na seção Catalog V2
- Módulo Multisetup: O módulo de Multisetup será removido no dia 30/04/2024, todas as funcionalidades deste módulo estão englobadas na nova versão da API de Catalog.
[Publicado em 13/02/2024]2024/04/25
[Módulo de Orders] Inclusão de novos eventosAdicionado documentação para os eventos exclusivos de Mercado SEPARATION_STARTED
e SEPARATION_ENDED
, mais detalhes na seção de eventos de ORDER_STATUS.[Publicado em 25/04/2024]2024/04/22
- [Módulo de Orders] Inclusão do atributo
order.shortId
nas respostas de Listagem e Detalhamento de avaliações no Módulo Review v1.0
[Publicado em 22/04/2024]2024/04/08
- [Módulo de Groceries] Publicação do Módulo de Groceries v1.0
[Publicado em 08/04/2024]2024/04/05
[Módulo de Merchant] Inclusão de novos endpoints:
A partir do dia 05/04/2024, estaremos disponibilizando novas funcionalidades que permitirão aos usuários consultar e gerenciar os horários de funcionamento das lojas, com foco no iFood Marketplace. Duas novas rotas serão introduzidas, uma de GET /merchant/v1.0/merchants/{merchantId}/opening-hours que permitirá consultar os horários de funcionamento das lojas e uma de PUT /merchant/v1.0/merchants/{merchantId}/opening-hours que deverá ser utilizada para criar ou atualizar os horários de funcionamento das lojas associadas ao comerciante especificado. Certifique-se de utilizar as credenciais corretas para autenticação antes de fazer qualquer chamada aos novos endpoints.[Publicado em 04/04/2024]2024/04/04
[Módulo de Financial] Inclusão da API de Liquidação v3.0- Foi adicionada a documentação relacionada a v3.0 da liquidação
- Inclusão da collection da v3.0 de Financial
- Fix da collection v2.1 de Financial
[Módulo de Financial] Correções na documentação- Foi alterado o campo id_periodo para título no arquivo v3, devido a isso foi feita a alteração na documentação
- Foi alterado o formato do arquivo na documentação, alterado de
.zip
para .gz
.
[Publicado em 04/04/2024]2024/03/30
[Módulo de Events] Inclusão de novos endpoints: A partir do dia 30/03/2024 estará disponível para uso as rotas GET events/v1.0/events:polling e POST events/v1.0/events/acknowledgment para consultar eventos de qualquer pedido relacionado ao merchant autenticado, como atualizações de status e informações relacionadas a pedidos na plataforma. Esses novos endpoints foram criados para substituir os endpoints /order/v1.0/events:polling e /order/v1.0/events/acknowledgment.
Os endpoints do módulo de Order continuarão disponíveis na API, não estabelecemos uma data ainda para removê-los, por enquanto, apenas retiramos da documentação de Order e movemos para o módulo de Events, para que as novas integrações já utilizem o módulo de Events.[Publicado em 12/03/2024]2024/03/25
[Módulo de Financial] Inclusão da Reconciliação v3.0- Foi adicionada a documentação relacionada a v3.0 da reconciliação
- Inclusão de nova página onde é possível acessar as duas versões ativas das APIs em Financial v.2 e v.3
[Publicado em 25/03/2024]2024/02/19
[Módulo de Eventos] Lançamento WebhookEstá disponível o recurso de Webhook, para todas as integradoras que possuem aplicativos centralizados. Com isso, é possível que as integradoras otimizem suas integrações e recebam pedidos e eventos quase em tempo real. Isso permite uma melhor experiência para as lojas parceiras e consumidores que também terão seus pedidos confirmados muito mais rapidamente.O webhook, é a solução recomendada em situações onde a integradora tem acesso a vários merchants e faz o gerenciamento dos pedidos de forma centralizada. Por isso o recurso só está disponível para aplicativos centralizados. Com isso podemos evitar múltiplas chamadas sem sucesso no endpoint de polling.Para maiores detalhes, consulte a seção Webhook Overview[Publicado em 19/02/2024]2024/02/15
[Módulo de Merchant] Mudança no valor máximo do parâmetro size do endpoint GET /merchant/v1.0/merchants: A partir do dia 15/02/2024 o valor máximo aceito será "100". Caso a integradora informe um valor superior ao valor máximo receberá o erro "400 - Parameter size exceeds the maximum allowed limit of 100".[Publicado em 22/01/2024]2024/01/26
[Módulo de Orders] Adição do evento DELIVERY_RETURN_CODE_REQUESTED
de decisão e código de confirmação da devolução. Mais detalhes na seção de eventos de pedidos.[Publicado em 26/01/2024]2023
2023/11/13
[Módulo de Shipping] Novos endpoints para confirmação de endereço, solicitação/aceite/rejeite de alteração de endereço
Serão disponibilizados novos endpoints para confirmar/solicitar alteração de endereço da entrega pelo consumidor e confirmação/validado, propagaremos o evento da solicitação de alteração pela loja. Esta funcionalidade estará vigente a partir do dia 13/11/2023, ou seja, os parceiros integrados que contratarem os serviços de Entrega Fácil precisarão receber a resposta do consumidor e ter a opção de aceitar/rejeitar o pedido de alteração de endereço. Para maiores informações consulte a documentação disponível em detalhes da seção[Módulo de Shipping] Uso de Código de Confirmação de Entrega para pedidos com acesso a Página de rastreio do iFood
A partir do dia 13/11/2023 os pedidos que informarem o número de telefone do consumidor final e tiverem acesso a página de rastreio do iFood, o entregador iFood solicitará ao consumidor final o código de confirmação de entrega, caso deseje que o pedido não solicite o código de confirmação, enviar customer.phone.type="STORE"
. Conforme detalhes da seção.[Módulo de Shipping] Uso de Código de Confirmação de Entrega para pedidos sem acesso a Página de rastreio do iFood
A partir do dia 13/11/2023 os pedidos que informarem o número de telefone do consumidor final e não tiverem acesso a página de rastreio do iFood,
deverão consumir o atributo metadata.CODE
do evento DELIVERY_DROP_CODE_REQUESTED
para que o código de confirmação seja repassado para o consumidor final,
o entregador iFood solicitará o código de confirmação de entrega, caso deseje que o pedido não solicite o código de confirmação, enviar customer.phone.type="STORE"
. Conforme detalhes da seção.[Módulo de Shipping] Validação do código de confirmação de entrega
A partir do dia 13/11/2023 os pedidos que exigirem o código de confirmação de entrega quando tiverem o código validado com sucesso durante a entrega receberão o evento DELIVERY_DROP_CODE_VALIDATION_SUCCESS
no polling de eventos.
Mais detalhes na seção de eventos de pedidos.[Publicado em 09/08/2023][Módulo de Shipping] Novo endpoint para disponibilizar os níveis de confiança na entrega
Para aprimorar a visibilidade de 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. Será disponibilizado um novo endpoint contendo o nível de confiança na entrega e o status das regras aplicadas. Para maiores informações consulte a documentação disponível em detalhes da seção[Publicado em 24/08/2023]2023/10/31
[Módulo de Orders] Ajustes nas rotas da API da Plataforma de Negociação para PedidosCom objetivo de padronizar as rotas da Plataforma de Negociação para Pedidos, os endpoints abaixo foram atualizados:- accept: /order/v1.0/disputes/{disputeId}/accept
- reject: /order/v1.0/disputes/{disputeId}/reject
- alternative: /order/v1.0/disputes/{disputeId}/alternatives/{alternativeId}
Para maiores detalhes, consulte a seção Plataforma de Negociação para Pedidos[Publicado em 31/10/2023][Módulo de Catalog] Ajustes da API v2.0 de Catalog- Ajuste dos campos de imagem nos endpoints de produto: Ajustamos o upload de imagem para os endpoints POST/PUT de produtos e PUT de item. Agora é possível fazer o upload de imagens separadamente e utilizar apenas o campo
imagePath
nos endpoints de produto e item. Consulte a seção Upload de imagens - Adição do endpoint updateOptionGroup: Adicionamos na nova versão um endpoint requisitado por alguns parceiros que serve para alterar o nome de um option group.
[Publicado em 27/09/2023]2023/10/17
[Módulo de Financial] Atualização das informações de Financial
Houve uma atualização completa da documentação de Financial e também foi adicionado a v2.1 que já se encontrava em Produção.[Módulo de Orders] Cancelado pelo ClienteInclusão da informação sobre a descontinuação da abordagem atual do Handshake de Cancelamento, destacando a importância de utilizar a Plataforma de Negociação de Pedidos[Publicado em 17/10/2023]2023/10/02
[Módulo de Shipping] Mudança do nome do produto conhecido como iFood entrega/Entrega Fácil para Sob Demanda
Mudamos o nome do produto iFood entrega/Entrega Fácil para Sob Demanda após a unificação dos mesmos detalhes da seção.[Publicado em 29/08/2023][Módulo de Shipping] Unificação da entrega Sob Demanda com o iFood entrega
Estamos realizando a unificação do Sob Demanda junto ao iFood entrega, remodelamos a estrutura de solicitação de entrega para pedidos dentro da plataforma ifood. Esse novo modelo de contratação dos serviços de entrega entrará em vigor a partir de 02/10/2023, é importante ressaltar que os endpoints antigos utilizados na contratação do Sob Demanda serão descontinuados na data de 20/11/2023. Para maiores informações consulte a documentação disponível em detalhes da seção.[Módulo de Orders] Solicitação de entrega do módulo de order será descontinuada
O fluxo de solicitação de entrega existente hoje no módulo de order será descontinuado na data de 20/11/2023.[Publicado em 29/08/2023][Módulo de Orders] Aumento do Limite de Caracteres para Observações de Itens
Estamos atualizando o campo items.observations
da Order Details para melhor atender às necessidades dos clientes. O limite de caracteres que atualmente é de 300 será aumentado para 1024 caracteres. Essa melhoria permitirá informações mais completas e descritivas em relação aos itens sejam fornecidas.[Publicado em 02/10/2023]2023/09/29
[Módulo de Financial] Atualização na API de sales- Foi adicionado o campo
initialTotalBag
contendo o valor da cesta no momento do checkout e confirmação de pagamento.
[Publicado em 29/09/2023]2023/09/28
[Módulo de Orders] Plataforma de Negociação para pedidosAtualização dos endpoints e melhoria na documentação.[Publicado em 28/09/2023]2023/09/26
[Módulo de Orders] Inclusão da Plataforma de Negociação para pedidosA Plataforma de Negociação para Pedidos é uma ferramenta destinada a facilitar, gerenciar e agilizar negociações entre duas partes, com o propósito de resolver questões relacionadas a PEDIDOS. Ela atua como intermediária e possibilita uma comunicação eficaz entre as partes envolvidas, permitindo a troca de propostas e facilitando a busca por acordos de forma eficazA Plataforma é composta pelos seguintes eventos e endpoints:Eventos:- HANDSHAKE_DISPUTE
- HANDSHAKE_SETTLEMENT
Endpoints:Esta nova funcionalidade estará disponível a partir do dia 26/09/2023.Mais detalhes na seção de Plataforma de Negociação de Pedidos.AtençãoA partir do dia 24/03/2024, os eventos e endpoints abaixo serão descontinuados:Eventos:- CONSUMER_CANCELLATION_REQUESTED
- CONSUMER_CANCELLATION_ACCEPTED
- CONSUMER_CANCELLATION_DENIED
Endpoints:- acceptCancellation
- denyCancellation
[Publicado em 26/09/2023]2023/08/17
[Módulo de Financial] Atualização na API PaymentDetails- Adicionados os campos
refundType
, refundValue
e refundDate
com informações de quando o pagamento foi estornado e se foi estornado. refundType: representa onde foi realizado o estorno, pode conter os valores ORIGEM (estorno realizado diretamente no emissor do cartão) ou WALLET (estorno feito pelo iFood na wallet do consumidor); refundValue: valor que foi estornado para o consumidor; refundDate: data em que foi estornado a transação para o consumidor
[Publicado em 17/08/2023]2023/06/06
[Módulo de Financial] Atualizações nas APIs de salesAdjustments, chargeCancellations e cancellations- Adicionado nas 3 APIs os campos
cancellationCode
e cancellationCodeDescription
que representam o código e a descrição do motivo do cancelamento.
2023/06/01
[Módulo de Financial] Atualizações nas APIs de sales, period e payment- Sales: Adição de um campo
metadata
contendo o id interno do iFood Mercado. Conforme detalhes da seção. - Period: A atualização traz um novo campo, "status". O campo informa se um determinado período está em
ABERTO
, ou seja, ainda aguarda a adição de um ou mais lançamentos financeiros. Caso todos os lançamentos financeiros já tenham sido processados, o status indicado será FECHADO
. Conforme detalhes da seção. - Payment: Inclusão dos valores residuais do repasse que não sofreram aplicação de efeito de contrato (ReceivableRecords) e que são direcionados para o estabelecimento e remoção dos repasses com status
DEADEND
. Mais detalhes no guia de pagamentos. - Payment: Adicionado novo campo "type", que indica o tipo de pagamento. Exemplos:
CREDITO_DEBITO
, PIX
. Conforme detalhes da seção.
[Publicado em 01/06/2023]2023/05/15
[Módulo de Orders] Atualização dos nomes dos eventos do fluxo de Cancelamento de Entrega Sob Demanda:
Foram alterados os nomes dos eventos DELIVERY_CANCELLATION_ACCEPTED e DELIVERY_CANCELLATION_REJECTED para DELIVERY_CANCELLATION_REQUEST_ACCEPTED e DELIVERY_CANCELLATION_REQUEST_REJECTED.[Publicado em 15/05/2023]2023/04/25
[Módulo de Orders] Adição do campo delivery.pickupCode
nos detalhes do pedido, o que permitirá ao parceiro a validação do código de coleta que será informado pelo entregador no momento da retirada do pedido. Mais detalhes na seção de detalhes de pedidos.
Importante: Para parceiros integrados não será exigido neste primeiro momento a validação do código de coleta, planejaremos um rollout gradativo e controlado o qual comunicaremos antecipadamente.[Publicado em 25/04/2023]2023/04/03
[Módulo de Orders] Novo Endpoint de Cancelamento de Entrega Sob Demanda:
Para merchants parceiros que possuem entrega própria e que eventualmente contratam o serviço de Entrega Sob Demanda do iFood, em alguns casos pode ser necessário o cancelamento da solicitação de um entregador iFood. Neste caso, a loja pode cancelar somente a entrega sob demanda sem a necessidade de cancelar o pedido, para isso será disponibilizado um novo endpoint POST /orders/{id}/cancelRequestDriver
.[Publicado em 30/03/2023]2023/02/06
- [Módulo de Pedidos] Inclusão de novos eventos relacionados a alteração de endereço de entrega:
DELIVERY_ADDRESS_CHANGE_REQUESTED
, DELIVERY_ADDRESS_CHANGE_USER_CONFIRMED
, DELIVERY_ADDRESS_CHANGE_ACCEPTED
e DELIVERY_ADDRESS_CHANGE_DENIED
. Mais detalhes na seção de eventos de pedidos.
Eventos exclusivos para pedidos iFood Entrega
Os eventos de DELIVERY_ADDRESS são exclusivos para pedidos do iFood Entrega (salesChannel:"POS"
).[Publicado em 31/01/2023]2023/01/19
[Módulo de Orders] Remoção de informação: Remoção da informações do campo delivery.observations
vinculadas a entrega sem contato devido ao COVID.[Publicado em 19/01/2023]2023/01/06
[Módulo de Catálogo] Adição de campo: Quando tentar criar um produto com 1 external code já exista para um merchant o comportamento padrão é reutilizar o produto já existente com esse mesmo external code e agora além de retornar o id do produto existente, também retornará os options groups já associados a ele.
Novos endpoints: Agora é possível buscar produtos por external code ou diretamente pelo seu ID. GET /merchants/{merchantId}/products/externalCode/{externalCode} e GET /merchants/{merchantId}/product/{productId}[Publicado em 06/01/2023]2023/01/04
[Módulo de Orders] Adição de campos: benefits[n].campaign.id
e benefits[n].campaign.name
nos detalhes do pedido que permitirá identificar as informações da campanha que originou os subsídios de um pedido. Essa informação não é obrigatória, mas é relevante para alguns parceiros que utilizam participam de várias campanhas com políticas diferentes.Exemplo:"benefits": [
{
"value": 10,
"target": "CART",
"sponsorshipValues": [
{
"name": "IFOOD",
"value": 0,
"description": "Incentivo do iFood"
},
{
"name": "MERCHANT",
"value": 10,
"description": "Incentivo da Loja"
}
]
},
{
"value": 4.99,
"target": "DELIVERY_FEE",
"sponsorshipValues": [
{
"name": "EXTERNAL",
"value": 4.99,
"description": "Incentivo da Indústria"
},
{
"name": "MERCHANT",
"value": 0,
"description": "Incentivo da Loja"
}
]
},
{
"value": 4.99,
"target": "ITEM",
"targetId": "1",
"sponsorshipValues": [
{
"name": "IFOOD",
"value": 4.99,
"description": "Incentivo do iFood"
},
{
"name": "MERCHANT",
"value": 0,
"description": "Incentivo da Loja"
}
],
"campaign": {
"id": "42cea1aa-1e23-4741-b48a-300716de08de",
"name": "my campaign name"
}
}
]
[Publicado em 19/12/2022]2022
2022/12/06
[Módulo de Orders] Adição de campo: additionalFees.liabilities
nos detalhes do pedido que permitirá identificar os atores para os quais as taxas serão direcionadas. Esse dado permitirá definir o tratamento correto desse valor no documento fiscal bem como na conciliação dos valores. O campo name
indica o nome do ator e percentage
indica o percentual da taxa.
Exemplo:"additionalFees": [
{
"type": "SMALL_ORDER_FEE",
"description": "Taxa de Serviço",
"fullDescription": "Taxa de serviço cobrada quando o valor do pedido é inferior ao pedido mínimo.",
"value": 1.00,
"liabilities": [
{
"name": "IFOOD",
"percentage": 50
},
{
"name": "MERCHANT",
"percentage": 50
}
]
}
]
Esse campo foi criado para identificar o destino da taxa adicional. Caso a taxa seja destinada ao Merchant, o valor da taxa deve compor o documento fiscal e consequentemente será tributado. Caso a taxa seja destinada ao IFOOD, o valor da taxa não deve compor o valor total do documento fiscal.[Publicado em 08/11/2022][Módulo de Orders] Mudança de valor de campo: customer.segmentation
. Esse campo recebia os valores referentes à segmentação de clientes (Explorer, Bronze, Silver, Gold, Platinum). Com a mudança na política de segmentação, os novos valores possíveis serão: "Cliente" e "Super Cliente"."customer": {
"id": "50647eee-5eb6-41a2-b2d8-999998ed677f",
"name": "Nome do Cliente",
"documentNumber": "07544829999",
"ordersCountOnMerchant": 8,
"phone": {
"number": "0800 608 1015",
"localizer": "27534642",
"localizerExpiration": "2020-01-01T00:00:00.000Z"
},
"segmentation": "Cliente"
}
[Publicado em 08/11/2022]2022/11/29
- [Módulo de order] Foi atualizado a documentação, foi alterado tabela com os códigos de cancelamento disponíveis para as integradoras, removendo o código 513, que não é mais utilizado na política de cancelamento.
[Publicado em 29/11/2022]2022/11/21
- [Módulo de Reviews] O endpoint
/review/v1.0/merchants/{merchantId}/reviews
passa a retornar as informações de avaliações em D-1, com o objetivo de garantir que todas as avaliações sejam previamente validadas, evitando a publicação de conteúdo impróprio, avaliações falsas e demais validações previstas na nossa política de avaliação.
[Publicado em 25/11/2022]2022/11/17
[Publicado em 17/11/2022]2022/10/24
- [Módulo de Catálogo] Adição do módulo Multi Setup.
- [Módulo de Catálogo] Adição das seções de sellable e unsellable items .
- [Módulo de Catálogo] Adição do módulo Multi Setup e adição das seções de sellable e unsellable items.[Publicado em 24/10/2022]
- [Módulo de Orders] Novo Endpoint de Políticas de Cancelamento
Será disponibilizado um novo endpoint
GET /order/v1.0/orders/{orderId}/cancellationReasons
para que o merchant possa consultar todos os motivos de cancelamento permitidos para um pedido em um determinado momento. Os motivos permitidos podem variar de acordo com o status e tipo de pedido.
[Publicado em 28/09/2022]- [Módulo de Orders] Adição de campo:
benefits.sponsorshipValues.description
Será adicionado um novo campo nos detalhes de pedidos com a informação que deve ser exibida na tela do aplicativo e impressa na comanda do pedido para cada tipo de cupom/voucher que permite que o merchant e o cliente possam identificar o patrocinador do cupom. A partir dessa mudança, o campo benefits.sponsorshipValues.name
poderá receber também o valor EXTERNAL
(além dos valores já existentes atualmente: IFOOD
e MERCHANT
) em pedidos em que a campanha foi patrocinada por exemplo pela indústria.
Exemplo:"benefits": [
{
"value": 10,
"target": "CART",
"sponsorshipValues": [
{
"name": "EXTERNAL",
"value": 10,
"description": "Incentivo da Indústria"
}
]
}
]
[Publicado em 28/09/2022] - [Módulo de Orders] Adição de campo:
additionalFees.description
e additionalFees.fullDescription
Serão adicionados dois novos campos nos detalhes de pedidos com as informações que devem ser exibidas na tela do aplicativo e impressa na comanda do pedido para cada tipo de taxa adicional que permite que o merchant e o cliente possam identificar o tipo de taxa.
Exemplo:"additionalFees": [
{
"type": "SMALL_ORDER_FEE",
"description": "Taxa de Serviço",
"fullDescription": "Taxa de serviço cobrada quando o valor do pedido é inferior ao pedido mínimo.",
"value": 1.00
}
]
[Publicado em 28/09/2022]
2022/10/06
- [Módulo de Financial] Inclusão do novo campo
transactionCode
na Api de Payments.
2022/10/03
- [Módulo de Financial] Mudança na composição do valor
billing.totalCredit
Atendendo às mudanças nas políticas do Programa de Alimentação do Trabalhador (PAT), não será computado no endpoint /sales
as informações referentes ao crédito do valor em pedidos pagos utilizando o cartão iFood Benefícios, esta alteração será feita gradativamente para os merchants a partir desta data.
[Publicado em 05/10/2022]2022/09/09
- [Módulo de Financial] Mudança no campo
smallOrderFee
nas APIs de Sales e Adjustments, que agora recebe o valor da soma de todas a taxas de serviço do Billing;
2022/09/05
- [Módulo de Pedidos] Inclusão de novos eventos relacionados a logística reversa:
DELIVERY_RETURNING_TO_ORIGIN
e DELIVERY_RETURNED_TO_ORIGIN
. Mais detalhes na seção de eventos de pedidos.
2022/08/26
- [Módulo de Financial] Adicionada a informação de data esperada de pagamento
expectedPaymentDate
na API de salesAdjustments.
2022/08/25
- [Módulo de Catálogo] Adição de rate-limit no endpoint de PUT de produto: será adicionado um rate-limit que não permitirá a edição do mesmo produto (
product_id
) no intervalo de 30 segundos.
2022/08/17
- [Módulo de Pedidos] Inclusão dos eventos relacionados a agrupamento de entrega:
DELIVERY_GROUP
. Mais detalhes na seção de eventos de pedidos.
2022/08/09
- [Módulo de Financial] Adicionada informação do novo campo
referencePeriodId
no payload da API de occurrences.
2022/07/27
- [Módulo de Pedidos] Mudança na forma como o serviço responsável pelo endpoint
GET /order/v1.0/events:polling
gerencia as sessões dos clientes (sem impactos para os usuários da API)
2022/07/21
- [Módulo de Catálogo] Mudanças na API de criação e edição de Inventário, adição do campo opcional
allowNegativeStock
no PostInventoryItemDTO, deve ser utilizado para permitir que seus itens sejam vendidos mesmo quando o estoque estiver abaixo de zero.
2022/06/20
- [Módulo Reviews] O endpoint
/review/v1.0/merchants/{merchantId}/summary
passa a retornar 404 quando o merchant consultado não tiver nenhuma avaliação.
2022/06/15
- [Módulo de Financial] Inclusão de InvalidRolloutDateRangeException como retorno da API de sales utilizando os filtros LastProcessingDate e OrderDate com intervalos antes e pós rollout.
2022/06/06
- [Módulo de Catálogo] Mudanças nas API de Patch de itens e options para contemplar novo paradigma de hierarquia de catálogos adicionando novo parâmetro opcional de id de catálogo.
2022/05/30
- [Módulo de Pedidos] Novo valor disponível para o campo campo
salesChannel
: ECONOMIC
.
2022/05/23
- [Módulo de Pedidos] Inclusão do campo
merchantId
nos eventos de pedidos retornados pelo endpoint /order/v1.0/events:polling
.
2022/05/20
- [Módulo de Financial] Inclusão do campo
salesChannel
na API de sales.
2022/05/17
- [Módulo de Shipping] Adicionada as informações sobre Critérios para Homologação iFood Entrega (shipping). Veja mais detalhes nesta seção
- [Support-FAQ] Atualizadas as questões de FAQ do iFood Entrega.
2022/05/02
- [Módulo de Pedidos] Atualizada a documentação do campo
customer.ordersCountOnMerchant
nos detalhes do pedido reforçando os casos em que o campo é opcional e pode retornar null
.
2022/03/22
- [Módulo de Pedidos] Fix do campo
benefits.targetId
no endpoint de detalhes do pedido. Por uma falha, esse campo estava trazendo um id que muitas vezes (mas nem sempre) coincidia com o id do item. Quando se tem 2 itens iguais no mesmo pedido não era possível identificar em qual item foi aplicado o desconto. Com a alteração, o campo volta a exibir o index
do item como anteriormente.
2022/03/21
- [Módulo de Catálogo] Incluído o campo
groupId
no endpoint [GET /{merchantId}/catalogs]
2022/03/14
- [Módulo de Catálogo] Mudanças nas API de edição de Pizza, criação do campo imagemPath no ToppingDto, deve ser utilizado quando não existe a intenção de remover ou atualizar a imagem da Pizza, neste caso é só informar o imagePath que é retornado no método de Get Pizza.
2022/02/24
- [Módulo de Catálogo] Mudanças nas APIs de status e price em batch para utilizar productId ou externalCode como identificadores para atualização de itens e complementos.
2022/02/11
- [Módulo de Financial] Mudança na disponibilização dos dados que passará a ocorrer diariamente e os dados ficarão disponíveis às 18h. Veja mais detalhes nesta seção.
2022/01/21
- [Módulo de Pedidos] Incluído o campo
unauthorizedMerchants
nas respostas 403 do endpoint GET /events:polling
quando informado no filtro x-polling-merchants
merchants cujo token não tem permissão.
2022/01/10
- [Módulo de Catálogo] Adição das APIs de inventário de produtos.
- [Módulo de Catálogo] Adição de atributo Item Tag.
2022/01/04
- [Módulo de Pedidos] Depreciação dos Eventos de DELIVERY_GROUP relacionados à agrupamento de entregas.
2021
2021/12/13
- [Módulo de Catálogo] Adição do módulo de shelves.
2021/12/02
- [Módulo de Catálogo] Adição de exemplos nos preços nas APIs de pizza.
- [Módulo de Financial] Adição da nova API de
PaymentDetails
no endpoint GET /merchants/{merchantId}/paymentDetails que lista os pagamentos por paymentDate e status.
2021/11/11
- [Módulo de Pedidos] Inclusão de novo campo em detalhes de pedido
item.scalePrices
contendo informações sobre quantidades mínimas e preços para venda de itens em atacado.
2021/11/04
- [Módulo de Pedidos] Inclusão do novo endpoint /startPreparation para informar o início de preparo do pedido.
2021/10/26
- [Módulo de Shipping] Publicação do Módulo de Shipping v1.0
2021/09/21
- [Módulo de Pedidos] Correção das informações do campo
delivery.observations
que por uma falha estavam sendo retornadas no campo extraInfo
.
2021/09/15
- [Módulo de Pedidos] Adição do grupo
additionalInfo
com campo metadata (chave, valor) que permite que o merchant inclua informações de interesse próprio nos pedidos enviados para a plataforma.Detalhes do campo aqui.
2021/09/02
- [Módulo de Financial] Adição da nova API de
Period
no endpoint [GET /merchants/{merchantId}/periods?competence={competence}
] que lista os períodos por competência.
2021/07/06
- [Módulo de Financial] Inclusão do campo
merchantsConsolidated
na API de payments. Além disso, ao buscar por um merchant consolidado, além de da API retornar o array vazio, será retornado no header Location da requisição a informação do ID do merchant consolidador.
2021/06/30
- [Módulo de Pedidos] Adição do campo
items.imageUrl
com a url da imagem do item (quando houver). - [Módulo de Pedidos] Adição dos campos
items.addition
e items[].options.addition
com valores adicionais que podem ser incluídos eventualmente em algum item.
2021/06/17
- [Módulo de Pedidos] Adição do endpoint para solicitar serviço de entrega para um pedido específico: requestDriver
2021/05/24
- [Módulo de Pedidos] Inclusão do campo
total.additionalFees
- taxa de serviço que pode ser cobrada em alguns pedidos - [Módulo de Pedidos] Alteração no cálculo do campo
total.orderAmount
incluindo o valor do total.additionalFees
- [Módulo de Pedidos] Inclusão do grupo
additionalFees
- detalhes das taxas adicionais
2021/05/20
- Publicação do Módulo de Avaliações v1.0
2021/05/14
- [Módulo de Financial] Inclusão dos campos
description
, documentNumber
e transactionDateTime
na API de occurrences - [Módulo de Financial] Inclusão dos campos
orderDateTime
, lastProcessingDateTime
na API de sales
2021/05/04
- [Módulo de Autenticação] Alteração na expiração do refreshToken de 60hrs para 168hrs (1 semana)
2021/04/20
- [Módulo Pedidos] Adição do campo de ponto de referência (
reference
) no grupo do endereço de entrega (delivery.deliveryAddress
) no endpoint de detalhes do pedido - [Módulo de Catálogo] Ajuste dos campos de data (como
modifiedAt
) para retornar datetime ao invés de timestamp
2021/03/01
- Publicação do Módulo de Autenticação v1.0
- Publicação do Módulo de Merchant v1.0
- Publicação do Módulo de Catálogo v1.0
- Publicação do Módulo de Pedidos v1.0
- Publicação do Módulo de Financeiro v1.0