tipo de documento do cliente (por exemplo, CPF, RG)
document.Value
string
valor do documento do cliente
billingAddress.streetName
string
logradouro do endereço de cobrança do cliente
billingAddress.streetNumber
string
número na rua do endereço de cobrança do cliente
billingAddress.complement
string
complemento do endereço de cobrança do cliente
billingAddress.zipCode
string
CEP do endereço de cobrança do cliente
billingAddress.district
string
bairro do endereço de cobrança do cliente
billingAddress.city
string
cidade do endereço de cobrança do cliente
billingAddress.state
string
estado do endereço de cobrança do cliente
billingAddress.country
string
país do endereço de cobrança do cliente
billingAddress.latitude
double
latitude do endereço de cobrança do cliente
billingAddress.longitude
double
longitude do endereço de cobrança do cliente
Exemplo:
"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
Descrição
items.UniqueId
string
identificador único do item na sacola
items.Index
integer
índice do item
items.Quantity
integer
quantidade do item
items.Name
string
nome do item
items.Ean
string
código de barras do item
items.Note
string
comentários adicionados pelo cliente no item (por exemplo, remover salada, sem molho, etc.)
items.Weight.Value
double
valor da medida de peso do item
items.Prices.UnitValue.Value
double
valor em centavos de UM item sem nenhum desconto
items.Prices.UnitValue.Currency
string
moeda
items.Prices.SalePriceKg.Value
double
valor em centavos de UM KG do item sem nenhum desconto
items.Prices.SalePriceKg.Currency
string
moeda
items.Prices.GrossValue.Value
double
valor em centavos do preço unitário multiplicado pela quantidade de itens mais o preço total das escolhas (guarnição legada) multiplicado pela quantidade de itens
items.Prices.GrossValue.Currency
string
moeda
items.Product.Plu
string
código interno do parceiro para controle do pacote proprietário
items.Product.IsVariableWeight
bool
identifica se é um item de peso variável
prices.GrossValue.Value
double
valor em centavos todos os itens e itens de guarnição do pedido sem nenhum desconto
prices.GrossValue.Currency
string
moeda
replacementOptions.Mode
string
o que o mercado deve fazer se algum tipo de item estiver ausente do pedido: STORE_CONTACT_CUSTOMER; STORE_CHOOSE_OTHER_ITEMS; STORE_REMOVE_ITEMS
OperationMode.Delivery.DeliveryTime.Window.FromPara pedidos onde OperationMode.SchedulingType in ["TIME_SLOT", "SCHEDULED"] e OperationMode.Type == "DELIVERY"
OperationMode.Takeout.TakeoutTime.Window.FromPara pedidos onde OperationMode.SchedulingType in ["TIME_SLOT", "SCHEDULED"] e OperationMode.Type == "TAKEOUT"
OperationMode.Preparation.StartPara pedidos onde OperationMode.SchedulingType not in ["TIME_SLOT", "SCHEDULED"]
AgendamentoHoraInicio (Extraia a hora)
Igual ao campo AgendamentoDataInicio
AgendamentoDataFim (Extraia a data)
OperationMode.Delivery.DeliveryTime.Window.ToPara pedidos onde OperationMode.SchedulingType in ["TIME_SLOT", "SCHEDULED"] e OperationMode.Type == "DELIVERY"
OperationMode.Takeout.TakeoutTime.Window.ToPara pedidos onde OperationMode.SchedulingType in ["TIME_SLOT", "SCHEDULED"] e OperationMode.Type == "TAKEOUT"
OperationMode.Preparation.EndPara pedidos onde OperationMode.SchedulingType not in ["TIME_SLOT", "SCHEDULED"]
AgendamentoHoraFim (Extraia a hora)
Igual ao campo AgendamentoDataFim
Entrega
truePara pedidos onde OperationMode.Type == "DELIVERY"
Retirada
truePara pedidos onde OperationMode.Type != "DELIVERY"
CpfNaNota
truePara pedidos onde TaxPayer.Identification.Type in ["CPF", "CNPJ"]
Status
DEPRECATED
StatusDescricao
DEPRECATED
Tipo
"EXPRESS"Para pedidos onde OperationMode.Type == "DELIVERY" e OperationMode.Delivery.Code in ["EXPRESS", "FAST_DELIVERY"]
"SCHEDULED"Para pedidos onde OperationMode.Type == "DELIVERY" e OperationMode.Delivery.Code not in ["EXPRESS", "FAST_DELIVERY"] e OperationMode.SchedulingType in ["SCHEDULED", "TIME_SLOT", "TIME_INTERVAL"]
OperationMode.SchedulingTypePara os outros pedidos
PessoaAutorizadaRecebimento
Deprecated
QuantidadeItemUnico
Deprecated(Pode ser extraído de Bag.Items)
ValorMercado
Bag.Prices.GrossValue / 100(GrossValue é retornado em centavos)
ValorEntrega
OperationMode.Delivery.Prices.GrossValue / 100Para pedidos onde OperationMode.Type == "DELIVERY" e OperationMode.Delivery.Provider != "IFOOD" (GrossValue é retornado em centavos)
Sempre será retornado, fretes cobrados pelo iFood ou pela loja.
ValorConveniencia
Deprecated
ValorRetirada
Deprecated
ValorTroco
Payment.Methods[].Cash.ChangeFor / 100Para pedidos que possuem Payment.Methods[].Cash (ChangeFor é retornado em centavos)
ValorDesconto
SUM(Benefit.Benefits[].Sponsorships[].Amount.Value) / 100Para pedidos que Benefit.Benefits[].Target != "DELIVERY_FEE" e Benefit.Benefits[].Sponsorships[].Liability == "PARTNER" (Amount.Value é retornado em 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 onde OperationMode.SchedulingType in ["TIME_SLOT", "SCHEDULED"]
Parceiro.CorrelationId
Deprecated
EnderecoEntrega.Id
OperationMode.Delivery.Destination.IdPara pedidos onde OperationMode.Type == "DELIVERY" (Agora será um UUID)
EnderecoEntrega.Logradouro
OperationMode.Delivery.Destination.StreetNamePara pedidos onde OperationMode.Type == "DELIVERY"
EnderecoEntrega.Numero
OperationMode.Delivery.Destination.StreetNumberPara pedidos onde OperationMode.Type == "DELIVERY"
EnderecoEntrega.Complemento
OperationMode.Delivery.Destination.ComplementPara pedidos onde OperationMode.Type == "DELIVERY"
EnderecoEntrega.Bairro
OperationMode.Delivery.Destination.DistrictPara pedidos onde OperationMode.Type == "DELIVERY"
EnderecoEntrega.Cidade
OperationMode.Delivery.Destination.CityPara pedidos onde OperationMode.Type == "DELIVERY"
EnderecoEntrega.Uf
OperationMode.Delivery.Destination.StatePara pedidos onde OperationMode.Type == "DELIVERY"
EnderecoEntrega.Estado
Deprecated
EnderecoEntrega.Cep
OperationMode.Delivery.Destination.ZipCodePara pedidos onde OperationMode.Type == "DELIVERY"
EnderecoEntrega.Latitude
OperationMode.Delivery.Destination.LatitudePara pedidos onde OperationMode.Type == "DELIVERY"
EnderecoEntrega.Longitude
OperationMode.Delivery.Destination.LongitudePara pedidos onde OperationMode.Type == "DELIVERY"
Cupom.Codigo
Deprecated
Cupom.BeneficioTaxaServico
Deprecated
Cupom.BeneficioTaxaEntrega
Deprecated
Cupom.BeneficioTaxaRetirada
Deprecated
Cupom.ValorBeneficioTaxaServico
Deprecated
Cupom.ValorBeneficioTaxaEntrega
Deprecated
Cupom.ValorBeneficioTaxaRetirada
Deprecated
Loja.Id
Merchant.IdAgora será um UUID
Loja.StoreId
Deprecated
Loja.Nome
Merchant.Name
Loja.Cnpj
Merchant.Cnpj
Loja.Teste
Test
Loja.Status*
Deprecated
Loja.Endereco.Id
Deprecated
Loja.Endereco.Logradouro
Merchant.Address.StreetName
Loja.Endereco.Numero
Merchant.Address.StreetNumber
Loja.Endereco.Complemento
Merchant.Address.Complement
Loja.Endereco.Bairro
Merchant.Address.District
Loja.Endereco.Cidade
Merchant.Address.City
Loja.Endereco.Uf
Merchant.Address.State
Loja.Endereco.Estado
Deprecated
Loja.Endereco.Cep
Merchant.Address.ZipCode
Loja.Endereco.Latitude
Merchant.Address.Latitude
Loja.Endereco.Longitude
Merchant.Address.Longitude
Loja.Rede.Id
Deprecated
Loja.Rede.Nome
Deprecated
Loja.Rede.PathUrl
Deprecated
Loja.Atendimento[].Valor
Deprecated
Loja.Atendimento[].Tipo *
Deprecated
Cliente.Id
Customer.IdAgora será um UUID
Cliente.Nome
Customer.Name
Cliente.Email
Customer.Email
Cliente.Cpf
Customer.Document.ValuePara pedidos onde Customer.Document.Type == "CPF"
Cliente.Cnpj
Customer.Document.ValuePara pedidos onde Customer.Document.Type == "CNPJ"
Cliente.Rg
Customer.Document.ValuePara pedidos onde Customer.Document.Type == "RG"