Registre o merchant

curl --request PUT \
  --url https://api.dev.connect.onbeefapp.com.br/v1/merchantOnboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantId": "<string>",
  "getMerchantURL": {},
  "ordersWebhookURL": {}
}
'

{
  "getMerchantURL": {},
  "ordersWebhookURL": "<string>"
}

PUT

merchantOnboarding

Registre o merchant

curl --request PUT \
  --url https://api.dev.connect.onbeefapp.com.br/v1/merchantOnboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantId": "<string>",
  "getMerchantURL": {},
  "ordersWebhookURL": {}
}
'

{
  "getMerchantURL": {},
  "ordersWebhookURL": "<string>"
}

Informe a URL usada para buscar o catálogo e a URL que recebe eventos de pedidos. Use este endpoint antes da primeira sincronização e quando essas configurações mudarem.

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 corpo Content-Type: application/json com os campos abaixo. Todos são obrigatórios.

merchantId

string

required

UUID do seu merchant na plataforma Onbeef.

getMerchantURL

object

required

Configuração do endpoint do seu PDV que a Onbeef vai chamar para obter seu catálogo.

baseURL (string, url, obrigatório): URL base do endpoint de merchant do seu PDV.
apiKey (string, obrigatório): chave de API que a Onbeef usará para autenticar as chamadas ao seu endpoint.

ordersWebhookURL

string (url)

required

URL do seu servidor onde a Onbeef entregará notificações de webhook de pedidos.

Campos da resposta

200: Sucesso

Retorna a configuração de integração armazenada.

getMerchantURL

object

A configuração de getMerchantURL registrada (baseURL e apiKey).

ordersWebhookURL

string

A URL de webhook de pedidos registrada.

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 '{
    "merchantId": "9b2f4c1e-0a3d-4e8c-9d6a-2b7f1c0d5e3a",
    "getMerchantURL": {
      "baseURL": "https://your-pos-system.example.com",
      "apiKey": "your-api-key"
    },
    "ordersWebhookURL": "https://your-pos-system.example.com/webhooks/orders"
  }'

Resposta

{
  "getMerchantURL": {
    "baseURL": "https://your-pos-system.example.com",
    "apiKey": "your-api-key"
  },
  "ordersWebhookURL": "https://your-pos-system.example.com/webhooks/orders"
}

Depois de registrar a integração, sincronize seu catálogo com PUT /v1/merchantUpdate e acompanhe o processamento em GET /v1/merchantStatus.

Status da sincronização Sincronizar catálogo

⌘I

Visão geral

Autenticação

Merchant

Pedidos

Logística

Registre o merchant

Corpo da requisição

Campos da resposta

200: Sucesso

401: Não autorizado

Exemplo

Requisição

Resposta

​Corpo da requisição

​Campos da resposta

​200: Sucesso

​401: Não autorizado

​Exemplo

​Requisição

​Resposta

Corpo da requisição

Campos da resposta

200: Sucesso

401: Não autorizado

Exemplo

Requisição

Resposta