VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Entrega agendada

Janelas de horário por método de envio e os agendamentos que os clientes fazem nelas, para quem entrega em dia e hora marcados.

Em mercado, farmácia, flores e entrega local, o cliente quer escolher quando recebe: "terça-feira entre 14h e 18h". A entrega agendada permite isso. A loja cadastra janelas (slots): para um método de envio, num dia da semana, um horário de início e fim e uma capacidade máxima de pedidos por data. No checkout, o cliente escolhe uma data e uma janela com vaga, e a plataforma grava um agendamento ligando o pedido à janela.

Esta seção documenta o lado do administrador: criar e manter janelas, consultar o agendamento de um pedido, listar as entregas marcadas e cancelar um agendamento. A escolha da janela pelo cliente acontece nas rotas da loja virtual e não faz parte desta seção.

Pontos-chave
  • Todas as rotas exigem o privilégio manage_shipping, inclusive as de leitura, e o módulo delivery-scheduling ligado (senão, 403 module_disabled).
  • Uma janela é semanal e recorrente: day_of_week + horário. A data só entra no agendamento.
  • max_orders é a capacidade por data. Cancelar um agendamento libera a vaga.
  • Apagar uma janela é recusado enquanto houver entregas futuras agendadas nela.
  • Os horários são texto HH:MM; a plataforma não confere se o fim é depois do início.
  • Quase todos os erros de validação voltam como 500, com a causa em detail.

Como funciona

Janela cadastrada→Cliente escolhe data e janela→Agendamento (scheduled)→Entregue (delivered) ou Cancelado (cancelled)
status do agendamentoSignificado
scheduledReservado. Conta na capacidade da janela naquela data.
deliveredEntrega concluída.
cancelledCancelado pelo administrador. Libera a vaga.

Um pedido só pode ter um agendamento em scheduled por vez.

Conceitos-chave

Janela, data e capacidade

A janela "segunda, 08:00 às 12:00, 10 pedidos" vale para todas as segundas-feiras. Cada segunda tem 10 vagas próprias: a conta é feita por data. Quando as vagas de uma data acabam, a janela deixa de ser oferecida naquela data.

Estados como letra ou palavra

Na janela, status sai sempre como letra (A, D), mas na escrita você pode enviar a letra ou a palavra (active, disabled). No agendamento, status sai por extenso (scheduled).

Cancelar não cancela o pedido

Cancelar um agendamento só libera a vaga e marca o agendamento. O pedido, o pagamento e o envio não mudam; avise o cliente e combine uma nova data.

Endpoints

Método e caminhoPara quêPágina
GET /api/v1/admin/delivery/slotsLista janelasJanelas
POST /api/v1/admin/delivery/slotsCria uma janelaJanelas
GET/PUT/DELETE /api/v1/admin/delivery/slots/{id}Lê, altera, apagaJanelas
GET /api/v1/admin/delivery/scheduledLista entregas agendadasAgendamentos
GET /api/v1/admin/delivery/schedule/{orderID}Agendamento de um pedidoAgendamentos
POST /api/v1/admin/delivery/schedule/{id}/cancelCancela um agendamentoAgendamentos

Erros comuns

  1. Esquecer que a leitura também exige manage_shipping. Um usuário só com view_shipping recebe 403.
  2. Criar com day_of_week fora de 0 a 6. Volta 500 com a mensagem no detail.
  3. Mandar max_orders: 0 na criação. O valor vira 50. Na alteração, 0 é gravado e a janela deixa de ter vaga.
  4. Apagar uma janela em uso. É recusado (500) enquanto houver entregas futuras agendadas; cancele-as antes.
  5. Filtrar entregas por um status que não existe. A listagem devolve vazio, sem erro.
  6. Achar que o cancelamento avisa o cliente. Não avisa.

Próximos passos

Janelas
Crie e mantenha as janelas semanais.
Agendamentos
Veja e cancele as entregas marcadas.
Janela de entrega
A promessa de data que aparece no produto.
Anterior
Gerenciar transportadoras
Próxima
Janelas de entrega
Nesta página
  • Como funciona
  • Conceitos-chave
  • Janela, data e capacidade
  • Estados como letra ou palavra
  • Cancelar não cancela o pedido
  • Endpoints
  • Erros comuns
  • Próximos passos