Buscar en la documentación

Módulos

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Soluciones

Logistics

Estructura del pedido

Use GET logistics/orders/{id} para obtener detalles completos del pedido.Un pedido contiene:

Información general: ID, tipo, fecha de creación
Merchant: Datos de la tienda
Customer: Datos del cliente
Items: Cantidad y peso de los productos
Payments: Formas y valores de pago
Delivery: Dirección y método de entrega
Schedule: Horario agendado (cuando aplica)

Referencia de campos

Información general

Campo	Tipo	Descripción
id	uuid	Identificador único del pedido
displayId	string	ID amigable para mostrar en la interfaz de la tienda
orderType	enum	Tipo de pedido: `DELIVERY` o `TAKEOUT`
orderTiming	enum	Momento de entrega: `IMMEDIATE` o `SCHEDULED`
createdAt	date	Fecha y hora de creación del pedido
isTest	boolean	Indica si es pedido de prueba

Ejemplo:

{
  "id": "32c15e00-9861-4548-b5f0-15580defc999",
  "displayId": "fc999",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "isTest": false
}

merchant

Campo	Tipo	Descripción
id	uuid	Identificador único de la tienda
name	string	Nombre de la tienda

Ejemplo:

{
  "merchant": {
    "id": "50647eee-5eb6-41a2-b2d8-999998ed677f",
    "name": "Nombre de la Tienda"
  }
}

merchant.merchantAddress

Campo	Tipo	Descripción
country	string	Código del país
state	string	Estado
city	string	Ciudad
district	string	Barrio
street	string	Calle
number	string	Número
postalCode	string	Código postal
latitude	number	Coordenada latitud
longitude	number	Coordenada longitud

Ejemplo:

{
  "merchantAddress": {
    "country": "BR",
    "state": "AC",
    "city": "Bujari",
    "district": "Bujari",
    "street": "Ramal Bujari",
    "number": "122",
    "postalCode": "12345678",
    "latitude": -9.822384,
    "longitude": -67.948589
  }
}

customer

Campo	Tipo	Descripción
id	uuid	Identificador único del cliente
name	string	Nombre del cliente
phone.number	string	Teléfono del cliente o 0800 de iFood
phone.localizer	string	Código localizador para usar al llamar al 0800
phone.localizerExpiration	date	Fecha de expiración del localizador

Campo phone es opcionalEl campo phone expira 3 horas después de la fecha de entrega del pedido.

Ejemplo:

{
  "customer": {
    "name": "Murilo Gontijo",
    "phone": {
      "number": "0800 705 3040",
      "localizer": "75159000",
      "localizerExpiration": "2024-01-09T00:44:42.547Z"
    }
  }
}

items

Campo	Tipo	Descripción
index	integer	Posición del ítem en la lista
quantity	integer	Cantidad
weight.unit	string	Unidad: `GRAMS` o `LITERS`
weight.value	number	Valor del peso

Ejemplo:

"items": [
  {
    "index": 1,
    "quantity": 1,
    "weight": {
      "unit": "GRAMS",
      "value": 750
    }
  },
  {
    "index": 2,
    "quantity": 1,
    "weight": {
      "unit": "LITERS",
      "value": 2
    }
  }
]

payments

Campo	Tipo	Descripción
prepaid	double	Valor ya pagado (online)
pending	double	Valor a cobrar en la entrega
methods.value	double	Valor del pago
methods.currency	string	Moneda (ej: `BRL`)
methods.method	enum	Método: `CASH`, `CREDIT`, `DEBIT`, `MEAL_VOUCHER`, `FOOD_VOUCHER`, `GIFT_CARD`, `DIGITAL_WALLET`, `PIX`, `OTHER`
methods.type	string	Tipo: `ONLINE` o `OFFLINE`
methods.prepaid	boolean	Indica si ya fue pagado
methods.cash.changeFor	double	Valor para cambio (cuando el pago es en efectivo)

Ejemplo:

"payments": {
  "prepaid": 0,
  "pending": 103.99,
  "methods": [
    {
      "value": 103.99,
      "currency": "BRL",
      "method": "CASH",
      "prepaid": false,
      "type": "OFFLINE",
      "cash": {
        "changeFor": 150
      }
    }
  ]
}

delivery

Campo	Tipo	Descripción
mode	enum	Modo de entrega: `DEFAULT` (estándar) o `EXPRESS`
deliveredBy	enum	Responsable: `MERCHANT` (entrega propia)
deliveryDateTime	date	Fecha y hora estimada de entrega
observations	string	Observaciones del cliente sobre la entrega
deliveryAddress	object	Dirección de entrega

