logo
logo

Docs Order Detalhes do Pedido Groceries

Introdução

Um pedido contém as seguintes informações:

  • Informações gerais - id, data de criação do pedido dentre outros.
  • Package - quantidade de sacolas secas e frias
  • SalesChannel - canal de vendas pelo qual o pedido entra na plataforma (novos canais podem ser adicionados)
  • Merchant - identificação do merchant (loja)
  • TaxPayer - documento usado na geração da nota fiscal para pessoa física
  • Customer - identificação do cliente que deve receber o pedido
  • Bag - coleção dos itens do pedido, preços, e opções de troca do item
  • OperationalMode - informações sobre como esse pedido será servido (e.g by delivery, take-out, etc)
  • Payments - detalhes sobre as formas de pagamento
  • Benefits - benefícios e incentivos aplicados ao pedido
  • InvoiceInformation - informações usadas na geração da nota fiscal para pessoa jurídica

Campos

Informações Gerais

CampoTipoDescrição
iduuidIdentificador único do pedido
shortCodestringId amigável para facilitar a identificação do pedido pela loja.
testbooleanIndica se é um pedido de teste ou não.
createdAtdatetimeData de criação do pedido.
categorystringcategoria do pedido (FOOD, GROCERY, ANOTAI ou FOOD_SELF_SERVICE)

Exemplo:

{
  "id": "32c15e00-9861-4548-b5f0-15580defc999",
  "shortCode": "fc999",
  "test": false,
  "createdAt": "2020-01-01T00:00:00.000Z",
  ...
}

package

CampoTipoDescrição
dryBagintegerquantidade de sacolas secas
coldBagintegerquantidade de sacolas frias

Exemplo:

"package": {
  "dryBag": 1,
  "coldBag": 2
}

SalesChannel

CampoTipoDescrição
namestringnome do canal de vendas (por exemplo, IFOOD, POS, DIGITAL_CATALOG)

Exemplo:

"salesChannel": {
  "name": "IFOOD"
}

Merchant

CampoTipoDescrição
iduuididentificador único da loja
namestringnome da loja
cnpjstringCNPJ da loja
phones[].phoneNumberstringnúmero de telefone da loja
address.streetNamestringlogradouro do endereço da loja
address.streetNumberstringnúmero na rua do endereço da loja
address.complementstringcomplemento do endereço da loja
address.zipCodestringCEP do endereço da loja
address.districtstringbairro do endereço da loja
address.citystringcidade do endereço da loja
address.statestringestado do endereço da loja
address.countrystringpaís do endereço da loja
address.latitudedoublelatitude do endereço da loja
address.longitudedoublelongitude do endereço da loja

Exemplo:

"merchant": {
  "id": "50647eee-5eb6-41a2-b2d8-999998ed677f",
  "name": "Nome do Comerciante",
  "cnpj": "12345678901234",
  "address": {
    "streetName": "Rua do Comerciante",
    "city": "Cidade do Comerciante",
    "complement": "Complemento do Comerciante",
    "country": "País do Comerciante",
    "district": "Distrito do Comerciante",
    "latitude": 123.456,
    "longitude": 789.012,
    "state": "Estado do Comerciante",
    "streetNumber": "123",
    "zipCode": "12345-678"
  },
  "phones": [
    {
      "phoneNumber": "0800 000 0000"
    },
    {
      "phoneNumber": "0800 000 0000"
    }
  ]
}

TaxPayer

CampoTipoDescrição
identification.valuestringvalor do documento de identificação
identification.typestringtipo do documento de identificação (por exemplo, CPF)

Exemplo:

"taxPayer": {
  "identification": {
    "value": "12345678901",
    "type": "CPF"
  }
}

Customer

CampoTipoDescrição
iduuididentificador único do cliente
namestringnome do cliente
phones[].phoneNumberstringlista de números de telefone do cliente
emailstringe-mail do cliente
birthDatedatetimedata de nascimento do cliente
typestringtipo de cliente, NATURAL_PERSON ou LEGAL_PERSON
localizer.Codestringcódigo localizador do cliente
localizer.phonestringtelefone localizador do cliente
document.Typestringtipo de documento do cliente (por exemplo, CPF, RG)
document.Valuestringvalor do documento do cliente
billingAddress.streetNamestringlogradouro do endereço de cobrança do cliente
billingAddress.streetNumberstringnúmero na rua do endereço de cobrança do cliente
billingAddress.complementstringcomplemento do endereço de cobrança do cliente
billingAddress.zipCodestringCEP do endereço de cobrança do cliente
billingAddress.districtstringbairro do endereço de cobrança do cliente
billingAddress.citystringcidade do endereço de cobrança do cliente
billingAddress.statestringestado do endereço de cobrança do cliente
billingAddress.countrystringpaís do endereço de cobrança do cliente
billingAddress.latitudedoublelatitude do endereço de cobrança do cliente
billingAddress.longitudedoublelongitude 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

