Sending orders made on the iFood platform: This module allows merchants to send orders made on the iFood platform (Orders that already have an orderId). This is especially useful for merchants who have their own delivery people, but who may need the iFood delivery service in situations of overload or lack of delivery people. To use this service modality, it must be contracted through the Services menu of the Partner Portal. Otherwise, it will not be possible to register orders, check delivery availability, or request a delivery person.

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/

Sending orders made through other sales channels: The module also allows merchants to send orders that were made through other sales channels, such as telephone, WhatsApp, own app or website (Orders that do not have a pre-existing orderId). For more information about iFood Delivery, visit Sob Demanda out of iFood App

Definitions

Orders on the iFood platform and outside it

Orders on the iFood platform are those that already have an orderId, containing the necessary information from the restaurant and the customer to carry out the quote and request.

On the other hand, orders outside the iFood platform do not have a pre-existing orderId, as they are not originated internally. In this case, additional information is necessary to carry out the quote and request.

Contracting the Service

To use the module, Sob Demanda must be contracted through the Services menu on the Partner Portal. Otherwise, it will not be possible to register orders, check delivery availability or request a delivery person.

Requirements for Homologation

These criteria are applicable only for integrators who wish to integrate exclusively with the Shipping module when contracting delivery services for orders outside the iFood platform. For integrators who also wish to use the Orders module, the Orders homologation criteria applies. For those that are already homologated, it will not be required to do a new homologation in order to use the Shipping module.

The application must be able to

• Make requests on /polling endpoint regularly every 30 seconds;
• Send /acknowledgment signal for every event received after a polling request;
• Receive, confirm and dispatch an Sob Demanda order for now (orderType = DELIVERY / orderTiming = IMMEDIATE / salesChannel = POS);
• Receive and cancel an order delivery for now (orderType = DELIVERY / orderTiming = IMMEDIATE / salesChannel = POS). It is mandatory to provide a list with all the codes/reasons for cancellation provided in the documentation;
• Update the status of an order canceled by the customer or iFood;
• Update the status of an order that may have been confirmed/canceled by another application such as Order Manager;
• Receive the same event more than once in the polling and discard it if this event was delivered more than once;
• Accept or reject an address change.
• Should be able to check the collection code and know if the code has been validated.

Non-functional requirements:

• The token renewing can only be performed when it's about to expire or immediately after it expires.
• The application must respect the rate limit policies of each endpoint.

Desirable:

• The printed tab should follow the model suggested in the documentation.
• Display on the screen and/or printed tab where the delivery person should leave the order (which comes in the delivery.observations field)

Integration Flow

To integrate an order from outside iFood and request a delivery partner, you need to follow the following steps:

Orders outside the iFood platform

Integration Flow

Delivery Availability

Before registering an order external to iFood, it is important to check the availability of delivery. It is possible that the address is not within the coverage area and even if the address is within the area, it is possible that there is some temporary unavailability in the region, such as a temporarily reduced delivery radius. Through this query it is also possible to obtain the estimated time window for the delivery of the order to inform the customer.

To check the logistics availability, just make the GET /deliveryAvailabilities request passing the following parameters:

• merchantId - ID of the merchant that will request delivery
• latitude - latitudinal coordinate of the delivery address
• longitude - longitudinal coordinate of the delivery address

/shipping/v1.0/merchants/123f78cf-2879-44f7-92b7-1e4668dda999/deliveryAvailabilities?latitude=-23.455575&longitude=-46.669957

Responses

Success

This endpoint returns the http status code 200 OK if logistics are available. The response body contains:

