Configure o webhook de pedidos
curl --request PUT \
--url https://api.dev.connect.onbeefapp.com.br/v1/merchantOnboarding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ordersWebhookURL": {}
}
'{
"getMerchantURL": {},
"ordersWebhookURL": "<string>"
}Merchant
Configure o webhook de pedidos
Cadastre a URL base que recebe notificações de pedidos.
PUT
/
v1
/
merchantOnboarding
Configure o webhook de pedidos
curl --request PUT \
--url https://api.dev.connect.onbeefapp.com.br/v1/merchantOnboarding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ordersWebhookURL": {}
}
'{
"getMerchantURL": {},
"ordersWebhookURL": "<string>"
}Registre a URL base em que você quer receber as notificações de pedidos. Veja Webhook de pedidos para implementar o recebimento das notificações.
Envie uma nova requisição sempre que precisar alterar essa URL.
Com esse valor, as notificações chegam em
As chamadas atualizam apenas os campos enviados. Omitir
getMerchantURL numa nova requisição preserva o valor já registrado; não há como removê-lo pela API.Este endpoint registra apenas os dados de integração (URLs e chave). Para publicar categorias, produtos e preços, use
PUT /v1/merchantUpdate.Corpo da requisição
Envie um corpoapplication/json com os campos abaixo. ordersWebhookURL é obrigatório. getMerchantURL é opcional.
object
Dados opcionais de acesso ao endpoint de catálogo do seu PDV. Ao enviar
getMerchantURL, informe os dois campos abaixo.baseURL(string, url, obrigatório): URL base do endpoint.apiKey(string, obrigatório): chave de acesso ao endpoint.
string (url)
required
URL base do seu servidor para receber notificações de pedidos. A Onbeef acrescenta
/v1/orderUpdate ao valor informado. Não inclua esse caminho nem uma barra final em ordersWebhookURL.Veja Webhook de pedidos para conhecer o payload, os headers e as regras de entrega.Campos da resposta
200: Sucesso
Retorna a configuração de integração armazenada.object | null
A configuração de
getMerchantURL registrada (baseURL e apiKey). Retorna null quando nenhuma configuração foi registrada.string
A URL de webhook de pedidos registrada.
400: Requisição inválida
Um campo obrigatório está ausente ou inválido. O corpo informa o campo:{ "title": "The getMerchantURL.apiKey field is required when getMerchantURL is present.", "status": 400 }.
401: Não autorizado
Token ausente ou inválido. Reautentique-se e tente novamente. Veja Erros.Exemplo
Requisição
curl -X PUT https://api.dev.connect.onbeefapp.com.br/v1/merchantOnboarding \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
-H 'Content-Type: application/json' \
-d '{
"getMerchantURL": {
"baseURL": "https://your-pos-system.example.com",
"apiKey": "your-api-key"
},
"ordersWebhookURL": "https://your-pos-system.example.com/onbeef"
}'
POST https://your-pos-system.example.com/onbeef/v1/orderUpdate.
Resposta
{
"getMerchantURL": {
"baseURL": "https://your-pos-system.example.com",
"apiKey": "your-api-key"
},
"ordersWebhookURL": "https://your-pos-system.example.com/onbeef"
}
Depois de registrar a integração, sincronize seu catálogo com
PUT /v1/merchantUpdate e acompanhe o processamento em GET /v1/merchantStatus.