iFood Developer

Search in documentation

Modules

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Solutions

Logistics

Homologation criteria

To perform the application homologation, it must be ready. Tests are performed on the APP as a whole and not only on our API calls.

Homologation requests with Personal/Student account registrations (CPF) will not be accepted. Only requests with Professional account registration (CNPJ).

These criteria are applicable for integrators who wish to integrate exclusively with the Logistics module and perform delivery operations for Merchants.

The application must be able to

Receive order events via polling or via webhook.
- In case of polling:
  - Make requests to the /polling endpoint regularly to not miss any order, passing the excludeHeartbeat parameter to prevent the store from being opened improperly; Use the x-polling-merchants header whenever you need to filter events from one or more merchants. It is also possible to filter the events you want to receive by type and by group;
  - Send /acknowledgment for all received events (with status code 200) immediately after the polling request;
- In case of webhook: respond successfully to webhook requests, verified by our internal audit;
- Update the Driver status, notifying that it was assigned to the Order through the endpoint POST /assignDriver
- Notify the Driver's movement, informing that it is going to the origin address to collect the Order through the endpoint POST /goingToOrigin.
- Confirm that the Driver arrived at the origin address to collect the order through the endpoint POST /arrivedAtOrigin.
- Notify that the Driver collected the order and is on the way to the delivery address through the endpoint POST /dispatch.
- Notify that the Driver arrived at the destination to perform the order delivery through the endpoint POST /arrivedAtDestination.
- Mandatory step for all Integrators. Send the delivery confirmation code through the endpoint POST /verifyDeliveryCode. At this stage, the application must be able to analyze if the order is eligible to perform the code validation by the event "DELIVERY_DROP_CODE_REQUESTED". This event will be generated and sent for each eligible order.

Non-functional requirements

Renew the token only when it is about to expire or immediately after expiration.
The application must respect the rate limit policies of each endpoint.

How to schedule

To schedule the homologation of your application, access the tickets area and open a request for homologation of your application. Our team will contact you to schedule the process.

New attempt Before scheduling the homologation of your application, make sure it meets all the requirements listed above. It is necessary to wait 15 days for a new attempt.

Preparation

Before starting, have your test store data at hand, such as store id and name. Make sure you have access to a stable internet service

Duration

At the scheduled time, an analyst from our team will make remote access to follow each stage of the tests. The process takes an average of 45 minutes.

Rescheduling

If your application is not homologated, our team will record in the ticket the requirements that were not met and you must adjust your software. You can schedule a new homologation 15 days after the previous attempt.

Was this page helpful?

Rate your experience in the new Developer portal:

On this page