• id - quote id
• expirationAt - quote expiration date and time UTC
• createdAt - quote creation date and time UTC
• quote.grossValue - gross delivery value
• quote.discount - delivery discount value
• quote.raise - increase value
• quote.netValue - net delivery value
• deliveryTime.min - minimum estimated delivery time in seconds
• deliveryTime.max - maximum estimated delivery time in seconds
• distance - delivery distance radius in meters (1000, 2000, 3000...)
• preparationTime - preparation time in seconds
• hasPaymentMethods - informs if there are available payment methods
• Could not extract content from url: paymentMethods.id - payment method id
• paymentMethods.brand - credit/debit card brand
• paymentMethods.liability - responsible for receiving the payment (IFOOD)
• paymentMethods.paymentType - type of payment e.g.: OFFLINE
• paymentMethods.method - payment method CREDIT, DEBIT or 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"
    }
  ]
}

Error

This endpoint returns the http status code 400 Bad Request if logistics are not available to deliver the order to this location or from that merchant’s location.

{
  "code": "DeliveryDistanceTooHigh",
  "message": "Sob Demanda not available: the delivery address is more than 10 km from your store",
  "details": ["Delivery distance too high"]
}

This endpoint returns the http status code 500 Internal Server Error in case there is any failure to register this order.

{
  "code": "InternalServerError",
  "message": "Ops. There was a failure. Try again in a few moments.",
  "details": ["Internal server error"]
}

Order Registration

To register an order and request a partner delivery person, simply make the POST /orders passing the order information in the body.

Delivery Confirmation Code

To ensure the security of deliveries and avoid cases of lost orders, a delivery confirmation code will be generated. This code consists of the last 4 digits of the end consumer's phone number provided in the order. The iFood delivery person will request this sequence of numbers when making the delivery.

I don't want my order to have a Delivery Confirmation Code

If you don't have access to the customer's phone number or don't want to provide it, you will need to send customer.phone.type="STORE" so that the delivery confirmation code is not requested.

How to enable the Delivery Confirmation Code

For the order to have the delivery confirmation code enabled, the customer's phone number must be provided and this phone number must be valid, as only then will the customer be able to provide the correct delivery confirmation code to the iFood delivery person.

Partners using the iFood tracking page

The confirmation code will be available on the iFood tracking page so that the end consumer can provide the correct code to the iFood delivery person.

Partners who do not use the iFood tracking page

To provide the confirmation code if you do not use the iFood tracking page, it will be necessary to consume the attribute metadata.CODE from the DELIVERY_DROP_CODE_REQUESTED event so that the code is passed on to the end consumer. This event will be propagated only in situations where the confirmation code is mandatory, therefore if the event is not sent, it means that delivery confirmation will not be necessary.

Order details

Below are all the order fields to be registered on iFood.

Note: Fields marked with an asterisk (*) are mandatory.

Examples

{
  "customer": {
    "name": "Customer Name",
    "phone": {
      "type": "CUSTOMER",
      "countryCode": "55",
      "areaCode": "11",
      "number": "999999999"
    }
  },
  "delivery": {
    "merchantFee": 0,
    "preparationTime": 900,
    "quoteId": "3d2a7e2c-34ad-4b72-9ee5-79cec2b482a7",
    "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"
  }
}

Payment Methods

Offline Payments the delivery person will receive the order amount upon delivery via iFood card machine or in cash depending on the sent method, it is necessary to send the payment object. It is necessary that the quote has this payment method in the list of paymentMethods, otherwise an error will be returned.

Online payments We do not process online payments, this payment is collected by the Merchant, so it is not necessary to send the payment object.

Preparation Time

To improve efficiency and customer satisfaction, the delivery.preparationTime field can be used to indicate the time required to prepare the order before the delivery person is allocated. This field is optional and, if not sent, the current immediate allocation model will be maintained.

How to use Preparation Time

• Without Preparation Time: If the delivery.preparationTime field is not sent, the delivery person will be allocated immediately after the order is confirmed, following the current model.
• With Preparation Time: When the delivery.preparationTime field is sent, the delivery person will be allocated only after the specified preparation time. In this case, the delivery.preparationTime field should be sent with the value corresponding to the necessary time in seconds. For example, if the preparation time is 15 minutes, send delivery.preparationTime=900. This allows the restaurant to have the necessary time to prepare the order before the delivery person is allocated.