Ejemplo:

"delivery": {
  "mode": "DEFAULT",
  "deliveredBy": "MERCHANT",
  "deliveryDateTime": "2020-01-01T00:00:00.000Z",
  "observations": "Dejar en portería",
  "deliveryAddress": {...}
}

deliveryAddress

Campo	Tipo	Descripción
streetName	string	Nombre de la calle
streetNumber	string	Número (puede contener letras)
formattedAddress	string	Dirección formateada completa
neighborhood	string	Barrio
complement	string	Complemento (apartamento, bloque, etc)
reference	string	Punto de referencia
postalCode	string	Código postal (opcional, puede venir en cero)
city	string	Ciudad
state	string	Estado
country	string	País
coordinates.latitude	double	Coordenada latitud
coordinates.longitude	double	Coordenada longitud

Ejemplo:

"deliveryAddress": {
  "streetName": "CALLE X",
  "streetNumber": "20A",
  "formattedAddress": "CALLE X, 20A",
  "neighborhood": "Barrio",
  "complement": "Apto 101",
  "reference": "Cerca de la plaza",
  "postalCode": "99999999",
  "city": "SAO PAULO",
  "state": "SP",
  "country": "BR",
  "coordinates": {
    "latitude": -26.999999,
    "longitude": -48.999999
  }
}

schedule

Presente solo en pedidos agendados (orderTiming: SCHEDULED).

Campo	Tipo	Descripción
deliveryDateTimeStart	date	Inicio de la ventana de entrega
deliveryDateTimeEnd	date	Fin de la ventana de entrega

Ejemplo:

"schedule": {
  "deliveryDateTimeStart": "2020-01-01T00:20:00.000Z",
  "deliveryDateTimeEnd": "2020-01-01T01:20:00.000Z"
}

Ejemplos de escenarios

1. Entrega inmediata con pago offline (tarjeta de crédito)

{
  "id": "4934a1e8-2071-4ac7-9ff6-6e634bb6008d",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "displayId": "9843",
  "createdAt": "2024-03-20T14:33:08.052Z",
  "isTest": true,
  "merchant": {
    "id": "b0954b6b-f99c-44b6-ba1e-987f32b2b22a",
    "name": "Teste - murilogontijo",
    "merchantAddress": {
      "country": "BR",
      "state": "AC",
      "city": "Bujari",
      "district": "Bujari",
      "street": "Ramal Bujari",
      "number": "122",
      "postalCode": "12345678",
      "latitude": -9.822384,
      "longitude": -67.948589
    }
  },
  "customer": {
    "name": "PEDIDO DE TESTE - Murilo Gontijo",
    "phone": {
      "number": "0800 705 4050",
      "localizer": "89121704",
      "localizerExpiration": "2024-03-20T18:33:08.052Z"
    }
  },
  "items": [
    {
      "index": 1,
      "quantity": 3,
      "weight": {
        "unit": "GRAMS",
        "value": 2250
      }
    },
    {
      "index": 2,
      "quantity": 1,
      "weight": {
        "unit": "GRAMS",
        "value": 200
      }
    }
  ],
  "payments": {
    "prepaid": 0,
    "pending": 323.99,
    "methods": [
      {
        "value": 323.99,
        "currency": "BRL",
        "method": "CREDIT",
        "prepaid": false,
        "type": "OFFLINE"
      }
    ]
  },
  "delivery": {
    "mode": "DEFAULT",
    "deliveredBy": "MERCHANT",
    "deliveryDateTime": "2024-04-01T15:18:04.801Z",
    "observations": "PEDIDO DE TESTE! NÃO ENTREGAR",
    "deliveryAddress": {
      "streetName": "Rua TESTE",
      "streetNumber": "999999",
      "formattedAddress": "Rua TESTE, 999999",
      "neighborhood": "Bairro TESTE",
      "complement": "Complemento TESTE",
      "postalCode": "99999999",
      "city": "TESTE",
      "state": "XX",
      "country": "XX",
      "reference": "TESTE",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    }
  }
}

2. Entrega inmediata con pago online (ya pagado)