CampoTipoDescrição
items.UniqueIdstringidentificador único do item na sacola
items.Indexintegeríndice do item
items.Quantityintegerquantidade do item
items.Namestringnome do item
items.Eanstringcódigo de barras do item
items.Notestringcomentários adicionados pelo cliente no item (por exemplo, remover salada, sem molho, etc.)
items.Weight.Valuedoublevalor da medida de peso do item
items.Prices.UnitValue.Valuedoublevalor em centavos de UM item sem nenhum desconto
items.Prices.UnitValue.Currencystringmoeda
items.Prices.SalePriceKg.Valuedoublevalor em centavos de UM KG do item sem nenhum desconto
items.Prices.SalePriceKg.Currencystringmoeda
items.Prices.GrossValue.Valuedoublevalor 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.Currencystringmoeda
items.Product.Plustringcódigo interno do parceiro para controle do pacote proprietário
items.Product.IsVariableWeightboolidentifica se é um item de peso variável
prices.GrossValue.Valuedoublevalor em centavos todos os itens e itens de guarnição do pedido sem nenhum desconto
prices.GrossValue.Currencystringmoeda
replacementOptions.Modestringo que o mercado deve fazer se algum tipo de item estiver ausente do pedido: STORE_CONTACT_CUSTOMER; STORE_CHOOSE_OTHER_ITEMS; STORE_REMOVE_ITEMS

Exemplo:

"bag": {
  "items": [
    {
      "uniqueId": "abc123",
      "index": 1,
      "quantity": 2,
      "name": "Produto 1",
      "ean": "7890123456789",
      "note": "Sem cebola",
      "weight": {
        "value": 500
      },
      "prices": {
        "unitValue": {
          "value": 1000,
          "currency": "BRL"
        },
        "salePriceKg": {
          "value": 5000,
          "currency": "BRL"
        },
        "grossValue": {
          "value": 2000,
          "currency": "BRL"
        }
      },
      "product": {
        "plu": "123456",
        "isVariableWeight": false
      }
    }
  ],
  "prices": {
    "grossValue": {
      "value": 2000,
      "currency": "BRL"
    }
  },
  "replacementOptions": {
    "mode": "STORE_CONTACT_CUSTOMER"
  }
}

OperationMode

CampoTipoDescrição
typestringtipo da operação de entrega (por exemplo, DELIVERY, TAKE-OUT)
schedulingTypestringIMMEDIATE, TIME_SLOT ou TIME_INTERVAL
delivery.Providerstringprovedor logístico responsável pela entrega (por exemplo, ifood, merchant, etc)
delivery.Typestringtipo de entrega (por exemplo, EXPRESS, IMMEDIATE, SCHEDULED)
delivery.Codestringidentificador único do método de entrega
delivery.Destination.iduuididentificador único do endereço de entrega escolhido pelo cliente
delivery.Destination.streetNamestringlogradouro do endereço de entrega escolhido pelo cliente
delivery.Destination.streetNumberstringnúmero na rua do endereço de entrega escolhido pelo cliente
delivery.Destination.complementstringcomplemento do endereço de entrega escolhido pelo cliente
delivery.Destination.zipCodestringCEP do endereço de entrega escolhido pelo cliente
delivery.Destination.districtstringbairro do endereço de entrega escolhido pelo cliente
delivery.Destination.citystringcidade do endereço de entrega escolhido pelo cliente
delivery.Destination.statestringestado do endereço de entrega escolhido pelo cliente
delivery.Destination.countrystringpaís do endereço de entrega escolhido pelo cliente
delivery.Destination.latitudedoublelatitude do endereço de entrega escolhido pelo cliente
delivery.Destination.longitudedoublelongitude do endereço de entrega escolhido pelo cliente
delivery.Prices.GrossValue.Valuedoublevalor da entrega em centavos
delivery.Prices.GrossValue.Currencystringmoeda
delivery.DeliveryTime.Window.Fromdatetimeinício da janela de agendamento da entrega
delivery.DeliveryTime.Window.Todatetimefim da janela de agendamento da entrega
takeout.TakeoutTime.Window.Fromdatetimeinício da janela de agendamento da retirada
takeout.TakeoutTime.Window.Todatetimefim da janela de agendamento da retirada
preparation.Startdatetimeinício da preparação
preparation.Enddatetimefim da preparação

Exemplo:

"operationMode": {
  "type": "DELIVERY",
  "schedulingType": "IMMEDIATE",
  "delivery": {
    "provider": "ifood",
    "type": "EXPRESS",
    "destination": {
      "id": "12345",
      "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"
    },
    "prices": {
      "grossValue": {
        "value": 2000,
        "currency": "BRL"
      }
    },
    "deliveryTime": {
      "window": {
        "from": "2024-03-13T10:00:00",
        "to": "2024-03-13T12:00:00"
      }
    },
    "code": "EXPRESS"
  },
  "preparation": {
    "start": "2024-03-13T09:00:00",
    "end": "2024-03-13T10:00:00"
  }
}

Payment

