Use este endpoint quando um operador de logística precisar validar o código informado pelo cliente.
Autenticação
Como todos os endpoints de logística, este não usa o Bearer token OAuth. É autenticado por três headers HTTP:
string (uuid)
required
Identificador da sua aplicação de logística (UUID v4).
string
required
UUID do merchant na plataforma Onbeef (entre 36 e 100 caracteres).
string
required
Assinatura HMAC-SHA256 (hex, 64 caracteres) do corpo cru da requisição. A chave é o client_secret fornecido no provisionamento da sua integração de logística. Não use o client_secret OAuth do merchant: são credenciais diferentes.
Corpo da requisição
O corpo da requisição deve ser enviado como application/json.
string (uuid)
required
Identificador do pedido gerado pela Onbeef, fornecido quando a entrega foi solicitada.
string
required
Código de confirmação informado pelo cliente na porta. Envie-o exatamente como o cliente apresenta.
Resposta
200: Código confirmado
O código está correto. A entrega pode prosseguir. O corpo da resposta ecoa orderId e deliveryCode.
string (uuid)
Identificador do pedido validado.
string
Código de confirmação validado com sucesso.
400: Código inválido
O código não corresponde ao esperado para este pedido. Corpo: { "title": "Invalid code provided", "status": 400 }. Não marque o pedido como entregue.
401: Não autorizado
Os headers X-App-* não foram reconhecidos, a integração não está ativa, ou a assinatura não confere.
404: Não encontrado
Nenhum pedido foi encontrado com o orderId informado para este merchant. Corpo: { "title": "Order not found", "status": 404 }.
429: Limite de requisições
A rota aceita até 120 requisições por minuto por endereço IP, num limite compartilhado com POST /v1/logistics/deliveryUpdate. Acima disso, a API responde { "title": "Too Many Requests", "status": 429 }. Veja Limite de requisições.
Este endpoint é a entrada do lado da logística para a verificação do código, autenticada por headers X-App-*.Do lado do merchant/PDV, o endpoint equivalente POST /v1/orders/{orderId}/validateCode tem o mesmo propósito, mas é autenticado com um Bearer token de merchant. Ambos verificam o mesmo código: a diferença é qual parte está fazendo a checagem e quais credenciais são usadas.
Uma resposta 400 significa que o código não bateu. Não entregue o pedido até receber uma resposta 200. Se as tentativas repetidas falharem, escale pelo canal de suporte: não pule a validação.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Onbeef Connect API","description":"API REST da Onbeef para integrar sistemas PDV de açougues e casas de carne: sincronização de catálogo, processamento de pedidos e operação de entregas, no padrão OpenDelivery.","colors":{"primary":"#C8102E","light":"#FF3B5C","dark":"#FF3B5C"},"logo":{"light":"https://www.onbeef.app.br/logo.png","dark":"https://www.onbeef.app.br/logo.png"},"favicon":"https://mintcdn.com/onbeef/oZWOfY3NZyzFPDI2/favicon.png?fit=max\u0026auto=format\u0026n=oZWOfY3NZyzFPDI2\u0026q=85\u0026s=115ee42f327cf7166ce8e4073cf2e3b0","api":{"playground":{"display":"simple"},"examples":{"defaults":"required","languages":["curl"],"autogenerate":true},"mdx":{"auth":{"method":"bearer"},"server":["https://api.dev.connect.onbeefapp.com.br","https://api.connect.onbeefapp.com.br"]}},"appearance":{"default":"dark"},"navbar":{"primary":{"type":"button","label":"Conheça a Onbeef","href":"https://www.onbeef.app.br"}},"footer":{"socials":{"website":"https://onbeefapp.com.br"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"onbeef","hasAudioNarration":false,"actualSubdomain":"onbeef","customDomains":["docs.onbeef.app"],"gitSource":{"type":"github","owner":"onbeefapp","repo":"api-connect-mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a8c44c3af46649bd4108aad","clientVersion":"0.0.4149","searchFilterCounts":[{"language":"default","tag":"Referência","count":21},{"language":"default","tag":"Pedidos","count":20},{"language":"default","tag":"Logística","count":6},{"language":"default","tag":"Comece aqui","count":5},{"language":"default","tag":"Merchant","count":4},{"language":"default","tag":"Catálogo","count":4},{"language":"default","tag":"Primeiros passos","count":3},{"language":"default","tag":"Visão geral","count":2},{"language":"default","tag":"Ambientes","count":2},{"language":"default","tag":"Autenticação","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/logistics/delivery-confirmation-code","slug":"/api-reference/logistics/delivery-confirmation-code","pageMetadata":{"title":"Confirme o código de entrega","sidebarTitle":"Confirmar código","description":"Valide o código de uma entrega.","api":"POST /v1/logistics/confirmationCode","authMethod":"none","href":"/api-reference/logistics/delivery-confirmation-code"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Valide o código de uma entrega.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,ParamField,ResponseField,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use este endpoint quando um operador de logística precisar validar o código informado pelo cliente.`}),`\n`,_jsx(Heading,{level:`2`,id:`autenticação`,children:`Autenticação`}),`\n`,_jsxs(_components.p,{children:[`Como todos os endpoints de logística, este `,_jsx(_components.strong,{children:`não`}),` usa o Bearer token OAuth. É autenticado por três headers HTTP:`]}),`\n`,_jsx(ParamField,{header:`X-App-Id`,type:`string (uuid)`,required:true,id:`param-x-app-id`,children:_jsx(_components.p,{children:`Identificador da sua aplicação de logística (UUID v4).`})}),`\n`,_jsx(ParamField,{header:`X-App-MerchantId`,type:`string`,required:true,id:`param-x-app-merchant-id`,children:_jsx(_components.p,{children:`UUID do merchant na plataforma Onbeef (entre 36 e 100 caracteres).`})}),`\n`,_jsx(ParamField,{header:`X-App-Signature`,type:`string`,required:true,id:`param-x-app-signature`,children:_jsxs(_components.p,{children:[`Assinatura HMAC-SHA256 (hex, 64 caracteres) do corpo cru da requisição. A chave é o `,_jsx(_components.code,{children:`client_secret`}),` fornecido no provisionamento da sua integração de logística. Não use o `,_jsx(_components.code,{children:`client_secret`}),` OAuth do merchant: são credenciais diferentes.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`corpo-da-requisição`,children:`Corpo da requisição`}),`\n`,_jsxs(_components.p,{children:[`O corpo da requisição deve ser enviado como `,_jsx(_components.code,{children:`application/json`}),`.`]}),`\n`,_jsx(ParamField,{body:`orderId`,type:`string (uuid)`,required:true,id:`param-order-id`,children:_jsx(_components.p,{children:`Identificador do pedido gerado pela Onbeef, fornecido quando a entrega foi solicitada.`})}),`\n`,_jsx(ParamField,{body:`deliveryCode`,type:`string`,required:true,id:`param-delivery-code`,children:_jsx(_components.p,{children:`Código de confirmação informado pelo cliente na porta. Envie-o exatamente como o cliente apresenta.`})}),`\n`,_jsx(Heading,{level:`2`,id:`resposta`,children:`Resposta`}),`\n`,_jsx(Heading,{level:`3`,id:`200-código-confirmado`,children:`200: Código confirmado`}),`\n`,_jsxs(_components.p,{children:[`O código está correto. A entrega pode prosseguir. O corpo da resposta ecoa `,_jsx(_components.code,{children:`orderId`}),` e `,_jsx(_components.code,{children:`deliveryCode`}),`.`]}),`\n`,_jsx(ResponseField,{name:`orderId`,type:`string (uuid)`,id:`param-order-id-1`,children:_jsx(_components.p,{children:`Identificador do pedido validado.`})}),`\n`,_jsx(ResponseField,{name:`deliveryCode`,type:`string`,id:`param-delivery-code-1`,children:_jsx(_components.p,{children:`Código de confirmação validado com sucesso.`})}),`\n`,_jsx(Heading,{level:`3`,id:`400-código-inválido`,children:`400: Código inválido`}),`\n`,_jsxs(_components.p,{children:[`O código não corresponde ao esperado para este pedido. Corpo: `,_jsx(_components.code,{children:`{ \"title\": \"Invalid code provided\", \"status\": 400 }`}),`. Não marque o pedido como entregue.`]}),`\n`,_jsx(Heading,{level:`3`,id:`401-não-autorizado`,children:`401: Não autorizado`}),`\n`,_jsxs(_components.p,{children:[`Os headers `,_jsx(_components.code,{children:`X-App-*`}),` não foram reconhecidos, a integração não está ativa, ou a assinatura não confere.`]}),`\n`,_jsx(Heading,{level:`3`,id:`404-não-encontrado`,children:`404: Não encontrado`}),`\n`,_jsxs(_components.p,{children:[`Nenhum pedido foi encontrado com o `,_jsx(_components.code,{children:`orderId`}),` informado para este merchant. Corpo: `,_jsx(_components.code,{children:`{ \"title\": \"Order not found\", \"status\": 404 }`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`429-limite-de-requisições`,children:`429: Limite de requisições`}),`\n`,_jsxs(_components.p,{children:[`A rota aceita até 120 requisições por minuto por endereço IP, num limite compartilhado com `,_jsx(_components.code,{children:`POST /v1/logistics/deliveryUpdate`}),`. Acima disso, a API responde `,_jsx(_components.code,{children:`{ \"title\": \"Too Many Requests\", \"status\": 429 }`}),`. Veja `,_jsx(_components.a,{href:`/api-reference/errors#limite-de-requisi%C3%A7%C3%B5es`,children:`Limite de requisições`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`exemplo-de-requisição`,children:`Exemplo de requisição`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`10`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`10`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.dev.connect.onbeefapp.com.br/v1/logistics/confirmationCode\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-App-Id: \u003capp_uuid>\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-App-MerchantId: \u003cmerchant_id>\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-App-Signature: \u003chmac_sha256_do_corpo>\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"orderId\": \"b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"deliveryCode\": \"8X4K2\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`exemplo-de-resposta`,children:`Exemplo de resposta`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"orderId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"deliveryCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"8X4K2\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`relação-com-a-validação-de-pedido`,children:`Relação com a validação de pedido`}),`\n`,_jsxs(_components.p,{children:[`Este endpoint é a entrada do lado da `,_jsx(_components.strong,{children:`logística`}),` para a verificação do código, autenticada por headers `,_jsx(_components.code,{children:`X-App-*`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Do `,_jsx(_components.strong,{children:`lado do merchant/PDV`}),`, o endpoint equivalente `,_jsx(_components.a,{href:`/api-reference/orders/validate-delivery-code`,children:_jsx(_components.code,{children:`POST /v1/orders/{orderId}/validateCode`})}),` tem o mesmo propósito, mas é autenticado com um Bearer token de merchant. Ambos verificam o mesmo código: a diferença é qual parte está fazendo a checagem e quais credenciais são usadas.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Uma resposta `,_jsx(_components.code,{children:`400`}),` significa que o código não bateu. `,_jsx(_components.strong,{children:`Não entregue o pedido`}),` até receber uma resposta `,_jsx(_components.code,{children:`200`}),`. Se as tentativas repetidas falharem, escale pelo canal de suporte: não pule a validação.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Confirme o código de entrega","sidebarTitle":"Confirmar código","description":"Valide o código de uma entrega.","api":"POST /v1/logistics/confirmationCode","authMethod":"none","href":"/api-reference/logistics/delivery-confirmation-code"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Autenticação","slug":"autenticação","depth":2,"children":[]},{"title":"Corpo da requisição","slug":"corpo-da-requisição","depth":2,"children":[]},{"title":"Resposta","slug":"resposta","depth":2,"children":[{"title":"200: Código confirmado","slug":"200-código-confirmado","depth":3,"children":[]},{"title":"400: Código inválido","slug":"400-código-inválido","depth":3,"children":[]},{"title":"401: Não autorizado","slug":"401-não-autorizado","depth":3,"children":[]},{"title":"404: Não encontrado","slug":"404-não-encontrado","depth":3,"children":[]},{"title":"429: Limite de requisições","slug":"429-limite-de-requisições","depth":3,"children":[]}]},{"title":"Exemplo de requisição","slug":"exemplo-de-requisição","depth":2,"children":[]},{"title":"Exemplo de resposta","slug":"exemplo-de-resposta","depth":2,"children":[]},{"title":"Relação com a validação de pedido","slug":"relação-com-a-validação-de-pedido","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Confirme o código de entrega","path":"/v1/logistics/confirmationCode","servers":[{"url":"https://api.dev.connect.onbeefapp.com.br"},{"url":"https://api.connect.onbeefapp.com.br"}],"method":"post","request":{"security":[],"parameters":{"query":{},"header":{"X-App-Id":{"schema":[{"type":"object","properties":{},"description":"Identificador da sua aplicação de logística (UUID v4).","required":true}]},"X-App-MerchantId":{"schema":[{"type":"string","description":"UUID do merchant na plataforma Onbeef (entre 36 e 100 caracteres).","required":true}]},"X-App-Signature":{"schema":[{"type":"string","description":"Assinatura HMAC-SHA256 (hex, 64 caracteres) do corpo cru da requisição. A chave é o `client_secret` fornecido no provisionamento da sua integração de logística. Não use o `client_secret` OAuth do merchant: são credenciais diferentes.","required":true}]}},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"orderId":[{"type":"object","properties":{},"description":"Identificador do pedido gerado pela Onbeef, fornecido quando a entrega foi solicitada.","required":true}],"deliveryCode":[{"type":"string","description":"Código de confirmação informado pelo cliente na porta. Envie-o exatamente como o cliente apresenta.","required":true}]}}],"examples":{"example":{"value":{"orderId":{},"deliveryCode":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"orderId":[{"type":"object","properties":{},"description":"Identificador do pedido validado."}],"deliveryCode":[{"type":"string","description":"Código de confirmação validado com sucesso."}]}}],"examples":{"example":{"value":{"orderId":{},"deliveryCode":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"onbeef","siteName":"Onbeef Connect API","title":"Confirme o código de entrega - Onbeef Connect API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-10T17:48:37.836Z","originalFileLocation":"api-reference/logistics/delivery-confirmation-code.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Valide o código de uma entrega.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Onbeef Connect API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onbeef/WscjZRN3uA8giNWJ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/onbeef/WscjZRN3uA8giNWJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onbeef/WscjZRN3uA8giNWJ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/onbeef/WscjZRN3uA8giNWJ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/onbeef/WscjZRN3uA8giNWJ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onbeef/WscjZRN3uA8giNWJ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onbeef/WscjZRN3uA8giNWJ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/onbeef/WscjZRN3uA8giNWJ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/onbeef/WscjZRN3uA8giNWJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Confirme o código de entrega - Onbeef Connect API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Valide o código de uma entrega.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Onbeef Connect API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.onbeef.app/api-reference/logistics/delivery-confirmation-code\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://onbeef.mintlify.site/_mintlify/api/og/v2?division=Log%C3%ADstica\u0026amp;title=Confirme+o+c%C3%B3digo+de+entrega\u0026amp;description=Valide+o+c%C3%B3digo+de+uma+entrega.\u0026amp;theme=951f97d33c896d10e9698c59\u0026amp;signature=c0059e64d0e1a5def9426219cfb0b8743fc805c820103c6c1b20e7f5821e5304\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Confirme o código de entrega - Onbeef Connect API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Valide o código de uma entrega.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://onbeef.mintlify.site/_mintlify/api/og/v2?division=Log%C3%ADstica\u0026amp;title=Confirme+o+c%C3%B3digo+de+entrega\u0026amp;description=Valide+o+c%C3%B3digo+de+uma+entrega.\u0026amp;theme=951f97d33c896d10e9698c59\u0026amp;signature=c0059e64d0e1a5def9426219cfb0b8743fc805c820103c6c1b20e7f5821e5304\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/onbeef/WscjZRN3uA8giNWJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Onbeef Connect API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#C8102E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.onbeef.app/api-reference/logistics/delivery-confirmation-code\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/logistics/delivery-confirmation-code.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.onbeef.app/#organization\",\"name\":\"Onbeef Connect API\",\"url\":\"https://docs.onbeef.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://www.onbeef.app.br/logo.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.onbeef.app#website\",\"name\":\"Onbeef Connect API\",\"url\":\"https://docs.onbeef.app\",\"publisher\":{\"@id\":\"https://docs.onbeef.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.onbeef.app/api-reference/logistics/delivery-confirmation-code#webpage\",\"url\":\"https://docs.onbeef.app/api-reference/logistics/delivery-confirmation-code\",\"name\":\"Confirme o código de entrega\",\"description\":\"Valide o código de uma entrega.\",\"dateModified\":\"2026-08-10T17:48:37.836Z\",\"isPartOf\":{\"@id\":\"https://docs.onbeef.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.onbeef.app/api-reference/logistics/delivery-confirmation-code#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.onbeef.app/api-reference/logistics/delivery-confirmation-code#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Logística\",\"item\":\"https://docs.onbeef.app/api-reference/logistics/order-event-notification\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Confirme o código de entrega\",\"item\":\"https://docs.onbeef.app/api-reference/logistics/delivery-confirmation-code\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.onbeef.app/api-reference/logistics/delivery-confirmation-code#apireference\",\"headline\":\"Confirme o código de entrega\",\"name\":\"Confirme o código de entrega\",\"description\":\"Valide o código de uma entrega.\",\"url\":\"https://docs.onbeef.app/api-reference/logistics/delivery-confirmation-code\",\"mainEntityOfPage\":{\"@id\":\"https://docs.onbeef.app/api-reference/logistics/delivery-confirmation-code#webpage\"},\"dateModified\":\"2026-08-10T17:48:37.836Z\",\"publisher\":{\"@id\":\"https://docs.onbeef.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.onbeef.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Onbeef Connect API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Onbeef Connect API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/logistics/delivery-confirmation-code.md","siteName":"Onbeef Connect API","nav":{"global":null,"tabs":[{"tab":"Comece aqui","pages":[{"title":"Comece aqui","href":""}]},{"tab":"Catálogo","pages":[{"title":"Catálogo","href":"/concepts/merchant"}]},{"tab":"Pedidos","pages":[{"title":"Pedidos","href":"/concepts/orders"}]},{"tab":"Logística","pages":[{"title":"Logística","href":"/concepts/logistics"}]},{"tab":"Referência","groups":[{"group":"Visão geral","pages":[{"title":"Referência da API","sidebarTitle":"Visão geral","href":"/api-reference/overview"},{"title":"Trate erros da API","sidebarTitle":"Erros","href":"/api-reference/errors"}]},{"group":"Autenticação","pages":[{"title":"Obtenha um token de acesso","sidebarTitle":"Obter token de acesso","api":"POST /oauth/token","href":"/api-reference/auth/token"}]},{"group":"Merchant","pages":[{"title":"Consulte o merchant","sidebarTitle":"Obter merchant","api":"GET /v1/merchant","href":"/api-reference/merchant/get-merchant"},{"title":"Consulte a sincronização","sidebarTitle":"Status da sincronização","api":"GET /v1/merchantStatus","href":"/api-reference/merchant/get-status"},{"title":"Configure o webhook de pedidos","sidebarTitle":"Configurar webhook","api":"PUT /v1/merchantOnboarding","href":"/api-reference/merchant/update-merchant"},{"title":"Sincronize o catálogo","sidebarTitle":"Sincronizar catálogo","api":"PUT /v1/merchantUpdate","href":"/api-reference/merchant/sync-catalog"}]},{"group":"Pedidos","pages":[{"title":"Consulte eventos","sidebarTitle":"Consultar eventos","api":"GET /v1/events:polling","href":"/api-reference/orders/get-events"},{"title":"Confirme eventos","sidebarTitle":"Confirmar eventos","api":"POST /v1/events/acknowledgment","href":"/api-reference/orders/confirm-events"},{"title":"Consulte um pedido","sidebarTitle":"Consultar pedido","api":"GET /v1/orders/{orderId}","href":"/api-reference/orders/get-order"},{"title":"Confirme um pedido","sidebarTitle":"Confirmar pedido","api":"POST /v1/orders/{orderId}/confirm","href":"/api-reference/orders/confirm"},{"title":"Marque o pedido como pronto","sidebarTitle":"Pronto para retirada","api":"POST /v1/orders/{orderId}/readyForPickup","href":"/api-reference/orders/ready-for-pickup"},{"title":"Despache um pedido","sidebarTitle":"Despachar pedido","api":"POST /v1/orders/{orderId}/dispatch","href":"/api-reference/orders/dispatch"},{"title":"Conclua um pedido","sidebarTitle":"Marcar como entregue","api":"POST /v1/orders/{orderId}/delivered","href":"/api-reference/orders/delivered"},{"title":"Valide o código de entrega","sidebarTitle":"Validar código de entrega","api":"POST /v1/orders/{orderId}/validateCode","href":"/api-reference/orders/validate-delivery-code"},{"title":"Cancele um pedido","sidebarTitle":"Cancelar pedido","api":"POST /v1/orders/{orderId}/requestCancellation","href":"/api-reference/orders/request-cancellation"},{"title":"Aceite um cancelamento","sidebarTitle":"Aceitar cancelamento","api":"POST /v1/orders/{orderId}/acceptCancellation","href":"/api-reference/orders/accept-cancellation"},{"title":"Negue um cancelamento","sidebarTitle":"Negar cancelamento","api":"POST /v1/orders/{orderId}/denyCancellation","href":"/api-reference/orders/deny-cancellation"},{"title":"Atualize o rastreamento","sidebarTitle":"Atualizar rastreamento","api":"POST /v1/orders/{orderId}/tracking","href":"/api-reference/orders/delivery-updates"}]},{"group":"Logística","pages":[{"title":"Envie um evento de entrega","sidebarTitle":"Enviar evento","description":"Atualize o estado de uma entrega.","api":"POST /v1/logistics/deliveryUpdate","href":"/api-reference/logistics/order-event-notification"},{"title":"Confirme o código de entrega","sidebarTitle":"Confirmar código","api":"POST /v1/logistics/confirmationCode","href":"/api-reference/logistics/delivery-confirmation-code"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Confirme o código de entrega - Onbeef Connect API","buildId":"dpl_4D8r1dHg6bQcRuBgQyL3z9waJJtn","deploymentId":"dpl_4D8r1dHg6bQcRuBgQyL3z9waJJtn","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-dD8DedlW.js","utils-BgJ6PauS.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-m4sNRkou.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dg97LVEU.js","snippetPresets-C6CxWGOo.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CKiRf67B.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CDY0tBIx.js","shallow-BHHaYlmm.js","getApiPlaygroundDisplay-D6K3-cVX.js","CodeSnippet-BrS3fDep.js","CodeSnippets-Dkf1llUu.js","Page-DOwQSAHT.js","getPastedJson-3JcMsaes.js","icon-CWSTKRsN.js","MethodPill-t_TXGK5I.js","DuplicateIcon-DcjhdAbh.js","createIcon-2JHmGxKn.js","DynamicMarkdown-DMUWO-az.js","SectionHeading-DxvGHAss.js","axios-vUo_bRtp.js"]}