Buscar en la documentación

Módulos

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Soluciones

Endpoints

Navegue por todos los endpoints de Order API organizados por funcionalidad. Para operaciones de negociación post-entrega, consulte la Plataforma de Negociación.

Gestión de pedidos

Obtener detalles del pedido

Recupere información completa de un pedido específico.GET https://merchant-api.ifood.com.br/order/v1.0/orders/{id}Parámetros de ruta

Parámetro	Tipo	Descripción
`id`	uuid	ID del pedido

Respuesta (200 OK)

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "CONFIRMED",
  "orderType": "DELIVERY",
  "category": "FOOD",
  "items": [...],
  "scheduling": {...},
  "total": {...}
}

Leer más: Estructura completa del pedido

Confirmar pedido

Confirme un pedido recibido. Requerido dentro de 8 minutos.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/confirmParámetros de ruta

Parámetro	Tipo	Descripción
`id`	uuid	ID del pedido

Respuesta (202 Accepted)

{
  "status": "ACCEPTED"
}

Validación: Verifique el resultado en la siguiente consulta — llegará como evento CONFIRMED o CANCELLATION_REQUEST_FAILED.Leer más: Flujo de confirmación

Iniciar preparación

Inicie la preparación del pedido después de la confirmación.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/startPreparationParámetros de ruta

Parámetro	Tipo	Descripción
`id`	uuid	ID del pedido

Respuesta (202 Accepted)

{
  "status": "ACCEPTED"
}

Notas importantes:

Para pedidos programados, respete preparationStartDateTime
Tiendas con "Preparación Inteligente" reciben RECOMMENDED_PREPARATION_START

Leer más: Flujo de preparación

Notificar pedido listo

Notifique que el pedido está listo para recoger o entregar.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/readyToPickupParámetros de ruta

Parámetro	Tipo	Descripción
`id`	uuid	ID del pedido

Respuesta (202 Accepted)

{
  "status": "ACCEPTED"
}

Requisito:

TAKEOUT y DINE_IN: Requerido
DELIVERY: Opcional

Leer más: Flujo de notificación de listo

Despachar pedido

Notifique que el pedido salió para entrega propia.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/dispatchParámetros de ruta

Parámetro	Tipo	Descripción
`id`	uuid	ID del pedido

Body

{
  "deliveredBy": "MERCHANT"
}

Respuesta (202 Accepted)

{
  "status": "ACCEPTED"
}

Cuándo usar: Solo para entrega propia (DELIVERY con deliveredBy = MERCHANT)Leer más: Flujo de despacho

Cancelación de pedidos

Obtener motivos válidos de cancelación

Recupere los motivos de cancelación aceptados para un pedido específico.GET https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/cancellationReasonsParámetros de ruta

Parámetro	Tipo	Descripción
`id`	uuid	ID del pedido

Respuesta (200 OK)

{
  "reasons": [
    {
      "code": "501",
      "description": "Error en el sistema"
    },
    {
      "code": "502",
      "description": "Pedido duplicado"
    }
  ]
}

Códigos comunes:

501 — Sistema
502 — Duplicado
503 — No disponible
504 — Sin conductor
505 — Menú
506 — Fuera de área
507 — Fraudulento
508 — Fuera de horario
509 — Error interno
511 — Riesgo
512 — Abre después

Leer más: Flujo de cancelación

Solicitar cancelación

Solicite la cancelación de un pedido con motivo válido.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/requestCancellationParámetros de ruta

Parámetro	Tipo	Descripción
`id`	uuid	ID del pedido

Body

{
  "reason": "501"
}

Respuesta (202 Accepted)

{
  "status": "ACCEPTED"
}

Validación: Verifique el resultado en la siguiente consulta:

CANCELLED — Cancelación aceptada
CANCELLATION_REQUEST_FAILED — Cancelación rechazada

Advertencia: Los cancelamientos excesivos incurren en sanciones y pueden resultar en cierre temporal de la tienda.Leer más: Reglas y flujo completo de cancelación

Rastreo y validación

Rastrear conductor