{
  "id": "63ec432e-4f0d-4097-b4fe-11bc2dac14af",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "displayId": "1728",
  "createdAt": "2024-04-01T15:18:04.801Z",
  "isTest": true,
  "merchant": {
    "id": "b0954b6b-f99c-44b6-ba1e-987f32b2b22a",
    "name": "Teste - murilogontijo",
    "merchantAddress": {
      "country": "BR",
      "state": "AC",
      "city": "Bujari",
      "district": "Bujari",
      "street": "Ramal Bujari",
      "number": "0",
      "postalCode": "12345678",
      "latitude": -9.822384,
      "longitude": -67.948589
    }
  },
  "customer": {
    "name": "PEDIDO DE TESTE - Murilo Gontijo",
    "phone": {
      "number": "0800 705 4050",
      "localizer": "83984177",
      "localizerExpiration": "2024-04-01T19:18:04.801Z"
    }
  },
  "items": [
    {
      "index": 1,
      "quantity": 1
    },
    {
      "index": 2,
      "quantity": 1
    }
  ],
  "delivery": {
    "mode": "DEFAULT",
    "deliveredBy": "MERCHANT",
    "deliveryDateTime": "2024-04-01T15:18:04.801Z",
    "observations": "PEDIDO DE TESTE! NÃO ENTREGAR",
    "deliveryAddress": {
      "streetName": "Rua TESTE",
      "streetNumber": "999999",
      "formattedAddress": "Rua TESTE, 999999",
      "neighborhood": "Bairro TESTE",
      "complement": "Complemento TESTE",
      "postalCode": "99999999",
      "city": "TESTE",
      "state": "XX",
      "country": "XX",
      "reference": "TESTE",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    }
  }
}

3. Entrega agendada con pago en efectivo (con cambio)

{
  "id": "5076514a-2ad1-49fe-b38c-e849b4cbeaab",
  "orderType": "DELIVERY",
  "orderTiming": "SCHEDULED",
  "displayId": "9305",
  "createdAt": "2024-01-08T20:44:42.547Z",
  "isTest": false,
  "schedule": {
    "deliveryDateTimeStart": "2024-01-16T18:00:00.000Z",
    "deliveryDateTimeEnd": "2024-01-16T18:30:00.000Z"
  },
  "merchant": {
    "id": "b0954b6b-f99c-44b6-ba1e-987f32b2b22a",
    "name": "Teste - murilogontijo",
    "merchantAddress": {
      "country": "BR",
      "state": "AC",
      "city": "Bujari",
      "district": "Bujari",
      "street": "Ramal Bujari",
      "number": "122",
      "postalCode": "12345678",
      "latitude": -9.822384,
      "longitude": -67.948589
    }
  },
  "customer": {
    "name": "PEDIDO DE TESTE - Murilo Gontijo",
    "phone": {
      "number": "0800 705 3040",
      "localizer": "75159000",
      "localizerExpiration": "2024-01-09T00:44:42.547Z"
    }
  },
  "items": [
    {
      "index": 1,
      "quantity": 1,
      "weight": {
        "unit": "GRAMS",
        "value": 750
      }
    },
    {
      "index": 2,
      "quantity": 1,
      "weight": {
        "unit": "LITERS",
        "value": 2
      }
    }
  ],
  "payments": {
    "prepaid": 0,
    "pending": 103.99,
    "methods": [
      {
        "value": 103.99,
        "currency": "BRL",
        "method": "CASH",
        "prepaid": false,
        "type": "OFFLINE",
        "cash": {
          "changeFor": 150
        }
      }
    ]
  },
  "delivery": {
    "mode": "DEFAULT",
    "deliveredBy": "MERCHANT",
    "deliveryDateTime": "2024-01-08T22:14:42.547Z",
    "observations": "PEDIDO DE TESTE! NÃO ENTREGAR",
    "deliveryAddress": {
      "streetName": "Rua TESTE",
      "streetNumber": "999999",
      "formattedAddress": "Rua TESTE, 999999",
      "neighborhood": "Bairro TESTE",
      "complement": "Complemento TESTE",
      "postalCode": "99999999",
      "city": "TESTE",
      "state": "XX",
      "country": "XX",
      "reference": "TESTE",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    }
  }
}

¿Esta página fue útil?

Evalúa tu experiencia en el nuevo portal de desarrolladores:

En esta página

Estructura del pedido

Referencia de campos

Información general

merchant

merchant.merchantAddress

Ejemplos de escenarios

1. Entrega inmediata con pago offline (tarjeta de crédito)

2. Entrega inmediata con pago online (ya pagado)

3. Entrega agendada con pago en efectivo (con cambio)

Contenido leído0%