CampoTipoDescrição
methods[].UniqueIdstringidentificador único
methods[].Namestringnome do método de pagamento (por exemplo, Crédito, Débito e etc)
methods[].InPersonboolpagamento presencial
methods[].Liabilitystringquem deve ser pago (por exemplo, ifood, comerciante, etc)
methods[].Amount.Valuedoublequanto foi pago em centavos
methods[].Amount.Currencystringmoeda
methods[].Cash.ChangeFor.Valuedoublequando o método de pagamento é dinheiro, este nó é usado para mostrar quanto o cliente pagará para que possamos calcular o troco
methods[].Cash.ChangeFor.Currencystringmoeda
methods[].Card.Brandstringbandeira do cartão
methods[].Card.CardNumberstringo número do cartão
methods[].Card.Providerstringo provedor do cartão (por exemplo, MasterCard)
methods[].Wallet.Providerstringo provedor da carteira digital
methods[].Digital.Datastringo dado do pagamento digital (por exemplo, chave pix)

Exemplo:

"payment": {
  "methods": [
    {
      "name": "Crédito",
      "inPerson": false,
      "liability": "ifood",
      "amount": {
        "value": 2500,
        "currency": "BRL"
      },
      "card": {
        "brand": "Visa",
        "cardNumber": "************1234",
        "provider": "visa"
      },
      "uniqueId": "abc123"
    },
    {
      "name": "Dinheiro",
      "inPerson": true,
      "liability": "merchant",
      "amount": {
        "value": 3000,
        "currency": "BRL"
      },
      "cash": {
        "changeFor": {
          "value": 5000,
          "currency": "BRL"
        }
      },
      "uniqueId": "def456"
    }
  ]
}

Benefits

CampoTipoDescrição
BenefitsList.TargetIdstringo ID de destino (para descontos em itens, aqui é usado o catalogItemId)
BenefitsList.Targetstringonde o desconto se aplica (por exemplo, carrinho, um item específico, taxa de entrega, outra taxa, etc)
BenefitsList.Sponsorships.Liabilitystringo patrocinador (ifood, comerciante, coca-cola, etc)
BenefitsList.Sponsorships.Amount.Valuedoubleo valor do benefício em centavos
BenefitsList.Sponsorships.Amount.Currencystringmoeda

Exemplo:

"benefits": {
  "benefitsList": [
    {
      "targetId": "123456",
      "target": "cart",
      "sponsorships": [
        {
          "liability": "ifood",
          "amount": {
            "value": 2000,
            "currency": "BRL"
          }
        },
        {
          "liability": "merchant",
          "amount": {
            "value": 1500,
            "currency": "BRL"
          }
        }
      ]
    },
    {
      "targetId": "789012",
      "target": "item",
      "sponsorships": [
        {
          "liability": "coca-cola",
          "amount": {
            "value": 500,
            "currency": "BRL"
          }
        }
      ]
    }
  ]
}

InvoiceInformation

CampoTipoDescrição
StateRegistrationstringregistro estadual

Exemplo:

"invoiceInformation": {
  "stateRegistration": "123456789"
}

Migração da SiteMercado Service API

Máquina de status

Legacy

EMI
SEP
ENT/ENP/RET/REP
FIN
DEV
CAN

Novo

PLACED
CONFIRMED
SEPARATION_STARTED
SEPARATION_ENDED
DISPATCHED
ARRIVED
CONCLUDED
CANCELLED

Exemplo de pedidos - Delivery

Legacy

