Buscar na documentação

Módulos

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Soluções

Merchant

Gerencia lojas (merchants) na plataforma iFood: restaurantes, mercados, farmácias, petshops e outros estabelecimentos.

Consulta de lojas

Listar lojas

Use GET /merchants para listar todas as lojas vinculadas ao token de acesso.Retorna: ID, nome e nome corporativo das lojas.

Detalhes da loja

Use GET /merchants/{id} para obter detalhes de uma loja específica.Retorna: Nome, endereço e operações disponíveis.

Status da loja

Requisitos para receber pedidos

Para aparecer na plataforma, a loja deve:

Estar no horário de funcionamento
Ter catálogo com ao menos um cardápio habilitado
Ter área de entrega configurada
Não ter interrupções ativas
Fazer polling a cada 30 segundos

Verificar disponibilidade

Use a API de Status para verificar se uma loja pode receber pedidos.

Estados possíveis

State	Cor	Descrição	Ação requerida
OK	Verde	Loja online	Nenhuma
WARNING	Amarela	Online com restrições (ex: área reduzida)	Nenhuma
CLOSED	Cinza	Fechada conforme esperado (fora do horário)	Nenhuma
ERROR	Vermelha	Fechada inesperadamente	Verificar

Validações

Validações sempre retornadas:

is-connected: Polling a cada 30 segundos
opening-hours: Dentro do horário de funcionamento

Validações retornadas em ERROR ou WARNING:

Validação	Descrição
unavailabilities	Há interrupção ativa
radius-restriction	Sem entregadores disponíveis na área
payout-blocked	Pendências financeiras
logistics-blocked	Problemas logísticos (festivais, trânsito)
terms-service-violation	Violação dos Termos de Serviço
status-availability	Loja desativada ou em teste

Dúvidas? Abra um chamado no Portal do Parceiro.

Penalidades

Aplicadas quando a loja viola os Termos de Serviço.

Tipos de penalidade

Automáticas: Não permitem reabertura imediata (ex: muitos cancelamentos em pouco tempo). É necessário aguardar o fim da penalidade.Manuais: Podem ser removidas pela loja (ex: interrupções criadas pela própria loja).

Verificar possibilidade de reabertura

O objeto reopenable indica se é possível reabrir:

Campo	Descrição
reopenable	`true` ou `false`
type	Tipo do fechamento (ex: `UNAVAILABILITY`)
identifier	ID para reabertura (quando aplicável)

Exemplo de resposta:

{
  "reopenable": {
    "identifier": "cca57aab-5ac0-4af4-a04d-48261350bebc",
    "type": "UNAVAILABILITY",
    "reopenable": true
  }
}

Quando reopenable: true, use a API de Interrupções para remover a pausa.Quando reopenable: false, consulte o campo message na API de Status para mais detalhes.

Interrupções

Feche temporariamente uma loja para parar de receber pedidos.

Listar interrupções

Use GET /interruptions para listar interrupções ativas e futuras.

Criar interrupção

Use POST /interruptions para criar uma interrupção.Formato de data: ISO 8601Resposta: Objeto com ID, descrição, início e fim no formato ISO 8601 estendido.

Fuso horárioInterrupções seguem o fuso horário da loja. O timezone enviado no payload será descartado.

Processamento da interrupçãoO fechamento pode levar alguns segundos para ser efetivado. Continue fazendo polling por alguns minutos para não perder pedidos realizados neste intervalo.

Remover interrupção

Use DELETE /interruptions/{id} com o ID do merchant e da interrupção.

Horário de funcionamento

Configure horários de funcionamento da loja via API de Opening Hours.

Escopo da APIEsta API gerencia apenas o horário padrão do iFood Marketplace. Para novos negócios ou catálogo digital, use o Portal do Parceiro.

Listar horários

Use GET /opening-hours para consultar horários configurados.

Configurar horários

Use PUT /opening-hours para definir horários.

Fechamentos temporáriosPara ações temporárias, use a API de Interrupções em vez de alterar horários de funcionamento.

Comportamento da alteração em massaEste endpoint substitui todos os horários. Entenda o impacto:

Dias não enviados: Serão removidos (loja fechada nesses dias)
Exemplo: Enviar apenas segunda-feira remove horários de todos os outros dias
Múltiplos horários: Permitidos no mesmo dia, mas não podem se sobrepor
Intervalo válido: 00:00 a 23:59
Janelas até 23:59: Sistema adiciona automaticamente 59 segundos para evitar gap de 1 minuto entre dias

Exemplo de configuração

Visualização no Portal do Parceiro:

Payload correspondente:

{
  "storeId": "09e9a8c8-fda3-4991-acfc-43b15397caf6",
  "shifts": [
    {
      "dayOfWeek": "MONDAY",
      "start": "09:00:00",
      "duration": 360
    },
    {
      "dayOfWeek": "TUESDAY",
      "start": "09:00:00",
      "duration": 360
    },
    {
      "dayOfWeek": "WEDNESDAY",
      "start": "09:00:00",
      "duration": 360
    },
    {
      "dayOfWeek": "THURSDAY",
      "start": "09:00:00",
      "duration": 360
    },
    {
      "dayOfWeek": "FRIDAY",
      "start": "05:00:00",
      "duration": 420
    },
    {
      "dayOfWeek": "FRIDAY",
      "start": "13:00:00",
      "duration": 300
    },
    {
      "dayOfWeek": "FRIDAY",
      "start": "19:00:00",
      "duration": 210
    }
  ]
}

Check-in do entregador

Entregadores fazem check-in via QR code para coletar pedidos.

Gerar QR code

Use POST /merchants/checkin-qrcode para gerar PDF com QR code.Limites:

Máximo: 20 lojas por requisição
Todas as lojas devem estar vinculadas ao token de acesso

Resultado: Arquivo PDF pronto para impressão.

DisponibilidadeFuncionalidade disponível apenas para lojas do tipo Groceries.

Esta página foi útil?

Avalie sua experiência no novo Developer portal: