Confirme um pedido
curl --request POST \
--url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/confirm \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"createdAt": {},
"orderExternalCode": "<string>"
}
'Pedidos
Confirme um pedido
Aceite um pedido e inicie o preparo.
POST
/
v1
/
orders
/
{orderId}
/
confirm
Confirme um pedido
curl --request POST \
--url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/confirm \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"createdAt": {},
"orderExternalCode": "<string>"
}
'Chame este endpoint depois de revisar um evento
CREATED. A requisição aceita o pedido e inicia o preparo.
Parâmetros de rota
string (uuid)
required
Identificador único do pedido a ser confirmado. Gerado pela Onbeef e retornado no evento do pedido.
Corpo da requisição
string (date-time)
required
Data e hora em que o pedido foi criado, no formato ISO 8601 (por exemplo,
2019-08-24T14:15:22Z). O campo é exigido pelo padrão OpenDelivery, mas o valor não altera o pedido: o momento do aceite é registrado pela Onbeef ao receber a confirmação.string
required
Código de referência interno do seu PDV para este pedido. Usado para correlacionar o pedido Onbeef com seus registros.
string
Campo opcional em texto livre, previsto pelo padrão OpenDelivery. O valor não é armazenado.
integer
Tempo estimado de preparo em minutos. Opcional; o valor é registrado junto ao pedido.
Resposta
202: Aceito
A confirmação foi aceita para processamento. A Onbeef atualizará o status do pedido e notificará o cliente.401: Não autorizado
Retornado quando a requisição não inclui credenciais de autenticação válidas.404: Não encontrado
Nenhum pedido foi encontrado com oorderId informado.
Exemplo de requisição
curl --request POST \
--url "https://api.dev.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/confirm" \
--header "Authorization: Bearer <token>" \
--header "Content-Type: application/json" \
--data '{
"reason": "Aceito por Maria",
"createdAt": "2019-08-24T14:15:22Z",
"orderExternalCode": "POS-00123",
"preparationTime": 25
}'
curl --request POST \
--url "https://api.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/confirm" \
--header "Authorization: Bearer <token>" \
--header "Content-Type: application/json" \
--data '{
"reason": "Aceito por Maria",
"createdAt": "2019-08-24T14:15:22Z",
"orderExternalCode": "POS-00123",
"preparationTime": 25
}'
Exemplo de corpo da requisição
{
"reason": "Aceito por Maria",
"createdAt": "2019-08-24T14:15:22Z",
"orderExternalCode": "POS-00123",
"preparationTime": 25
}
Confirme o pedido antes de enviar o acknowledgment do evento
CREATED. O acknowledgment é o commit final do processamento: se você confirmar o evento e falhar antes de aceitar o pedido, ele deixa de aparecer no polling e não há listagem de pedidos para reencontrá-lo. Veja a ordem completa em Processar pedidos.