> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onbeef.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Registre o merchant

> Cadastre as URLs da integração.

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.

<Note>
  Este endpoint registra apenas os dados de integração (URLs e chave). Para publicar categorias, produtos e preços, use [`PUT /v1/merchantUpdate`](/api-reference/merchant/sync-catalog).
</Note>

## Corpo da requisição

Envie um corpo `Content-Type: application/json` com os campos abaixo. Todos são obrigatórios.

<ParamField body="merchantId" type="string" required>
  UUID do seu merchant na plataforma Onbeef.
</ParamField>

<ParamField body="getMerchantURL" type="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.
</ParamField>

<ParamField body="ordersWebhookURL" type="string (url)" required>
  URL do seu servidor onde a Onbeef entregará notificações de webhook de pedidos.
</ParamField>

## Campos da resposta

### 200: Sucesso

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

<ResponseField name="getMerchantURL" type="object">
  A configuração de `getMerchantURL` registrada (`baseURL` e `apiKey`).
</ResponseField>

<ResponseField name="ordersWebhookURL" type="string">
  A URL de webhook de pedidos registrada.
</ResponseField>

### 401: Não autorizado

Token ausente ou inválido. Reautentique-se e tente novamente. Veja [Erros](/api-reference/errors).

## Exemplo

### Requisição

```bash theme={null}
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

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

<Tip>
  Depois de registrar a integração, sincronize seu catálogo com [`PUT /v1/merchantUpdate`](/api-reference/merchant/sync-catalog) e acompanhe o processamento em [`GET /v1/merchantStatus`](/api-reference/merchant/get-status).
</Tip>