{
    "idLoja": 11111,
    "idCliente": 510034978,
    "idPedido": "fc18f00b-95c8-4cfa-b293-d7c93195d23b",
    "codigo": "11111-Z510034984",
    "codigoLoja": "222222",
    "data": "2024-03-23T00:00:00",
    "hora": "21:31",
    "dataHora": "2024-03-23T21:31:56.1863131",
    "agendamentoDataInicio": "2024-03-25T00:00:00",
    "agendamentoHoraInicio": "10:00",
    "agendamentoDataFim": "2024-03-25T00:00:00",
    "agendamentoHoraFim": "12:00",
    "entrega": true,
    "retirada": false,
    "cpfNaNota": true,
    "status": "FIN",
    "tipo": "SCHEDULED",
    "statusDescricao": "Finalizado",
    "pessoaAutorizadaRecebimento": "",
    "quantidadeItemUnico": 1,
    "valorMercado": 7.06,
    "valorConveniencia": 0,
    "quantidadeSacolaResfriada": 1,
    "quantidadeSacolaSeca": 0,
    "valorEntrega": 1,
    "valorRetirada": 0,
    "valorTroco": 0,
    "valorDesconto": 0,
    "valorTotal": 8.06,
    "valorCorrigido": 8.06,
    "opcaoTroca": "STORE_CHOOSE_OTHER_ITEMS",
    "parceiro": {
        "codigoEntrega": "80835343",
        "codigoPedido": "3760",
        "agendado": true
    },
    "plataforma": "IFOOD",
    "enderecoEntrega": {
        "id": 509590658,
        "logradouro": "R. das Entregas",
        "numero": "999",
        "complemento": "Casa 3",
        "bairro": "Parque Vila Maria",
        "cidade": "São Paulo",
        "uf": "SP",
        "cep": "02169000",
        "latitude": -23.520088,
        "longitude": -46.580377
    },
    "loja": {
        "id": 11111,
        "storeId": "caabfbc7-b31c-482a-b130-90de2b540d81",
        "nome": "Mercadão Vila Maria",
        "cnpj": "41574314000185",
        "status": "Ativa",
        "endereco": {
            "logradouro": "Av Mercadao De figueiredo",
            "numero": "61",
            "bairro": "VILA MARIA",
            "cidade": "SAO PAULO",
            "uf": "SP",
            "cep": "02179999"
        },
        "rede": {
            "id": 289312,
            "nome": "Mercadao 1"
        },
        "atendimento": []
    },
    "cliente": {
        "id": 1100348881,
        "nome": "Irany Natly",
        "email": "IRANYMAIL@EMAIL.COM",
        "cpf": "57560161049",
        "tipo": "Fisica",
        "publicidadeEmail": false,
        "publicidadeSms": false,
        "telefoneCelular": "11999625991"
    },
    "items": [
        {
            "id": 5056629492,
            "uniqueId": "78c8e027-a0ad-4140-9ebd-f8aa4de3cec0",
            "index": 0,
            "codigo": "36763-A510034984",
            "codigoLoja": "510034984",
            "pesoVariavel": false,
            "codigoBarra": "7896031232083",
            "plu": "767149",
            "produto": "Salsicha Bordon Viena 180g",
            "quantidade": 3,
            "quantidade3": 3,
            "valor": 4.84,
            "valorTotal": 14.52,
            "indisponivel": false,
            "desistencia": false,
            "valorOriginal": 4.84,
            "pesoVariavelVendidoPorUnidade": false
        }
    ],
    "pagamentos": [
        {
            "id": 4061,
            "nome": "iFood PIX",
            "valor": 7.06,
            "tipo": "Online"
        }
    ],
    "beneficios": [
        {
            "patrocinio": "IFOOD",
            "valor": 4.2,
            "tipo": "ITEM",
            "itemId": 5056629492
        },
        {
            "patrocinio": "EXTERNAL",
            "valor": 2.26,
            "tipo": "ITEM",
            "itemId": 5056629492
        }
    ],
    "beneficiosEntrega": {}
}

Novo

{
  "id": "fc18f00b-95c8-4cfa-b293-d7c93195d23b",
  "shortCode": "97611",
  "package": {
    "drybag": 1,
    "coldbag": 1
  },
  "test": false,
  "createdAt": "2024-03-24T00:31:56.1863131Z",
  "category": "GROCERY",
  "salesChannel": {
    "name": "IFOOD"
  },
  "merchant": {
    "id": "caabfbc7-b31c-482a-b130-90de2b540d81",
    "name": "Mercadão Vila Maria",
    "cnpj": "41574314000185",
    "address": {
      "streetName": "Av Mercadao De figueiredo",
      "city": "SAO PAULO",
      "complement": null,
      "country": "BR",
      "district": "VILA MARIA",
      "latitude": -23.524411,
      "longitude": -46.574299,
      "state": "SP",
      "streetNumber": "61",
      "zipCode": "02179999"
    },
    "phones": [
      {
        "phone": "999995566"
      }
    ]
  },
  "taxPayer": {
    "identification": {
      "value": "16695141886",
      "type": "CPF"
    }
  },
  "customer": {
    "id": "da0e292e-f8e1-43e7-b781-21d69f13f079",
    "name": "Irany Natly",
    "phones": [
      {
        "phone": "11999625991"
      }
    ],
    "email": "IRANYMAIL@EMAIL.COM",
    "birthDate": null,
    "document": {
      "type": "CPF",
      "value": "57560161049"
    },
    "billingAddress": {
      "streetName": "R. das Perobas",
      "city": "São Paulo",
      "complement": "Casa 111",
      "country": null,
      "district": "Parque Vila Maria",
      "latitude": -23.520093,
      "longitude": -46.5800923,
      "state": "SP",
      "streetNumber": "91C",
      "zipCode": "06649023"
    },
    "type": "NATURAL_PERSON",
    "localizer": {
      "code": "908353",
      "phone": "0800 100 9988"
    }
  },
  "bag": {
    "items": [
      {
        "uniqueId": "78c8e027-a0ad-4140-9ebd-f8aa4de3cec0",
        "quantity": 3,
        "name": "Salsicha Bordon Viena 180g",
        "ean": "7896031232083",
        "note": null,
        "weight": {
          "value": 540
        },
        "prices": {
          "unitValue": {
            "value": 484,
            "currency": "BRL"
          },
          "salePriceKg": null,
          "grossValue": {
            "value": 1452,
            "currency": "BRL"
          }
        },
        "product": {
          "plu": "767149",
          "isVariableWeight": false
        },
        "unavailable": false
      }
    ],
    "prices": {
      "grossValue": {
        "value": 1452,
        "currency": "BRL"
      }
    },
    "replacementOptions": {
      "mode": "STORE_CHOOSE_OTHER_ITEMS"
    }
  },
  "operationMode": {
    "type": "DELIVERY",
    "schedulingType": "TIME_SLOT",
    "delivery": {
      "provider": "IFOOD",
      "type": "SCHEDULED",
      "destination": {
        "id": "fc6853d8-12d7-4e80-bcce-18ea0f83efa8",
        "streetName": "R. das Entregas",
        "city": "São Paulo",
        "complement": "Casa 3",
        "country": "BR",
        "district": "Parque Vila Maria",
        "latitude": -23.520088,
        "longitude": -46.580377,
        "state": "SP",
        "streetNumber": "999",
        "zipCode": "02169000"
      },
      "prices": {
        "grossValue": {
          "value": 100,
          "currency": "BRL"
        }
      },
      "deliveryTime": {
        "window": {
          "from": "2024-03-25T13:00:00Z",
          "to": "2024-03-25T15:00:00Z"
        }
      },
      "code": "DEFAULT"
    },
    "takeout": null,
    "preparation": {
      "start": "2024-03-25T12:30:00Z",
      "end": "2024-03-25T12:45:00Z"
    }
  },
  "payment": {
    "methods": [
      {
        "name": "PIX",
        "inPerson": false,
        "liability": "IFOOD",
        "amount": {
          "value": 806,
          "currency": "BRL"
        },
        "cash": null,
        "card": null,
        "wallet": null,
        "digital": null,
        "uniqueId": "16e000f5-f76d-49cd-ac59-888a0848ad93"
      }
    ]
  },
  "benefit": {
    "benefits": [
      {
        "targetId": "038a39f5-4330-4e59-9bbe-58952e38280f",
        "target": "ITEM",
        "sponsorships": [
          {
            "liability": "OWN",
            "amount": {
              "value": 420,
              "currency": "BRL"
            }
          }
        ]
      },
      {
        "targetId": "3f53906e-1d7e-4917-81c0-9f9e14235128",
        "target": "ITEM",
        "sponsorships": [
          {
            "liability": "EXTERNAL",
            "amount": {
              "value": 226,
              "currency": "BRL"
            }
          }
        ]
      }
    ]
  },
  "invoiceInformation": null
}