Metadata

The metadata field allows you to add supplementary information to the order. This information is not passed on to the driver's app or the order manager.

/shipping/v1.0/merchants/<merchantId>/orders

Responses

Success

This endpoint returns the http status code 202 Accepted if the order is successfully registered and the delivery partner is allocated without any problems. The response body contains:

• id - ID of the created order
• trackingUrl - url of the order tracking page

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

Errors

This endpoint returns the http status code 400 Bad Request in case the logistics are not available to deliver the order or there is a failure to register this order.

{
  "code": "DeliveryDistanceTooHigh",
  "message": "Sob Demanda not available: the delivery address is more than 10 km from your store",
  "details": ["Delivery distance too high"]
}

This endpoint returns the http status code 500 Internal Server Error if there is any failure to register this request.

{
  "code": "InternalServerError",
  "message": "Ops. There was a failure. Try again in a few moments.",
  "details": ["Internal server error"]
}

Confirmation or change of delivery address

Through this flow, the customer can confirm their address or request a change to it. In cases where there is a change in the delivery address, a validation process will occur by the partner, where the approval or refusal of the request will be decided.

Partners using iFood's tracking page

Customers who track their orders through the tracking page provided by iFood have the option to confirm the delivery address or request a change. For this to be possible, it is necessary that the order has not been created with the attribute customer.phone.type="STORE".

Partners who do not use iFood's tracking page

Partners who choose to create their own experience of confirmation or request for change of delivery address must implement the endpoints responsible for this flow.

Address Confirmation

To confirm the address, simply make the request POST /userConfirmAddress passing the following parameters:

• orderId - ID of the order that will have the address confirmed

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

Responses

Success

This endpoint returns HTTP Status 202, with nothing in the response body The polling will receive an event of DELIVERY_ADDRESS_CHANGE_USER_CONFIRMED when the request is successful.

Error

This endpoint returns the http status code 400 Bad Request if the expected parameters are not provided.

{
  "code": "BadRequest",
  "message": "There was a problem reading the information. Check the information sent.",
  "details": [
  "Field 'OrderID' must be in uuid format."
  ]
}

This endpoint returns the http status code 404 Not Found if the order is not found, is completed or canceled, or was created more than 8 hours ago.

{
  "code": "OrderNotFound",
  "message": "Order not found.",
  "details": []
}

This endpoint returns the http status code 409 Operation Conflict if there is a conflict in the operation, such as trying to confirm the address of an order with pending/confirmed/denied change.

{
  "code": "ChangeAddressOperationConflict",
  "message": "There is a conflict in the confirmation/request for address change of this order, it may already have the address confirmed by thecustomer, or a pending/completed change request",
  "details": []
}

This endpoint returns the http status code 500 Internal Server Error if there is any failure to register this order.

Request for address change

When a change of delivery address is requested, an event DELIVERY_ADDRESS_CHANGE_REQUESTED will be generated and sent via polling. This event indicates that the address change has been requested, and the new requested address will be available in the metadata.address attribute.

To request an address change, simply make the request POST /deliveryAddressChangeRequest passing the following parameters:

The parameters marked with * are mandatory

• orderId* the ID of the order that will have the address confirmed
• streetName* the street name to which the address will be changed.
• streetNumber the street number to which the address will be changed.
• complement the complement of the address to which it will be changed.
• reference the reference of the address to which it will be changed.
• neighborhood* the neighborhood to which the address will be changed.
• city* the city to which the address will be changed.
• state* the state to which the address will be changed.
• country* the country to which the address will be changed.
• coordinates* the coordinates to which the address will be changed.
• coordinates.latitude* the latitude to which the address will be changed.
• coordinates.longitude* the longitude to which the address will be changed.

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

