Buscar na documentação

Módulos

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Soluções

Endpoints

Referência rápida dos endpoints do módulo Shipping, organizados por operação.

Verificar disponibilidade

Valide cobertura, obtenha cotação e prazos estimados.

Para pedidos feitos na plataforma iFood

GET /shipping/v1.0/orders/{orderId}/deliveryAvailabilities

Parâmetros:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`orderId`	path	uuid	Sim	ID do pedido existente na plataforma

Exemplo de requisição:

curl -X GET "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/deliveryAvailabilities" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Resposta 200 OK:

{
  "id": "57cd1046-2e06-446f-a2dd-18a518212c3c",
  "expirationAt": "2023-08-18T19:49:06Z",
  "createdAt": "2023-08-17T19:49:06Z",
  "distance": 3000,
  "quote": {
    "grossValue": 7.99,
    "discount": 0,
    "netValue": 7.99
  },
  "deliveryTime": {
    "min": 1200,
    "max": 1800
  },
  "hasPaymentMethods": true,
  "paymentMethods": [
    {
      "id": "21c65a8c-f29e-463f-b0bd-240edeb593c4",
      "brand": "Visa",
      "liability": "IFOOD",
      "paymentType": "OFFLINE",
      "method": "CREDIT"
    }
  ]
}

Para pedidos feitos fora da plataforma iFood

GET /shipping/v1.0/merchants/{merchantId}/deliveryAvailabilities

Parâmetros:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`merchantId`	path	uuid	Sim	ID do merchant (sua loja)
`latitude`	query	float	Sim	Latitude do endereço (ex: -23.55)
`longitude`	query	float	Sim	Longitude do endereço (ex: -46.63)

Exemplo de requisição:

curl -X GET "https://merchant-api.ifood.com.br/shipping/v1.0/merchants/{merchantId}/deliveryAvailabilities?latitude=-23.5505&longitude=-46.6333" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Resposta 200 OK:

{
  "id": "57cd1046-2e06-446f-a2dd-18a518212c3c",
  "expirationAt": "2023-08-18T19:49:06Z",
  "createdAt": "2023-08-17T19:49:06Z",
  "distance": 3000,
  "preparationTime": 60,
  "quote": {
    "grossValue": 7.99,
    "discount": 0,
    "raise": 0,
    "netValue": 7.99
  },
  "deliveryTime": {
    "min": 1200,
    "max": 1800
  },
  "hasPaymentMethods": true,
  "paymentMethods": [
    {
      "id": "21c65a8c-f29e-463f-b0bd-240edeb593c4",
      "brand": "Visa",
      "liability": "IFOOD",
      "paymentType": "OFFLINE",
      "method": "CREDIT"
    }
  ]
}

Solicitar/Criar entrega

Solicitar entregador para pedido na plataforma

POST /shipping/v1.0/orders/{orderId}/requestDriver

Parâmetros:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`orderId`	path	uuid	Sim	ID do pedido
`quoteId`	body	uuid	Sim	ID da cotação obtida

Exemplo de requisição:

curl -X POST "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/requestDriver" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "quoteId": "57cd1046-2e06-446f-a2dd-18a518212c3c"
  }'

Resposta 202 Accepted:Requisição registrada. Monitore eventos para resultado.

Registrar pedido para entrega fora da plataforma

POST /shipping/v1.0/merchants/{merchantId}/orders

Parâmetro:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`merchantId`	path	uuid	Sim	ID do seu merchant

Exemplo de requisição:

curl -X POST "https://merchant-api.ifood.com.br/shipping/v1.0/merchants/{merchantId}/orders" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "customer": {
      "name": "João Silva",
      "phone": {
        "countryCode": "55",
        "areaCode": "11",
        "number": "999999999",
        "type": "CUSTOMER"
      }
    },
    "delivery": {
      "merchantFee": 5.99,
      "quoteId": "57cd1046-2e06-446f-a2dd-18a518212c3c",
      "deliveryAddress": {
        "postalCode": "01310100",
        "streetNumber": "100",
        "streetName": "Avenida Paulista",
        "neighborhood": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "coordinates": {
          "latitude": -23.5505,
          "longitude": -46.6333
        }
      }
    },
    "items": [{
      "id": "item-1",
      "name": "Hambúrguer",
      "quantity": 1,
      "unitPrice": 25.00,
      "price": 25.00,
      "optionsPrice": 0,
      "totalPrice": 25.00
    }],
    "payments": {
      "methods": [{
        "method": "CREDIT",
        "type": "OFFLINE",
        "value": 30.99,
        "card": {
          "brand": "Visa"
        }
      }]
    }
  }'

Resposta 202 Accepted:

{
  "id": "522e4d7e-0ce1-44f3-8cc7-73a9f190a5e8",
  "trackingUrl": "https://meupedido.ifood.com.br/522e4d7e-0ce1-44f3-8cc7-73a9f190a5e8"
}

Cancelar entrega

Cancelar solicitação de entregador (pedido na plataforma)

POST /shipping/v1.0/orders/{orderId}/cancelRequestDriver

Parâmetro:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`orderId`	path	uuid	Sim	ID do pedido

Exemplo de requisição:

curl -X POST "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/cancelRequestDriver" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Resposta 202 Accepted:Cancelamento registrado. Monitore eventos para confirmação.

Obter códigos de cancelamento (pedido fora da plataforma)

GET /shipping/v1.0/orders/{orderId}/cancellationReasons