Exemplo de pedidos - Takeout

Legacy

{
    "idLoja": 75872,
    "idCliente": 510080108,
    "idPedido": "a619d3aa-d058-4af1-9b46-fce3df9334ed",
    "codigo": "5272-A510080114",
    "codigoLoja": "510080114",
    "data": "2024-03-24T00:00:00",
    "hora": "10:29",
    "dataHora": "2024-03-24T10:29:13.5129199",
    "agendamentoDataInicio": "2024-03-24T00:00:00",
    "agendamentoHoraInicio": "10:29",
    "agendamentoDataFim": "2024-03-24T00:00:00",
    "agendamentoHoraFim": "11:14",
    "entrega": false,
    "retirada": true,
    "cpfNaNota": true,
    "status": "FIN",
    "tipo": "IMMEDIATE",
    "statusDescricao": "Finalizado",
    "pessoaAutorizadaRecebimento": "",
    "quantidadeItemUnico": 1,
    "valorMercado": 27.39,
    "valorConveniencia": 0,
    "quantidadeSacolaResfriada": 0,
    "quantidadeSacolaSeca": 1,
    "valorEntrega": 0,
    "valorRetirada": 0,
    "valorTroco": 0,
    "valorDesconto": 0,
    "valorTotal": 27.39,
    "valorCorrigido": 27.39,
    "opcaoTroca": "STORE_REMOVE_ITEMS",
    "parceiro": {
        "codigoEntrega": "98743895",
        "codigoPedido": "8468",
        "agendado": false
    },
    "plataforma": "IFOOD",
    "loja": {
        "id": 75872,
        "storeId": "62d5881f-b7fd-493c-80a2-1a5ccc50bf29",
        "nome": "Mercadao Varejista",
        "cnpj": "90015416000176",
        "status": "Ativa",
        "endereco": {
            "logradouro": "RUA DO MERCADAO",
            "numero": "6",
            "bairro": "Ressaca",
            "cidade": "CONTAGEM",
            "uf": "MG",
            "cep": "32000340"
        },
        "rede": {
            "id": 299942,
            "nome": "Mercadao 100"
        },
        "atendimento": []
    },
    "cliente": {
        "id": 519981108,
        "nome": "JULIA GRAMISCELLI CERQUEIRA",
        "email": "JUGRAMMAIL@EMAIL.COM",
        "cpf": "82743786019",
        "tipo": "Fisica",
        "publicidadeEmail": false,
        "publicidadeSms": false,
        "telefoneCelular": "31993200022"
    },
    "items": [
        {
            "id": 5056851281,
            "uniqueId": "ba1eb819-af83-480a-979c-e8bb18fa45da",
            "index": 0,
            "codigo": "5272-A510080114",
            "codigoLoja": "510080114",
            "pesoVariavel": false,
            "codigoBarra": "7896006711155",
            "produto": "Arroz Branco Longo Fino Polido Tipo 1 Camil 5kg",
            "quantidade": 1,
            "quantidade3": 1,
            "valor": 30.79,
            "valorTotal": 30.79,
            "indisponivel": false,
            "desistencia": false,
            "valorOriginal": 30.79,
            "pesoVariavelVendidoPorUnidade": false
        }
    ],
    "pagamentos": [
        {
            "id": 4060,
            "nome": "iFood Carteira Digital",
            "valor": 27.39,
            "tipo": "Online",
            "transacoes": [
                {
                    "bandeira": "MOVILE_PAY",
                    "transactionCode1": "92f0d967-0380-4403-aa58-e9dd8b969055",
                    "valor": 27.39,
                    "dataHora": "2024-03-24T10:29:13.5129199"
                }
            ]
        }
    ],
    "beneficios": [
        {
            "patrocinio": "IFOOD",
            "valor": 3.4,
            "tipo": "ITEM",
            "itemId": 5056851282
        }
    ],
    "beneficiosEntrega": {}
}