Responses

Success

This endpoint returns HTTP Status 202, with nothing in the response body

The polling will receive an event of DELIVERY_ADDRESS_CHANGE_REQUESTED when therequest is successful.

Error

This endpoint returns the http status code 400 Bad Request if the expected parameters are not provided.

{
  "code": "BadRequest",
  "message": "There was a problem reading the information. Check the information sent.",
  "details": [
    "Field 'StreetName' is mandatory.",
    "Field 'Neighborhood' is mandatory.",
    "Field 'City' is mandatory.",
    "Field 'State' is mandatory.",
    "Field 'Country' is mandatory.",
    "Field 'Latitude' is mandatory.",
    "Field 'Longitude' is mandatory."
  ]
}

This endpoint returns the http status code 404 Not Found if the order is not found, is completed or canceled, or was created more than 8 hours ago.

{
  "code": "OrderNotFound",
  "message": "Order not found.",
  "details": []
}

This endpoint returns the http status code 409 Operation Conflict if there is a conflict in the operation, such as trying to confirm the address of an order with pending/confirmed/denied change.

{
  "code": "ChangeAddressOperationConflict",
  "message": "There is a conflict in the confirmation/request for address change of this order, it may already have the address confirmed by the customer, or a pending/completed change request",
  "details": []
}

This endpoint returns the http status code 500 Internal Server Error if there is any failure to register this order.

Address Change Approval

To approve the address change, simply make the request POST /acceptDeliveryAddressChange passing the following parameters:

• orderId - ID of the order that will have the delivery address changed

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

Responses

Success

This endpoint returns HTTP Status 202, with nothing in the response body The polling will receive an event of DELIVERY_ADDRESS_CHANGE_ACCEPTED when the request is successful.

Error

This endpoint returns the http status code 400 Bad Request if the expected parameters are not provided.

{
  "code": "BadRequest",
  "message": "There was a problem reading the information. Check the information sent.",
  "details": [
    "Field 'OrderID' must be in uuid format."
  ]
}

This endpoint returns the http status code 404 Not Found if the order is not found, is completed or canceled, or was created more than 8 hours ago.

{
  "code": "OrderNotFound",
  "message": "Order not found.",
  "details": []
}

This endpoint returns the http status code 409 Operation Conflict if there is a conflict in the operation, such as trying to confirm the address of an order with pending/confirmed/denied change.

{
  "code": "ChangeAddressOperationConflict",
  "message": "There is a conflict in the confirmation/request for address change of this order, it may already have the address confirmed by the customer, or a pending/completed change request",
  "details": []
}

This endpoint returns the http status code 500 Internal Server Error if there is any failure to register this order.

Address Change Deny

To deny the address change, simply make the request POST /denyDeliveryAddressChange passing the following parameters:

• orderId - ID of the order that will have the address change request denied

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

Responses

Success

This endpoint returns HTTP Status 202, with nothing in the response body The polling will receive an event of DELIVERY_ADDRESS_CHANGE_DENIED when the request is successful.

Error

This endpoint returns the http status code 400 Bad Request if the expected parameters are not provided.

{
  "code": "BadRequest",
  "message": "There was a problem reading the information. Check the information sent.",
  "details": [
    "Field 'OrderID' must be in uuid format."
  ]
}

This endpoint returns the HTTP status code 404 Not Found if the order is not found, is completed or cancelled, or was created more than 8 hours ago.

{
  "code": "OrderNotFound",
  "message": "Order not found.",
  "details": []
}

This endpoint returns the HTTP status code 409 Operation Conflict if there is a conflict in the operation, such as trying to confirm the address of an order with a pending/confirmed/rejected change.

{
  "code": "ChangeAddressOperationConflict",
  "message": "There is a conflict in the confirmation/request for address change of this order, it may already have the address confirmed by the customer, or a pending/completed change request",
  "details": []
}