Parâmetro:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`orderId`	path	uuid	Sim	ID do pedido

Exemplo de requisição:

curl -X GET "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/cancellationReasons" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Resposta 200 OK:

[
  {
    "cancelCodeId": "817",
    "description": "O cliente cancelou o pedido"
  },
  {
    "cancelCodeId": "818",
    "description": "Impossível preparar o pedido"
  }
]

Cancelar pedido (pedido fora da plataforma)

POST /shipping/v1.0/orders/{orderId}/cancel

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
`reason`	string	Sim	Texto explicativo
`cancellationCode`	integer	Sim	Código obtido em "Obter códigos de cancelamento"

Exemplo de requisição:

curl -X POST "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/cancel" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Cliente solicitou cancelamento via chat",
    "cancellationCode": 817
  }'

Resposta 202 Accepted:Cancelamento registrado.

Gerenciar endereços (pedidos fora da plataforma)

Confirmar endereço original

POST /shipping/v1.0/orders/{orderId}/userConfirmAddress

Parâmetro:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`orderId`	path	uuid	Sim	ID do pedido

Exemplo de requisição:

curl -X POST "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/userConfirmAddress" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Resposta 202 Accepted:Confirmação registrada.

Solicitar alteração de endereço

POST /shipping/v1.0/orders/{orderId}/deliveryAddressChangeRequest

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
`streetNumber`	string	Não	Número
`streetName`	string	Sim	Logradouro
`complement`	string	Não	Complemento
`neighborhood`	string	Sim	Bairro
`city`	string	Sim	Cidade
`state`	string	Sim	Estado (2 letras)
`country`	string	Sim	País (2 letras)
`reference`	string	Não	Referência
`coordinates.latitude`	float	Sim	Latitude
`coordinates.longitude`	float	Sim	Longitude

Exemplo de requisição:

curl -X POST "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/deliveryAddressChangeRequest" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "streetNumber": "200",
    "streetName": "Rua das Flores",
    "complement": "Apto 42",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "reference": "Perto da estação",
    "coordinates": {
      "latitude": -23.5510,
      "longitude": -46.6340
    }
  }'

Resposta 202 Accepted:Solicitação registrada.

Aceitar alteração de endereço

POST /shipping/v1.0/orders/{orderId}/acceptDeliveryAddressChange

Parâmetro:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`orderId`	path	uuid	Sim	ID do pedido

Exemplo de requisição:

curl -X POST "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/acceptDeliveryAddressChange" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Resposta 200 OK:Alteração aceita.

Rejeitar alteração de endereço

POST /shipping/v1.0/orders/{orderId}/denyDeliveryAddressChange

Parâmetro:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`orderId`	path	uuid	Sim	ID do pedido

Exemplo de requisição:

curl -X POST "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/denyDeliveryAddressChange" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Resposta 202 Accepted:Rejeição registrada.

Rastreamento de entrega

Obter localização em tempo real

GET /shipping/v1.0/orders/{orderId}/tracking

Parâmetro:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`orderId`	path	uuid	Sim	ID do pedido

Exemplo de requisição:

curl -X GET "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/tracking" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Resposta 200 OK:

{
  "latitude": -23.5505,
  "longitude": -46.6333,
  "expectedDelivery": "2023-08-17T20:30:00Z",
  "pickupEtaStart": -300,
  "deliveryEtaEnd": 900,
  "trackDate": "2023-08-17T20:10:00Z"
}

Nível de confiança da entrega

Obter Safe Delivery Score

GET /shipping/v1.0/orders/{orderId}/safeDelivery

Parâmetro:

Parâmetro	Localização	Tipo	Obrigatório	Descrição
`orderId`	path	uuid	Sim	ID do pedido

Exemplo de requisição:

curl -X GET "https://merchant-api.ifood.com.br/shipping/v1.0/orders/{orderId}/safeDelivery" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Resposta 200 OK:

{
  "rules": {
    "customer_address_change_requested": false,
    "customer_address_confirmed": true,
    "customer_phone_is_fixed": false,
    "customer_phone_valid": true,
    "merchant_address_change_approved": false,
    "merchant_address_change_denied": false
  },
  "score": "VERY_HIGH"
}

Resumo por tipo de integração

Se você implementa Pedidos feitos na plataforma iFood

Endpoints essenciais:

GET /orders/{orderId}/deliveryAvailabilities - Verificar disponibilidade
POST /orders/{orderId}/requestDriver - Solicitar entregador
POST /orders/{orderId}/cancelRequestDriver - Cancelar (opcional)
GET /orders/{orderId}/tracking - Rastrear (opcional)

Se você implementa Pedidos feitos fora da plataforma iFood

Endpoints essenciais:

GET /merchants/{merchantId}/deliveryAvailabilities - Verificar disponibilidade
POST /merchants/{merchantId}/orders - Registrar pedido
GET /orders/{orderId}/cancellationReasons - Obter motivos
POST /orders/{orderId}/cancel - Cancelar
POST /orders/{orderId}/userConfirmAddress - Confirmar endereço
POST /orders/{orderId}/deliveryAddressChangeRequest - Solicitar mudança
POST /orders/{orderId}/acceptDeliveryAddressChange - Aceitar mudança
POST /orders/{orderId}/denyDeliveryAddressChange - Rejeitar mudança
GET /orders/{orderId}/tracking - Rastrear
GET /orders/{orderId}/safeDelivery - Verificar confiança