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>"
}
'

POST

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

orderId

string (uuid)

required

Identificador único do pedido a ser confirmado. Gerado pela Onbeef e retornado no evento do pedido.

Corpo da requisição

createdAt

string (date-time)

required

Data e hora em que o pedido foi criado, no formato ISO 8601 (por exemplo, 2019-08-24T14:15:22Z).

orderExternalCode

string

required

Código de referência interno do seu PDV para este pedido. Usado para correlacionar o pedido Onbeef com seus registros.

reason

string

Campo opcional em texto livre com contexto adicional sobre a confirmação: por exemplo, o nome do funcionário que aceitou o pedido.

preparationTime

integer

Tempo estimado de preparo em minutos. A Onbeef usa este valor para informar o cliente e o entregador sobre o tempo previsto até ficar pronto.

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 o orderId 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
}

Se você não consegue cumprir um pedido, não chame este endpoint. Em vez disso, use o endpoint Solicitar cancelamento para cancelar o pedido e informar o motivo.

Informe sempre um preparationTime realista. Superestimar prejudica a experiência do cliente; subestimar pode fazer o entregador chegar antes de o pedido estar pronto.

Consultar pedido Pronto para retirada

⌘I

Visão geral

Autenticação

Merchant

Pedidos

Logística

Confirme um pedido

Parâmetros de rota

Corpo da requisição

Resposta

202: Aceito

401: Não autorizado

404: Não encontrado

Exemplo de requisição

Exemplo de corpo da requisição

​Parâmetros de rota

​Corpo da requisição

​Resposta

​202: Aceito

​401: Não autorizado

​404: Não encontrado

​Exemplo de requisição

​Exemplo de corpo da requisição

Parâmetros de rota

Corpo da requisição

Resposta

202: Aceito

401: Não autorizado

404: Não encontrado

Exemplo de requisição

Exemplo de corpo da requisição