This endpoint returns the HTTP status code 500 Internal Server Error if there is a failure to register this order.

Cancelamento

To cancel a delivery request for orders that are not from the iFood platform, it is crucial to understand some conditions. Firstly, only orders with the salesChannel attribute set as POS can be cancelled. Any order that does not fit this context cannot be cancelled through the Shipping module.

To get the list of valid cancellation codes for an order, you can use the endpoint GET /cancellationReasons.

To perform the cancellation, you must make a request to the endpoint POST /cancel, passing the following parameters:

• orderID - Order Id
• reason - Text with the description of the reason
• cancellationCode - Cancellation code

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

Respostas

Sucesso

This endpoint returns HTTP Status 202, with nothing in the response body The polling will receive a CANCELLATION_REQUESTED event when the request is successful and subsequently the CANCELLED or CANCELLATION_REQUEST_FAILED events in case of success or failure.

Erro

This endpoint returns the http status code 400 Bad Request if the expected parameters are not provided.

{
  "code": "BadRequest",
  "message": "There was a problem reading information. Check the information sent.",
  "details": [
    "Field 'OrderID' must be in uuid format."
  ]
}

This endpoint returns the http status code 500 Internal Server Error if there is a failure when requesting the delivery cancellation.

{
  "code": "InternalServerError",
  "message": "Oops. There was a failure. Try again in a few moments.",
  "details": ["Internal server error"]
}

Delivery Confidence Level

To enhance the security of your delivery, we have developed a set of rules that allow us to qualify the level of confidence in the delivery. This qualification is based on the parameters informed during the creation of the order and on the change or confirmation of the address made by the customer after the creation of the order.

We will have the following levels of confidence in delivery

The calculation of the delivery confidence level will be based on the following rules

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

Order with customer_phone_is_valid:false will have a LOW score.

Order with customer_phone_is_fixed:true will have a MODERATE score.

Order with customer_phone_is_fixed:true and customer_address_confirmed:true will have a VERY_HIGH score.

Order with customer_phone_is_valid:true will have a HIGH score.

Order with customer_phone_is_valid:true and customer_address_change_requested:true and merchant_address_change_approved:true will have a VERY_HIGH score.

Order with customer_phone_is_valid:true and customer_address_change_requested:true and merchant_address_change_denied:true will have a LOW score.

Consulta do nível de confiança na entrega

To find out the level of confidence in the delivery of your order, just send the GET /safeDelivery request passing the following parameters.

• orderId - ID of the order that will have the delivery security level consulted.

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

Respostas

Sucesso

This endpoint returns the http status code 200 OK if the order is eligible for delivery security. The response body contains:

• rules - contains a map of the type [string]boolean containing the rule and situation.
• score - level of confidence in the delivery of the order generated based on the rules defined in the rules field.