Obtenga la ubicación en tiempo real del conductor de iFood.GET https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/trackingParámetros de ruta

Parámetro	Tipo	Descripción
`id`	uuid	ID del pedido

Respuesta (200 OK)

{
  "latitude": -23.5505,
  "longitude": -46.6333,
  "expectedDelivery": "2024-04-25T18:30:00Z",
  "pickupEtaStart": 120,
  "deliveryEtaEnd": 600,
  "trackDate": "2024-04-25T18:15:00Z"
}

Campos retornados

Campo	Tipo	Descripción
`latitude`	float	Latitud actual
`longitude`	float	Longitud actual
`expectedDelivery`	datetime	ETA de entrega estimado
`pickupEtaStart`	int	Segundos hasta recogida
`deliveryEtaEnd`	int	Segundos hasta entrega
`trackDate`	datetime	Marca de tiempo de consulta

Limitaciones:

Solo para deliveredBy = "IFOOD"
Máximo una solicitud cada 30 segundos
Puede retornar 404 antes de disponibilidad
Sujeto a rate limiting

Requisito previo: Reciba evento ASSIGN_DRIVER antes de usar este endpoint.Leer más: Rastreo de entrega

Validar código de recogida

Valide el código de recogida proporcionado por el conductor.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/validatePickupCodeParámetros de ruta

Parámetro	Tipo	Descripción
`id`	uuid	ID del pedido

Body

{
  "code": "123456"
}

Respuesta (200 OK)

{
  "valid": true
}

Validación: Compare el código contra pickupCode en detalles del pedido.Disponibilidad: Solo cuando esté habilitado y para deliveredBy = "IFOOD".Leer más: Validación de recogida

Confirmar entrega o recogida

Valide y confirme la entrega o recogida del pedido.POST https://merchant-api.ifood.com.br/order/v1.0/orders/{id}/verifyDeliveryCodeParámetros de ruta

Parámetro	Tipo	Descripción
`id`	uuid	ID del pedido

Body

{
  "code": "654321"
}

Respuesta (200 OK)

{
  "valid": true
}

Casos de uso:

Entrega iFood: Conductor confirma vía app (automático)
Entrega propia: Use localizador (phone.localizer) del recibo

Leer más: Confirmación de entrega

Gestión de eventos

Consumir eventos (Polling)

Verifique nuevos eventos. Recomendado cada 30 segundos.GET https://merchant-api.ifood.com.br/order/v1.0/orders:pollingParámetros de consulta

Parámetro	Tipo	Descripción
`limit`	int	Máximo de eventos (default: 100)

Respuesta (200 OK)

{
  "events": [
    {
      "id": "evt_123",
      "code": "CONFIRMED",
      "fullCode": "ORDER_CONFIRMED",
      "orderId": "ord_456",
      "createdAt": "2024-04-25T18:00:00Z",
      "metadata": {...}
    }
  ]
}

Próximos pasos: Procese cada evento y confirme la lectura con /orders:acknowledgment.Leer más: Consumo de eventos

Confirmar consumo de eventos

Confirme que procesó eventos exitosamente.POST https://merchant-api.ifood.com.br/order/v1.0/orders:acknowledgmentBody

{
  "acknowledgedEventIds": [
    "evt_123",
    "evt_124"
  ]
}

Respuesta (202 Accepted)

{
  "status": "ACCEPTED"
}

Importante: Solo confirme eventos procesados exitosamente. Eventos no confirmados serán retornados en siguiente consulta.Leer más: Confirmación de eventos

Búsqueda por caso de uso

¿No sabe por dónde empezar? Use este índice:

Escenario	Endpoints	Guía
Recibir nuevo pedido	`/orders:polling`	Flujo completo
Confirmar y procesar	`POST /confirm`	Flujo de confirmación
Preparar y notificar	`POST /startPreparation`, `POST /readyToPickup`	Flujo de preparación
Rastrear entrega	`GET /tracking`	Rastreo en tiempo real
Cancelar pedido	`GET /cancellationReasons`, `POST /requestCancellation`	Flujo de cancelación
Resolver disputa	Ver Plataforma de Negociación	Guía de implementación