Search in documentation

Modules

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Solutions

Introduction

iFood APIs allow partners to use various platform resources such as managing their stores and orders. iFood offers solutions for operation and sales management like Order Manager and Partner Portal, but the API allows integrating your PDV/POS or any other application to the iFood platform.

API modules

APIs are organized into modules and the developer can choose which modules they want to deliver according to their application or user needs. Some modules support various business models but there are modules that are specific to some type of business like markets.

Module	Description	Business	Documentation
Authentication	How to authenticate to have access to API resources	FOOD, GROCERIES	See documentation
Merchant	Store details and configurations	FOOD, GROCERIES	See documentation
Catalog	Configure your store's product catalog	FOOD	See documentation
Events	Receive order events via polling or webhook	FOOD, GROCERIES	See documentation
Order	Receive, confirm and track your orders	FOOD, GROCERIES	See documentation
Shipping	On Demand: request iFood partner delivery drivers for orders captured outside the platform	FOOD, GROCERIES	See documentation
Logistics	Integrate orders to execute delivery services	FOOD	See documentation
Item	Send and update Groceries catalog items	GROCERIES	See documentation
Picking	Order separation and item rupture process	GROCERIES	See documentation
Promotion	Create promotions for your store	GROCERIES	See documentation
Review	Receive and respond to customer reviews	FOOD, GROCERIES	See documentation
Financial	Financial Reports and Reconciliation	FOOD, GROCERIES	See documentation

Getting started

To use the APIs the first step is to register as a developer. Upon registration you will have access to a test store and an application that will allow you to test the APIs.After developing and testing your integration, you will need to go through an application homologation process. This homologation process may vary according to the modules used. And after passing the homologation process you must create your production application and receive permission from merchants to use the APIs with that application.

Developer registration

Developing the integration

There are particularities in the integration according to the business model that will operate on the platform. In the links below you find specific guidance for each type of business.

Food

Step by step for Restaurant integration

Groceries

Step by step for Markets and Pharmacies integration

Test orders

Generate test order

How to generate orders to test in the API and validate your integration

Order types

There are different types of orders on the platform and each one requires specific treatments in store operation.

Delivery

Order anatomy

Pickup

Particularities of "Pickup" orders

Scheduled

Particularities of scheduled orders

Application homologation

Homologation criteria

Learn the policies to homologate your application

Application permissions

Request access

See how to request and receive access to store data and use the APIs

Best practices

Article with best practicesIn this article you find several tips with the best practices for using iFood APIs.

Rate limit

See in detail the limits for each API module

Improper use

Avoid blocking your application

Terms of use

To use the API and make applications available, it is necessary for the developer to read and accept the API User Terms of Use. And to use the applications, it is necessary for the store manager to accept the Third Party Application User Terms of Use before granting access to their data through the application.

Was this page helpful?

Rate your experience in the new Developer portal:

On this page