Search in documentation
ctrl+4K
Modules
Authentication
Merchant
Catalog
Order
Events
Logistics
Shipping
Review
Financial
Solutions

Endpoints

Navigate all Order API endpoints organized by functionality. For post-delivery negotiation operations, see the Negotiation Platform.

Order management

Get order details

Retrieve complete information for a specific order.GET https://merchant-api.ifood.com.br/order/v1.0/orders/{id}Path parameters
ParameterTypeDescription
iduuidOrder ID
Response (200 OK)
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "CONFIRMED",
  "orderType": "DELIVERY",
  "category": "FOOD",
  "items": [...],
  "scheduling": {...},
  "total": {...}
}
Read more: Complete order structure

Confirm order

Confirm receipt within 8 minutes. See confirmation deadline.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/confirmPath parameters
ParameterTypeDescription
iduuidOrder ID
Response (202 Accepted)Result arrives in next polling: CONFIRMED event or CANCELLATION_REQUEST_FAILED.Read more: Confirmation flow

Start preparation

Begin order preparation after confirmation.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/startPreparationPath parameters
ParameterTypeDescription
iduuidOrder ID
Response (202 Accepted)
{
  "status": "ACCEPTED"
}
Important notes:
  • For scheduled orders, respect preparationStartDateTime
  • Stores with "Smart Preparation" receive RECOMMENDED_PREPARATION_START
Read more: Preparation flow

Notify order ready

Notify that the order is ready for pickup or delivery.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/readyToPickupPath parameters
ParameterTypeDescription
iduuidOrder ID
Response (202 Accepted)
{
  "status": "ACCEPTED"
}
Requirement:
  • TAKEOUT and DINE_IN: Required
  • DELIVERY: Optional
Read more: Ready notification flow

Dispatch order

Notify that the order is out for merchant delivery.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/dispatchPath parameters
ParameterTypeDescription
iduuidOrder ID
Body
{
  "deliveredBy": "MERCHANT"
}
Response (202 Accepted)
{
  "status": "ACCEPTED"
}
When to use: Only for merchant delivery (DELIVERY with deliveredBy = MERCHANT)Read more: Dispatch flow

Order cancellation

Get valid cancellation reasons

Retrieve accepted cancellation reasons for a specific order.GET https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/cancellationReasonsPath parameters
ParameterTypeDescription
iduuidOrder ID
Response (200 OK)
{
  "reasons": [
    {
      "code": "501",
      "description": "System error"
    },
    {
      "code": "502",
      "description": "Duplicate order"
    }
  ]
}
Common codes:
  • 501 — System
  • 502 — Duplicate
  • 503 — Unavailable
  • 504 — No driver
  • 505 — Menu
  • 506 — Out of area
  • 507 — Fraudulent
  • 508 — Outside hours
  • 509 — Internal error
  • 511 — Risk
  • 512 — Opens later
Read more: Cancellation flow

Request cancellation

Request order cancellation with a valid reason.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/requestCancellationPath parameters
ParameterTypeDescription
iduuidOrder ID
Body
{
  "reason": "501"
}
Response (202 Accepted)
{
  "status": "ACCEPTED"
}
Validation: Check the result in next polling:
  • CANCELLED — Cancellation accepted
  • CANCELLATION_REQUEST_FAILED — Cancellation rejected
Warning: Excessive cancellations incur penalties and may result in temporary store closure.Read more: Complete cancellation rules and flow

Tracking and validation

Track driver

Get real-time driver location (iFood delivery only).GET https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/trackingPath parameters
ParameterTypeDescription
iduuidOrder ID
Response (200 OK)
{
  "latitude": -23.5505,
  "longitude": -46.6333,
  "expectedDelivery": "2024-04-25T18:30:00Z",
  "pickupEtaStart": 120,
  "deliveryEtaEnd": 600,
  "trackDate": "2024-04-25T18:15:00Z"
}
Constraints:
  • Only available after ASSIGN_DRIVER event
  • Maximum one request every 30 seconds
  • May return 404 before driver assigned
Read more: Delivery tracking

Validate pickup code

Validate the pickup code provided by driver.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/validatePickupCodePath parameters
ParameterTypeDescription
iduuidOrder ID
Body
{
  "code": "123456"
}
Response (200 OK)
{
  "valid": true
}
Validation: Compare code against pickupCode in order details.Availability: Only when enabled and for deliveredBy = "IFOOD".Read more: Pickup validation

Confirm delivery or pickup

Validate and confirm order delivery or pickup.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/verifyDeliveryCodePath parameters
ParameterTypeDescription
iduuidOrder ID
Body
{
  "code": "654321"
}
Response (200 OK)
{
  "valid": true
}
Use cases:
  • iFood delivery: Driver confirms via app (automatic)
  • Merchant delivery: Use localizer (phone.localizer) from receipt
Read more: Delivery confirmation

Event management

Consume events (Polling)

Check for new events. Recommended every 30 seconds.GET https://merchant-api.ifood.com.br/order/v1.0/orders:pollingQuery parameters
ParameterTypeDescription
limitintMaximum events (default: 100)
Response (200 OK)
{
  "events": [
    {
      "id": "evt_123",
      "code": "CONFIRMED",
      "fullCode": "ORDER_CONFIRMED",
      "orderId": "ord_456",
      "createdAt": "2024-04-25T18:00:00Z",
      "metadata": {...}
    }
  ]
}
Next steps: Process each event and confirm reading with /orders:acknowledgment.Read more: Event consumption

Acknowledge event consumption

Confirm that you successfully processed events.POST https://merchant-api.ifood.com.br/order/v1.0/orders:acknowledgmentBody
{
  "acknowledgedEventIds": [
    "evt_123",
    "evt_124"
  ]
}
Response (202 Accepted)
{
  "status": "ACCEPTED"
}
Important: Only acknowledge successfully processed events. Unacknowledged events will be returned in next polling.Read more: Event acknowledgment

Search by use case

Not sure where to start? Use this index:
ScenarioEndpointsGuide
Receive new order/orders:pollingComplete workflow
Confirm and processPOST /confirmConfirmation flow
Prepare and notifyPOST /startPreparation, POST /readyToPickupPreparation flow
Track deliveryGET /trackingReal-time tracking
Cancel orderGET /cancellationReasons, POST /requestCancellationCancellation flow
Resolve disputeSee Negotiation PlatformImplementation guide

Next steps

  1. Starting integration? Complete workflow step by step
  2. Understanding order structure? Complete fields
  3. Knowing all events? Event catalog
  4. Resolving disputes? Negotiation Platform
  5. Ready for homologation? Criteria and checklist
Was this page helpful?
Rate your experience in the new Developer portal:
On this page
Endpoints
Order management
Get order details
Confirm order
Start preparation
Notify order ready
Dispatch order
Order cancellation
Get valid cancellation reasons
Request cancellation
Tracking and validation
Track driver
Validate pickup code
Confirm delivery or pickup
Event management
Consume events (Polling)
Acknowledge event consumption
Search by use case
Next steps
Content read0%