{
	"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

This endpoint returns the http status code 400 Bad Request if the expected parameters are not provided.

BadRequest

{
  "code": "BadRequest",
  "message": "There was a problem reading information. Check the information sent.",
  "details": [
    "Field 'OrderID' must be in uuid format."
  ]
}

OrderWithoutSafeDelivery

{
  "code": "OrderWithoutSafeDelivery",
  "message": "Order without delivery confidence rules.",
  "details": []
}

This endpoint returns the http status code 404 Not Found if the order is not found.

{
  "code": "OrderNotFound",
  "message": "Order not found.",
  "details": []
}

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

{
  "code": "InternalServerError",
  "message": "Oops. There was a failure. Please try again in a few moments.",
  "details": ["Internal server error"]
}

Orders on the iFood platform

Integration Flow

Delivery Availability

Before registering a delivery request, it is important to consult the quote/delivery availability. It is possible that the address is not within the coverage area and even if the address is within the area, there may be some temporary unavailability in the region, such as temporarily reduced delivery radius. Through this consultation, it is also possible to obtain the estimated time window for the order delivery to inform the customer.

To consult the logistics quote for a pre-existing order within the iFood platform, just make the request GET /deliveryAvailabilities passing the following parameters:

• orderId - ID of the order already existing on the iFood platform to request delivery

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

Respostas

Sucesso

This endpoint returns the http status code 200 OK if logistics are available. The response body contains:

• id - quote id
• expirationAt - quote expiration date and time UTC
• createdAt - quote creation date and time UTC
• quote.grossValue - gross delivery value
• quote.discount - delivery discount value
• quote.raise - increase value
• quote.netValue - net delivery value
• deliveryTime.min - minimum estimated delivery time in seconds
• deliveryTime.max - maximum estimated delivery time in seconds
• distance - delivery distance radius in meters (1000, 2000, 3000...)
• preparationTime - preparation time in seconds
• hasPaymentMethods - informs if there are available payment methods
• paymentMethods.id - payment method id
• paymentMethods.brand - credit/debit card brand
• paymentMethods.liability - responsible for receiving the payment (IFOOD)
• paymentMethods.paymentType - type of payment e.g.: OFFLINE
• paymentMethods.method - payment method CREDIT or 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

This endpoint returns the http status code 400 Bad Request if logistics are not available to deliver the order at this location or for this merchant.

{
  "code": "DeliveryDistanceTooHigh",
  "message": "iFood Delivery unavailable: the delivery address is more than 10 Km from your store.",
  "details": ["Delivery distance too high"]
}

This endpoint returns the http status code 500 Internal Server Error if there is a failure when registering this order.

{
  "code": "InternalServerError",
  "message": "Oops. There was a failure. Try again in a few moments.",
  "details": ["Internal server error"]
}

Delivery Request

To request the delivery person agreeing with the returned quote, use the following endpoint POST /requestDriver passing in the body the order information.

This endpoint is asynchronous. When your request is processed you will receive a REQUEST_DRIVER event confirming that the request has been made and then the result of the request, which can be: REQUEST_DRIVER_SUCCES or REQUEST_DRIVER_FAILED.

• orderId - ID of the order already existing on the iFood platform to request delivery
• quoteId - ID of the quote previously requested to request delivery

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

Responses

Success

This endpoint returns the http status code 202 Accepted if the request is successfully registered.

Errors

This endpoint returns the http status code 400 Bad Request if logistics are not available to deliver the order or there is a failure when registering this order.

{
  "code": "DeliveryDistanceTooHigh",
  "message": "iFood Delivery unavailable: the delivery address is more than 10 Km from your store.",
  "details": ["Delivery distance too high"]
}

This endpoint returns the http status code 500 Internal Server Error if there is a failure when registering this order.

{
  "code": "InternalServerError",
  "message": "Oops. There was a failure. Try again in a few moments.",
  "details": ["Internal server error"]
}

Cancellation

To cancel the request for an iFood delivery person without the need to cancel the order, the delivery cancellation must be performed through the endpoint POST /orders/{id}/cancelRequestDriver.

The cancellation will only be carried out if it is requested before the delivery person's acceptance, in this case no fee will be charged from the store. If it is necessary to cancel after the delivery person's acceptance, the rules established in Order Cancellation must be followed.

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

Responses

Success

This endpoint returns HTTP Status 202, with nothing in the response body The polling will receive a DELIVERY_CANCELLATION_REQUESTED event when the request is successfully sent.

Error

This endpoint returns the http status code 400 Bad Request if the expected parameters are not provided.

{
  "code": "BadRequest",
  "message": "There was a problem reading information. Check the information sent.",
  "details": [
    "Field 'OrderID' must be in uuid format."
  ]
}

This endpoint returns the http status code 500 Internal Server Error if there is a failure when requesting the delivery cancellation.

{
  "code": "InternalServerError",
  "message": "Oops. There was a failure. Try again in a few moments.",
  "details": ["Internal server error"]
}