Skip to main content
POST
Criar entrega programada

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Body

application/json
forma_pagamento
string

As formas de pagamento possíveis são: Dinheiro (D), Débito (B), Crédito (C), Pix (X), Picpay (P), Whatsapp (H), Faturado (F), Carteira de créditos (R)

partida
object
paradas
object[]

Lista de paradas da entrega. Limite máximo de 1000 itens.

Maximum array length: 1000
data
string

Data da entrega programada. Formato YYYY-MM-DD

hora
string

Hora da entrega programada. Formato HH:MM:SS

info_antes_aceite
string

Informação exibida ao condutor antes do aceite da entrega. Textos com mais de 70 caracteres são truncados.

exigir_codigo_confirmacao
boolean

Torna obrigatória a inserção do código de confirmação pelo condutor nesta solicitação, independente das configurações do cadastro da empresa (ou da central) — vale tanto sobre "Tornar os códigos de confirmação de entrega obrigatórios" quanto sobre "Solicitar código de confirmação de entrega dos pedidos". Envie true para exigir; omitir o campo ou enviar false mantém o que está configurado — o parâmetro nunca dispensa uma exigência já configurada. Ao enviar true, o codigo_confirmacao passa a ser obrigatório em todas as paradas: sem ele o condutor não teria o que informar para concluir a entrega, e a solicitação é recusada com 400 CODIGO_CONFIRMACAO_OBRIGATORIO (código 136). Pedidos do iFood continuam exigindo o código, por ser regra da própria integração. Uma vez criada com true, a exigência não é removível: não há ação de operador que a dispense (o "prosseguir sem código" da plataforma atende os pedidos do iFood e os abertos com url_confirmacao) e a edição da entrega não altera o parâmetro. O código fica visível no painel da empresa, no link de acompanhamento do cliente e em GET /entregas/{id}/links-rastreio; se for preciso concluir sem ele, resta cancelar a entrega. Em entregas programadas, o valor informado é aplicado à solicitação gerada no momento do disparo.

Response

200 - application/json

Sucesso