tipo de documento del cliente (por ejemplo, CPF, RG)
document.Value
string
valor del documento del cliente
billingAddress.streetName
string
nombre de la calle de la dirección de facturación del cliente
billingAddress.city
string
ciudad de la dirección de facturación del cliente
billingAddress.complement
string
complemento de la dirección de facturación del cliente
billingAddress.country
string
país de la dirección de facturación del cliente
billingAddress.district
string
distrito de la dirección de facturación del cliente
billingAddress.latitude
double
latitud de la dirección de facturación del cliente
billingAddress.longitude
double
longitud de la dirección de facturación del cliente
billingAddress.state
string
estado de la dirección de facturación del cliente
billingAddress.streetNumber
string
número en la calle de la dirección de facturación del cliente
billingAddress.zipCode
string
código postal de la dirección de facturación del cliente
localizer.Code
string
código localizador del cliente
localizer.phone
string
teléfono localizador del cliente
Ejemplo:
"customer": {"id": "50647eee-5eb6-41a2-b2d8-999998ed677f","name": "Nome do Cliente","phones": [ {"phoneNumber": "0800 XXX XXXX" }, {"phoneNumber": "(11) 99999-XXXX" } ],"email": "cliente@example.com","birthDate": "1990-01-01","document": {"Type": "CPF","Value": "12345678901" },"billingAddress": {"streetName": "Rua do Cliente","city": "Cidade do Cliente","complement": "Complemento do Cliente","country": "País do Cliente","district": "Distrito do Cliente","latitude": 123.456,"longitude": 789.012,"state": "Estado do Cliente","streetNumber": "123","zipCode": "12345-678" },"type": "NATURAL_PERSON","localizer": {"code": "27534642","phone": "0800 100 9988" }}
Bag
Campo
Tipo
Descripción
items.UniqueId
string
identificador único del ítem en la bolsa
items.Quantity
entero
cantidad del ítem
items.Name
string
nombre del ítem
items.Ean
string
código de barras del ítem
items.Note
string
comentarios agregados por el cliente al ítem (por ejemplo, quitar ensalada, sin salsa, etc.)
items.Weight.Value
doble
valor de la medida de peso del ítem
items.Prices.UnitValue.Value
doble
valor en centavos DE UN ítem sin ningún descuento
items.Prices.UnitValue.Currency
string
moneda
items.Prices.SalePriceKg.Value
doble
valor en centavos DE UN KG del ítem sin ningún descuento
items.Prices.SalePriceKg.Currency
string
moneda
items.Prices.GrossValue.Value
doble
valor en centavos del precio unitario multiplicado por la cantidad de ítems más el precio total de las elecciones (guarnición legada) multiplicado por la cantidad de ítems
items.Prices.GrossValue.Currency
string
moneda
items.Product.Plu
string
código interno del socio para control del paquete propietario
items.Product.IsVariableWeight
boolean
identifica si es un ítem de peso variable
items.replacement.option
string
Indica la elección del usuario respecto al reemplazo del artículo. Este campo no es obligatorio y puede recibir los valores NULL, RELATED_ITEMS, RECEIVE_SIMILAR_ITEM, CANCEL_ITEM
items.replacement.list
array
Lista de artículos que pueden reemplazar al artículo principal en el pedido
items.replacement.list.name
string
Nombre del producto sustituto
items.replacement.list.description
string
Descripción del producto de reemplazo
items.replacement.list.externalCode
string
Código de artículo en su aplicación (codPDV). Es opcional y se puede configurar en el catálogo.
items.replacement.list.ean
string
código de barras (Número de artículo europeo)
items.replacement.list.price.value
number
Precio de venta del producto sustituto
items.replacement.list.price.productId
string
Código de identificación del artículo de reemplazo en el catálogo
prices.GrossValue.Value
doble
valor en centavos de todos los ítems y ítems de guarnición del pedido sin ningún descuento
prices.GrossValue.Currency
string
moneda
replacementOptions.Mode
string
lo que el mercado debe hacer si falta algún tipo de ítem en el pedido: STORE_CONTACT_CUSTOMER; STORE_CHOOSE_OTHER_ITEMS; STORE_REMOVE_ITEMS
items.replacement.option
option
Descrição
NULL/RELATED_ITEMS
Si el elemento tiene una lista de reemplazo con 1 o más opciones, con opción nula o RELATED_ITEMS, el reemplazo del elemento original solo se debe permitir si y solo si el nuevo elemento está presente en la lista.
RECEIVE_SIMILAR_ITEM
Si el artículo no tiene lista de reemplazo y la opción es RECEIVE_SIMILAR_ITEM, se deberá permitir el reemplazo del artículo original por cualquier artículo similar que la tienda tenga en su catálogo.
CANCEL_ITEM
Si el artículo no tiene una lista de reemplazo y la opción es CANCEL_ITEM, se debe cancelar el artículo original y reembolsar el valor de ese artículo.
ObservaçãoEl campo bag.items.replacement tiene prioridad sobre el campo bag.replacementOptions.
ReplacementOptions solo debe usarse cuando el artículo no se reemplaza o cuando no se puede realizar el reemplazo especificado en el reemplazo.
El usuario de iFood puede recibir diferentes tipos de cupones/ vouchers para utilizar en la aplicación que llamamos Benefits.Estos cupones de descuento pueden ser subsidiados tanto por iFood como por los colaboradores. Aparecen en los detalles de los pedidos en el campo benefits y el valor del subsidio de cada parte aparece en el campo "sponsorship".Estos cupones se pueden aplicar a un ítem específico, al subtotal de los ítems (carrito) o a la tarifa de envío (target).
Campo
Tipo
Descripción
Benefits.BenefitIdentifier
string
ID del usuario en el laboratorio responsable del beneficio (aplicable a beneficios relacionados con farmacias y droguerías)
Benefits.PreAuthorizationToken
string
Token de preautorización del descuento aplicado (aplicable a beneficios relacionados con farmacias y droguerías)
Benefits.TransactionIdentifier
string
ID de la transacción (aplicable a beneficios relacionados con farmacias y droguerías)
Benefits.AuthorizerId
string
ID de la autorizadora (aplicable a beneficios relacionados con farmacias y droguerías)
Benefits.TargetId
string
el ID de destino (para descuentos en ítems, aquí se utiliza el catalogItemId)
Benefits.Target
string
dónde se aplica el descuento (por ejemplo, carrito, un ítem específico, tarifa de entrega, otra tarifa, etc)
Benefits.Sponsorships.Liability
string
el patrocinador (ifood, comerciante, coca-cola, etc)
Benefits.Sponsorships.Amount.Value
double
el valor del beneficio en centavos
Benefits.Sponsorships.Amount.Currency
string
moneda
Targets
target
Descripción
CART
El descuento es aplicado sobre el subtotal del carrito (sumatoria de los ítems del pedido).
DELIVERY_FEE
El descuento es aplicado sobre la tarifa de entrega.
ITEM
El descuento es aplicado sobre un ítem específico del carrito. El campo targerId específica sobre cual ítem el descuento es aplicado. Esta especificación es hecha en la campaña.
PROGRESSIVE_DISCOUNT_ITEM
Descuento progresivo en ítems iguales del pedido, formando un combo.
Sponsorship
sponsorship
Tratamiento
IFOOD
El valor del/los cupón/es debe/n ser tratado/s como como un tipo de pago, ya que iFood transferirá este valor al restaurante.
EXTERNAL
El valor del/los cupón/es debe/n ser tratado/s como como un tipo de pago, ya que iFood transferirá este valor al restaurante.
PARTNER
El valor del/los cupón/es debe/n ser tratado/s como un descuento, ya que el subsidio en este caso es responsabilidad del merchant (tienda).
En este campo se mostrarán las tasas de servicio. Esta tasa debe ser considerada para el cálculo del total del pedido. Sin embargo, la tasa de servicio es un ingreso de iFood y no debe formar parte del ticket fiscal del Socio.El campo Audience puede ser Customer, Driver o Merchant, representando quién es responsable del pago de la tasa.
Campo
Tipo
Descripción
Audience
string
responsable del pago de la tarifa (por ejemplo, merchant, customer, driver)
Aquí se muestran campos de verificación. Actualmente, el único código que se devuelve es el código de recogida (PICKUP_CODE).
Este campo debe ser utilizado para la verificación entre el conductor y la tienda en los pedidos de entrega de iFood. Saber Más
truePara pedidos dondeTaxPayer.Identification.Type in ["CPF", "CNPJ"]
Status
DEPRECATED
StatusDescricao
DEPRECATED
Tipo
"EXPRESS"Para pedidos dondeOperationMode.Type == "DELIVERY"yOperationMode.Delivery.Code in ["EXPRESS", "FAST_DELIVERY"]
"SCHEDULED"Para pedidos dondeOperationMode.Type == "DELIVERY"yOperationMode.Delivery.Code not in ["EXPRESS", "FAST_DELIVERY"]yOperationMode.SchedulingType in ["SCHEDULED", "TIME_SLOT", "TIME_INTERVAL"]
OperationMode.SchedulingTypePara otros pedidos
PessoaAutorizadaRecebimento
Deprecated
QuantidadeItemUnico
Deprecated(Se puede extraer de Bag.Items)
ValorMercado
Bag.Prices.GrossValue / 100(GrossValue se devuelve en centavos)
ValorEntrega
OperationMode.Delivery.Prices.GrossValue / 100Para pedidos dondeOperationMode.Type == "DELIVERY"yOperationMode.Delivery.Provider != "IFOOD" (GrossValue se devuelve en centavos)
Siempre será devuelto, con el envío a cargo de iFood o de la tienda.
ValorConveniencia
Deprecated
ValorRetirada
Deprecated
ValorTroco
Payment.Methods[].Cash.ChangeFor / 100Para pedidos que tienen Payment.Methods[].Cash (ChangeFor se devuelve en centavos)
ValorDesconto
SUM(Benefit.Benefits[].Sponsorships[].Amount.Value) / 100Para pedidos que Benefit.Benefits[].Target != "DELIVERY_FEE"yBenefit.Benefits[].Sponsorships[].Liability == "PARTNER" (Amount.Value se devuelve en centavos)
ValorTotal
Use ValorMercado - ValorDesconto
ValorCorrigido
Deprecated
QuantidadeSacolaResfriada
Package.Coldbag
QuantidadeSacolaSeca
Package.Drybag
IdentificacaoVolumeDescricao
Deprecated
OpcaoTroca
Bag.ReplacementOptions.Mode
Plataforma
SalesChannel.Name
Parceiro.CodigoEntrega
Customer.Localizer.Code
Parceiro.TelefoneLocalizador
Customer.Localizer.Phone
Parceiro.CodigoPedido
ShortCode
Parceiro.Agendado
true *Para pedidos dondeOperationMode.SchedulingType in ["TIME_SLOT", "SCHEDULED"]
Parceiro.CorrelationId
Deprecated
EnderecoEntrega.Id
OperationMode.Delivery.Destination.IdPara pedidos dondeOperationMode.Type == "DELIVERY" (Ahora será un UUID)