Novo

{
  "id": "a619d3aa-d058-4af1-9b46-fce3df9334ed",
  "shortCode": "8468",
  "package": {
    "drybag": 3,
    "coldbag": 0
  },
  "test": false,
  "createdAt": "2024-03-24T13:29:13.5129199Z",
  "category": "GROCERY",
  "salesChannel": {
    "name": "IFOOD"
  },
  "merchant": {
    "id": "62d5881f-b7fd-493c-80a2-1a5ccc50bf29",
    "name": "Mercadao Varejista",
    "cnpj": "90015416000176",
    "address": {
      "streetName": "RUA DO MERCADAO",
      "city": "CONTAGEM",
      "complement": null,
      "country": "BR",
      "district": "Ressaca",
      "latitude": -19.8811104,
      "longitude": -44.02099,
      "state": "MG",
      "streetNumber": "6",
      "zipCode": "32000340"
    },
    "phones": [
      {
        "phone": "30091444"
      }
    ]
  },
  "taxPayer": {
    "identification": {
      "value": "82743786019",
      "type": "CPF"
    }
  },
  "customer": {
    "id": "5f108982-73ba-4327-9fcb-f58cd0cf1954",
    "name": "JULIA GRAMISCELLI CERQUEIRA",
    "phones": [
      {
        "phone": "31993200022"
      }
    ],
    "email": "JUGRAMMAIL@EMAIL.COM",
    "birthDate": null,
    "document": {
      "type": "CPF",
      "value": "82743786019"
    },
    "billingAddress": null,
    "type": "NATURAL_PERSON",
    "localizer": {
      "code": "987881895",
      "phone": "0800 100 9988"
    }
  },
  "bag": {
    "items": [
      {
        "uniqueId": "ba1eb819-af83-480a-979c-e8bb18fa45da",
        "quantity": 1,
        "name": "Arroz Branco Longo Fino Polido Tipo 1 Camil 5kg",
        "ean": "7896006711155",
        "note": null,
        "weight": {
          "value": 5000
        },
        "prices": {
          "unitValue": {
            "value": 3079,
            "currency": "BRL"
          },
          "salePriceKg": null,
          "grossValue": {
            "value": 3079,
            "currency": "BRL"
          }
        },
        "product": {
          "plu": null,
          "isVariableWeight": false
        },
        "unavailable": false
      }
    ],
    "prices": {
      "grossValue": {
        "value": 3079,
        "currency": "BRL"
      }
    },
    "replacementOptions": {
      "mode": "STORE_REMOVE_ITEMS"
    }
  },
  "operationMode": {
    "type": "TAKEOUT",
    "schedulingType": "IMMEDIATE",
    "delivery": null,
    "takeout": {
      "takeoutTime": {
        "window": {
          "from": "2024-03-24T14:14:13.5129199Z",
          "to": "2024-03-24T14:24:13.5129199Z"
        }
      }
    },
    "preparation": {
      "start": "2024-03-24T13:29:13.512Z",
      "end": "2024-03-24T14:14:13.512Z"
    }
  },
  "payment": {
    "methods": [
      {
        "name": "DIGITAL_WALLET",
        "inPerson": false,
        "liability": "MOVILE_PAY",
        "amount": {
          "value": 2739,
          "currency": "BRL"
        },
        "cash": null,
        "card": {
          "brand": "MOVILE_PAY",
          "cardNumber": null,
          "provider": null
        },
        "wallet": null,
        "digital": null,
        "uniqueId": "903b0ce1-6782-477f-8fb6-b1a0ebc4acee"
      }
    ]
  },
  "benefit": {
    "benefits": [
      {
        "targetId": "ba1eb819-af83-480a-979c-e8bb18fa45da",
        "target": "ITEM",
        "sponsorships": [
          {
            "liability": "OWN",
            "amount": {
              "value": 340,
              "currency": "BRL"
            }
          }
        ]
      }
    ]
  },
  "invoiceInformation": null
}

