Introduction

In addition to being able to receive their order at home, the user can choose to place the order through iFood and pick it up at the restaurant. Pickup can be done at the counter, drive-thru or even at a special spot.Learn all the details about this feature on the Partner Portal.How to enable For pickup To enable this feature for your store, access the Partner Portal and then click on the "Services" menu. There you will find all the necessary instructions.

Integration

"For Pickup" orders require specific behavior from your application and its users. Following are the necessary guidelines to homologate this functionality in your application.

How to identify a "For pickup" order

For these orders, the orderType field in the order detail will be filled with the value "TAKEOUT".

Don't treat a "For Pickup" order as a "Delivery" order It's important that you differentiate this type of order, because unlike a "DELIVERY" order, your application should not dispatch a "For pickup" order.

What changes in order details

In addition to the orderType field mentioned above, in these orders we have the "takeout" group containing the following information:

mode
takeoutDateTime

mode Specifies where the customer will pick up the order.

DEFAULT - When the customer picks up the order at the counter.
PICKUP_AREA - customer will wait to receive the order at a special spot in the establishment (parking / drive-thru)

takeoutDateTime Expected time for order pickup.Ex:

"takeout": {
  "mode": "DEFAULT / PICKUP_AREA:",
  "takeoutDateTime": "2020-01-01T00:00:00.000Z"
}

What changes in the order lifecycle

Order ready for pickup

It is essential that you provide a button for your application user to inform that the "Order is ready for pickup".Unlike a delivery order where your application should send the /dispatch request, in "For pickup" orders you should send the /readyToPickup request to notify the customer that the order is ready to be picked up.When this request is sent, the customer receives a notification in the application informing that the order is ready.

Special spot for order pickup

When the customer chooses to pick up the order at a special spot, upon receiving the notification that the order is ready they should go to the store. As soon as they park in the special spot, they can inform the spot number.

Special spot configuration The use of a special spot for order delivery is optional and the names or numbers of the spots must be informed in the store settings.

As soon as the user informs the spot, you will receive in the next polling the PICKUP_AREA_ASSIGNED event and in the PICKUP_AREA_CODE field you will have the spot number.This should be the number displayed on your application screen so that the attendant can locate the customer and bring the order to them.Example:

{
  "id": "d585214c-b95a-4c4d-9d05-16f7d8f99999",
  "code": "PAA",
  "fullCode": "PICKUP_AREA_ASSIGNED",
  "orderId": "169e6c99-93e9-43b2-981a-498817088888",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "metaData": {
    "PICKUP_AREA_CODE": "1",
    "PICKUP_AREA_TYPE": "NUMBER"
  }
}

Identifying Orders via Self-Service Totem

Orders generated at the Totem must be identified by the category field in the order details with the value: FOOD_SELF_SERVICE.This marker indicates that the order follows the self-service flow for the FOOD category (see lifecycle here).For orders with category = FOOD_SELF_SERVICE, use the orderType field in the order details to direct the service:

TAKEOUT — “Take-out” order: the server must pack for the customer to take away.
DINE_IN — “Dine-in” order: the server must prepare for consumption on-site.

Specific fields when orderType = DINE_IN

Group dineIn in the order details:
- deliveryDateTime

Common questions

How to test "For pickup" orders?

To test table orders, you need to enable "For pickup" for your test store.