Kitchen

Portal do Desenvolvedor


Bem vindo!

Aqui, você vai conhecer o Programa iFood Integra e acessar as documentações de que precisa para iniciar sua integração com nossa plataforma de maneira rápida e segura.

Além disso, vai ter acesso a guias práticos e ao nosso Suporte.

Endpoints v2.0 (Novo modelo)

Neste cenário, o campo correlationId do evento refere-se à referência do pedido e deve ser fornecido a este endpoint. Atenção, o v2 está disponível apenas para detalhes de pedidos (/orders/{reference}).

https://pos-api.ifood.com.br/v2.0/orders/{reference}

Principais mudanças da v1 para v2?

● Adição do campo de benefits
○ Consiste numa lista de benefícios que o pedido pode possuir.
■ Value: objeto com o valor do desconto com as seguintes propriedades:
● Currency: sigla da moeda. Ex: BRL;
● Value: Valor
■ Target: determina qual o alvo do desconto. Valores possíveis:
○ ITEM: desconto em um item do pedido;
○ CART: desconto no valor somado dos itens;
○ DELIVERY_FEE: desconto na taxa de entrega;
■ Type: determina qual a origem do desconto. Valores possíveis:
● USER_TAG: desconto vinculado ao cliente que realizou o pedido;
● ITEM_TAG: desconto vinculado a um item do pedido;
● VOUCHER: desconto vinculado a um voucher;
■ sponsorshipValues: mapa de string e value que mostra o valor pago por cada uma das partes envolvidas no benefício. A chave OWN possui o valor do desconto que está sendo pago pela iFood. A chave PARTNER indica o valor do desconto que está sendo pago pelo restaurante.
■ Adição do campo scheduled: flag que indica se o pedido é agendado ou não.
● Adição do campo preparationStartDateTime: Data e horário esperados para que o restaurante inicie o preparo do pedido.
● Adição do campo isTest: flag que indica se o pedido é de teste ou não. Caso seja de teste, o mesmo não precisa ser preparado (o pagamento não é realizado para nenhuma das pontas).
● Adição do campo authorizationCode dentro de payments: código com código de autorização do pagamento online.
● Novo campo orderId com o id do pedido no formato de UUID, prefira esse campo ao invés do id antigo.

Exemplo Benefits (Desconto) Json

"benefits": [
{
"value": 10,
"sponsorshipValues": { |Valor do Subsídio|
"IFOOD": 10, |Ifood Subsidiando |
"MERCHANT": 0
},
"target": "CART" |Desconto no valor somado dos itens|
},
{
"value": 9.6,
"sponsorshipValues": { |Valor do Subsídio|
"IFOOD": 0,
"MERCHANT": 9.6 |Restaurante Subsidiando|
},
"target": "DELIVERY_FEE" |Desconto na taxa de entrega|
}
]
}

{
    "id": "ff80808169a059af0169a06d5566026d", // DEPRECATED - antigo formato de id. Olhar id dentro do "merchant"
    "reference": "4811364117803040", 
    "shortReference": "1831", 
    "createdAt": "2019-03-21T13:25:13.501Z", 
    "scheduled": false, 
    "type": "DELIVERY", 
    "merchant": {
        "id": "72eebc48-0fd8-45ca-b272-36465e7e37b3", 
        "name": "Restaurante do iFood", 
        "address": {
            "formattedAddress": "RUA RAIO DE SOL", 
            "country": "BR", 
            "state": "SP", 
            "city": "CAMPINAS", 
            "neighborhood": "CENTRO", 
            "streetName": "RUA RAIO DE SOL", 
            "streetNumber": "01", 
            "postalCode": "69923000"
        }
    }, 
    "payments": [
        { // DEPRECATED - antigo formato de desconto. Olhar benefits
            "name": "Voucher",  
            "code": "VOUCHER", 
            "value": 31.02, 
            "prepaid": true, 
            "collector": "IFood", 
            "issuer": "Voucher"
        }, 
        {
            "name": "MASTERCARD •••• 1111", 
            "code": "MC", 
            "value": 13.98, 
            "prepaid": true, 
            "transaction": "LT1c14cf46-2781-41ba-9e37-37fde4660290", 
            "issuer": "MASTERCARD •••• 1111", 
            "authorizationCode": "LT"
        }
    ], 
    "customer": {
        "id": "1", 
        "name": "Dev iFood", 
        "taxPayerIdentificationNumber": "10117908584", 
        "phone": "19 - 999998888", 
        "email": "DEV.TESTE@IFOOD.COM.BR", 
        "ordersCountOnRestaurant": 3
    }, 
    "items": [
        {
            "name": "CAFÉ EXPRESSO", 
            "quantity": 3, 
            "price": 10, 
            "subItemsPrice": 0, 
            "totalPrice": 10, 
            "discount": 0, 
            "addition": 0, 
            "subItems": [
                {
                    "name": "BISCOITO DE POLVILHO", 
                    "quantity": 2, 
                    "price": 0, 
                    "totalPrice": 0, 
                    "discount": 0, 
                    "addition": 0
                }
            ]
        }
    ], 
    "subTotal": 30, 
    "totalPrice": 45, 
    "deliveryFee": 15, 
    "deliveryAddress": {
        "formattedAddress": "R TESTE, 33", 
        "country": "BR", 
        "state": "AC", 
        "city": "BUJARI", 
        "coordinates": {
            "latitude": -9.824966, 
            "longitude": -67.950095
        }, 
        "neighborhood": "OUTROS", 
        "streetName": "R TESTE", 
        "streetNumber": "33", 
        "postalCode": "12345678", 
        "reference": "Perto dos correios", 
        "complement": "Apt 32"
    }, 
    "deliveryDateTime": "2019-03-21T13:45:13.501Z", 
    "preparationStartDateTime": "2019-03-21T13:25:13.501Z", 
    "localizer": {
        "id": "79226640"
    }, 
    "preparationTimeInSeconds": 2099, 
    "isTest": true, 
    "benefits": [
        {
            "type": "ITEM_TAG", 
            "value": {
                "currency": "BRL", 
                "value": "1602"
            }, 
            "sponsorshipValues": {
                "PARTNER": {
                    "currency": "BRL", 
                    "value": "202"
                }, 
                "OWN": {
                    "currency": "BRL", 
                    "value": "1400"
                }
            },
            "target": "ITEM"

        }, 
        {
            "type": "USER_TAG", 
            "value": {
                "currency": "BRL", 
                "value": "1500"
            }, 
            "sponsorshipValues": {
                "OWN": {
                    "currency": "BRL", 
                    "value": "1500"
                }
            }
            "target": "DELIVERY_FEE"
        }
    ]
}

Endpoints v2.0 (Novo modelo)


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.