De/Para do payload

  • IdLoja

    • Deprecated

  • IdCupom

    • Deprecated

  • IdCliente

    • Deprecated

  • IdPedido

    • Deprecated

  • OrderId

    • Id Agora será um UUID

  • Codigo

    • Deprecated

  • CodigoLoja

    • Deprecated

  • DataHora

    • CreatedAt

  • Data(Extraia a data)

    • Igual ao campo DataHora

  • Hora (Extraia a hora)

    • Igual ao campo DataHora

  • AgendamentoDataInicio (Extraia a data)

    • OperationMode.Delivery.DeliveryTime.Window.From Para pedidos onde OperationMode.SchedulingType in ["TIME_SLOT", "SCHEDULED"] e OperationMode.Type == "DELIVERY"
    • OperationMode.Takeout.TakeoutTime.Window.From Para pedidos onde OperationMode.SchedulingType in ["TIME_SLOT", "SCHEDULED"] e OperationMode.Type == "TAKEOUT"
    • OperationMode.Preparation.Start Para 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.To Para pedidos onde OperationMode.SchedulingType in ["TIME_SLOT", "SCHEDULED"] e OperationMode.Type == "DELIVERY"
    • OperationMode.Takeout.TakeoutTime.Window.To Para pedidos onde OperationMode.SchedulingType in ["TIME_SLOT", "SCHEDULED"] e OperationMode.Type == "TAKEOUT"
    • OperationMode.Preparation.End Para pedidos onde OperationMode.SchedulingType not in ["TIME_SLOT", "SCHEDULED"]

  • AgendamentoHoraFim (Extraia a hora)

    • Igual ao campo AgendamentoDataFim

  • Entrega

    • true Para pedidos onde OperationMode.Type == "DELIVERY"

  • Retirada

    • true Para pedidos onde OperationMode.Type != "DELIVERY"

  • CpfNaNota

    • true Para 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.SchedulingType Para 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 / 100 Para 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 / 100 Para pedidos que possuem Payment.Methods[].Cash (ChangeFor é retornado em centavos)

  • ValorDesconto

    • SUM(Benefit.Benefits[].Sponsorships[].Amount.Value) / 100 Para 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.Id Para pedidos onde OperationMode.Type == "DELIVERY" (Agora será um UUID)

  • EnderecoEntrega.Logradouro

    • OperationMode.Delivery.Destination.StreetName Para pedidos onde OperationMode.Type == "DELIVERY"

  • EnderecoEntrega.Numero

    • OperationMode.Delivery.Destination.StreetNumber Para pedidos onde OperationMode.Type == "DELIVERY"

  • EnderecoEntrega.Complemento

    • OperationMode.Delivery.Destination.Complement Para pedidos onde OperationMode.Type == "DELIVERY"

  • EnderecoEntrega.Bairro

    • OperationMode.Delivery.Destination.District Para pedidos onde OperationMode.Type == "DELIVERY"

  • EnderecoEntrega.Cidade

    • OperationMode.Delivery.Destination.City Para pedidos onde OperationMode.Type == "DELIVERY"

  • EnderecoEntrega.Uf

    • OperationMode.Delivery.Destination.State Para pedidos onde OperationMode.Type == "DELIVERY"

  • EnderecoEntrega.Estado

    • Deprecated

  • EnderecoEntrega.Cep

    • OperationMode.Delivery.Destination.ZipCode Para pedidos onde OperationMode.Type == "DELIVERY"

  • EnderecoEntrega.Latitude

    • OperationMode.Delivery.Destination.Latitude Para pedidos onde OperationMode.Type == "DELIVERY"

  • EnderecoEntrega.Longitude

    • OperationMode.Delivery.Destination.Longitude Para 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.Id Agora 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.Id Agora será um UUID

  • Cliente.Nome

    • Customer.Name

  • Cliente.Email

    • Customer.Email

  • Cliente.Cpf

    • Customer.Document.Value Para pedidos onde Customer.Document.Type == "CPF"

  • Cliente.Cnpj

    • Customer.Document.Value Para pedidos onde Customer.Document.Type == "CNPJ"

  • Cliente.Rg

    • Customer.Document.Value Para pedidos onde Customer.Document.Type == "RG"

  • Cliente.Ie

    • InvoiceInformation.StateRegistration

  • Cliente.Tipo*

    • Customer.Type Agora será ["NATURAL_PERSON", "LEGAL_PERSON"]

  • Cliente.PublicidadeEmail

    • Deprecated

  • Cliente.PublicidadeSms

    • Deprecated

  • Cliente.DataNascimento

    • Customer.BirthDate

  • Cliente.Genero*

    • Deprecated

  • Cliente.TelefoneCelular

    • Customer.Phones[].PhoneNumber

  • Cliente.TelefoneFixo

    • Customer.Phones[].PhoneNumber

  • Cliente.Cadastro

    • Deprecated

  • Cliente.Endereco.Id

    • Deprecated

  • Cliente.Endereco.Logradouro

    • Customer.BillingAddress.StreetName

  • Cliente.Endereco.Numero

    • Customer.BillingAddress.StreetNumber

  • Cliente.Endereco.Complemento

    • Customer.BillingAddress.Complement

  • Cliente.Endereco.Bairro

    • Customer.BillingAddress.District

  • Cliente.Endereco.Cidade

    • Customer.BillingAddress.City

  • Cliente.Endereco.Uf

    • Customer.BillingAddress.State

  • Cliente.Endereco.Estado

    • Deprecated

  • Cliente.Endereco.Cep

    • Customer.BillingAddress.ZipCode

  • Cliente.Endereco.Latitude

    • Customer.BillingAddress.Latitude

  • Cliente.Endereco.Longitude

    • Customer.BillingAddress.Longitude

  • Items.Id

    • Deprecated

  • Items.UniqueId

    • Bag.Items[].UniqueId

  • Items.Index

    • Deprecated

  • Items.Codigo

    • Deprecated

  • Items.CodigoLoja

    • Deprecated

  • Items.PesoVariavel

    • Bag.Items[].Product.IsVariableWeight

  • Items.CodigoBarra

    • Bag.Items[].Ean

  • Items.Plu

    • Bag.Items[].Product.Plu

  • Items.Produto

    • Bag.Items[].Name

  • Items.IdProduto

    • Deprecated

  • Items.Observacao

    • Bag.Items[].Note

  • Items.Quantidade

    • Bag.Items[].Weight.Value Para pedidos onde Bag.Items[].Product.IsVariableWeight == true (Weight.Value é retornado em gramas)
    • Bag.Items[].Quantity Para pedidos onde Bag.Items[].Product.IsVariableWeight == false

  • Items.Quantidade3

    • Deprecated

  • Items.Valor

    • Bag.Items[].Prices.SalePriceKg.Value / 100 Para pedidos onde Bag.Items[].Product.IsVariableWeight == true (SalePriceKg.Value é retornado em centavos)
    • Bag.Items[].Prices.UnitValue.Value / 100 Para pedidos onde Bag.Items[].Product.IsVariableWeight == false (UnitValue.Value é retornado em centavos)

  • Items.ValorTotal

    • Bag.Items[].Prices.GrossValue / 100 (GrossValue é retornado em centavos)

  • Items.Indisponivel

    • Bag.Items[].Unavailable

  • Items.Desistencia

    • Deprecated

  • Items.ValorOriginal

    • Deprecated

  • Items.PesoVariavelVendidoPorUnidade

    • Deprecated

  • Pagamentos[].Id

    • Payment.Methods[].UniqueId

  • Pagamentos[].Nome

    • Payment.Methods[].Name

  • Pagamentos[].Valor

    • Payment.Methods[].Amount.Value / 100 (Amount.Value é retornado em centavos)

  • Pagamentos[].ValorCorrigido

    • Deprecated

  • Pagamentos[].Tipo

    • Payment.Methods[].InPerson Onde true é OFFLINE e false é ONLINE

  • Pagamentos[].Transacoes.Bandeira

    • Payment.Methods[].Card.Brand Para pedidos onde Payment.Name in ["Credit", "Debit"]

  • Pagamentos[].Transacoes.InicioCartao

    • Payment.Methods[].Card.CardNumber Para pedidos onde Payment.Name in ["Credit", "Debit"] (Agora será o número do cartão mascarado)

  • Pagamentos[].Transacoes.FimCartao

    • Payment.Methods[].Card.CardNumber Para pedidos onde Payment.Name in ["Credit", "Debit"] (Agora será o número do cartão mascarado)

  • Pagamentos[].Transacoes.Adquirente

    • Payment.Methods[].Card.ProviderPara pedidos onde Payment.Name in ["Credit", "Debit"]

  • Pagamentos[].Transacoes.TransactionCode1

    • Deprecated

  • Pagamentos[].Transacoes.TransactionCode2

    • Deprecated

  • Pagamentos[].Transacoes.TransactionCode3

    • Deprecated

  • Pagamentos[].Transacoes.Valor

    • Payment.Methods[].Amount.Value / 100 Para pedidos onde Payment.Name in ["Credit", "Debit"] (Amount.Value é retornado em centavos)

  • Pagamentos[].Transacoes.DataHora

    • Deprecated

  • Beneficios[].Patrocinio

    • Benefit.Benefits[].Sponsorships[].Liability
    • AtualNovo
      MERCHANTPARTNER
      IFOODOWN
    • Sempre serão retornados os benefícios concedidos pelo iFood ou pela loja.

  • Beneficios[].Valor

    • Benefit.Benefits[].Sponsorships[].Amount.Value (Amount.Value é retornado em centavos)

  • Beneficios[].Tipo

    • Benefit.Benefits[].Target

  • Beneficios[].ItemId

    • Benefit.Benefits[].TargetId (Agora será o UUID do item)

  • BeneficiosEntrega[].Patrocinio

    • O mesmo que Beneficios[].Patrocinio Para pedidos onde Benefit.Benefits[].Target == "DELIVERY_FEE"

  • BeneficiosEntrega[].Valor

    • O mesmo que Beneficios[].Valor Para pedidos onde Benefit.Benefits[].Target == "DELIVERY_FEE"

  • BeneficiosEntrega[].Tipo

    • O mesmo que Beneficios[].Tipo Para pedidos onde Benefit.Benefits[].Target == "DELIVERY_FEE"

  • BeneficiosEntrega[].ItemId

    • O mesmo que Beneficios[].ItemId Para pedidos onde Benefit.Benefits[].Target == "DELIVERY_FEE"