Skip to content

Documenta exigir_codigo_confirmacao na abertura de entregas #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Joao-Dutra-Gaudium wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Documenta exigir_codigo_confirmacao na abertura de entregas #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1aff62c
docs: documenta exigir_codigo_confirmacao na abertura de entregas
Joao-Dutra-Gaudium Jul 30, 2026
516c59d
docs: restringe exigir_codigo_confirmacao aos endpoints de criação
Joao-Dutra-Gaudium Jul 31, 2026
0072948
docs: adiciona changelog do exigir_codigo_confirmacao
Joao-Dutra-Gaudium Jul 31, 2026
9b9237e
docs: detalha quando o exigir_codigo_confirmacao vale na programada
Joao-Dutra-Gaudium Jul 31, 2026
853ee8d
docs: padroniza rótulo da nota no changelog de entregas
Joao-Dutra-Gaudium Jul 31, 2026
ab2aa79
docs: distingue as duas configurações de código de confirmação
Joao-Dutra-Gaudium Jul 31, 2026
c267e4f
docs: ajusta exigir_codigo_confirmacao para somar exigência
Joao-Dutra-Gaudium Aug 5, 2026
08235c8
docs: ajusta a data do changelog para a subida em produção
Joao-Dutra-Gaudium Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions pages/v2/changelog-entregas.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,46 @@ export const EndpointBadge = ({ method, path, href }) => (
</p>
</div>

<Entry date="13 ago 2026" label="Novo" labelColor="#3b82f6">
<h2 id="exigir-codigo-confirmacao" style={{ fontSize: "22px", fontWeight: "700", marginBottom: "6px", marginTop: 0 }}>
Exigir o código de confirmação de entrega pela API
</h2>
<p style={{ fontSize: "15px", opacity: 0.7, marginBottom: "20px", lineHeight: "1.6" }}>
Agora é possível exigir, por solicitação, que o condutor informe o código de confirmação
para concluir a entrega — mesmo quando o cadastro da empresa não torna o código obrigatório.
</p>

<EndpointBadge method="POST" path="/api/v2/integracao/entregas" href="/pages/v2/entregas/endpoint/post" />
Comment thread
Joao-Dutra-Gaudium marked this conversation as resolved.

<ChangeSection type="added">
<ul style={{ margin: 0, paddingLeft: "20px", display: "flex", flexDirection: "column", gap: "8px" }}>
<li><ParamBadge name="exigir_codigo_confirmacao" /> — opcional. Envie <code>true</code> para tornar o código obrigatório nesta solicitação; omitir o campo ou enviar <code>false</code> mantém o que está configurado no cadastro da empresa (ou da central).</li>
</ul>
</ChangeSection>

<div style={{ marginTop: "24px" }}>
<EndpointBadge method="POST" path="/api/v2/integracao/entregas/programadas" href="/pages/v2/entregas/endpoint/post-programadas" />
Comment thread
Joao-Dutra-Gaudium marked this conversation as resolved.

<ChangeSection type="added">
<ul style={{ margin: 0, paddingLeft: "20px", display: "flex", flexDirection: "column", gap: "8px" }}>
<li><ParamBadge name="exigir_codigo_confirmacao" /> — mesmo comportamento da criação de entrega. Quando <code>true</code>, a exigência é aplicada à solicitação gerada no disparo da programada.</li>
</ul>
</ChangeSection>
</div>

<div style={{
marginTop: "20px",
padding: "14px 18px",
borderRadius: "10px",
background: "rgba(59, 130, 246, 0.08)",
border: "1px solid rgba(59, 130, 246, 0.2)",
fontSize: "13px",
lineHeight: "1.6",
}}>
<strong>Nota:</strong> são duas configurações distintas no cadastro da empresa. O parâmetro soma exigência sobre <em>Tornar os códigos de confirmação de entrega obrigatórios</em> — nunca a remove; a geração do código continua dependendo de <em>Solicitar código de confirmação de entrega dos pedidos</em> — em paradas sem código o parâmetro não tem efeito. Pedidos do iFood continuam exigindo o código independente do valor enviado, por ser regra da própria integração.
</div>
</Entry>

<Entry date="16 jul 2026" label="Novo" labelColor="#3b82f6">
<h2 id="consultar-status-webhook" style={{ fontSize: "22px", fontWeight: "700", marginBottom: "6px", marginTop: 0 }}>
Consulta de status de entrega do webhook
Expand Down
14 changes: 12 additions & 2 deletions pages/v2/openapi-entregas.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3934,7 +3934,8 @@
"codigo_confirmacao": "9999",
"valor_cobrar": 852.37
}
]
],
"exigir_codigo_confirmacao": true
},
"schema": {
"type": "object",
Expand Down Expand Up @@ -4023,6 +4024,10 @@
}
}
}
},
"exigir_codigo_confirmacao": {
Comment thread
Joao-Dutra-Gaudium marked this conversation as resolved.
Comment thread
Joao-Dutra-Gaudium marked this conversation as resolved.
"type": "boolean",
"description": "Torna obrigatória a inserção do código de confirmação pelo condutor nesta solicitação, mesmo que a configuração \"Tornar os códigos de confirmação de entrega obrigatórios\" do cadastro da empresa (ou da central) não exija. 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. O código só é gerado quando \"Solicitar código de confirmação de entrega dos pedidos\" está habilitado — em paradas sem código o parâmetro não tem efeito. Pedidos do iFood continuam exigindo o código, por ser regra da própria integração."
}
}
}
Expand Down Expand Up @@ -5286,7 +5291,8 @@
}
],
"data": "31/12/2026",
"hora": "14:30:00"
"hora": "14:30:00",
Comment thread
Joao-Dutra-Gaudium marked this conversation as resolved.
"exigir_codigo_confirmacao": true
},
"schema": {
"type": "object",
Expand Down Expand Up @@ -5383,6 +5389,10 @@
"hora": {
"type": "string",
"description": "Hora da entrega programada. Formato HH:MM:SS"
},
"exigir_codigo_confirmacao": {
Comment thread
Joao-Dutra-Gaudium marked this conversation as resolved.
Comment thread
Joao-Dutra-Gaudium marked this conversation as resolved.
"type": "boolean",
"description": "Torna obrigatória a inserção do código de confirmação pelo condutor nesta solicitação, mesmo que a configuração \"Tornar os códigos de confirmação de entrega obrigatórios\" do cadastro da empresa (ou da central) não exija. 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. O código só é gerado quando \"Solicitar código de confirmação de entrega dos pedidos\" está habilitado — em paradas sem código o parâmetro não tem efeito. Pedidos do iFood continuam exigindo o código, por ser regra da própria integração. Em entregas programadas, o valor informado é aplicado à solicitação gerada no momento do disparo."
}
}
}
Expand Down