Pular para o conteúdo
platform
PT EN

Referência da API · Módulo Vendedor

Vincular Cliente ao Vendedor

Método
POST
Rota
/sellerModule/addCustomer/:attendantIdOrDocument
URL base
https://ws.autorei.net
Parâmetros de rota
:attendantIdOrDocument
Parâmetros de consulta do exemplo
uniqueAttendant=false
Token
Exige token Bearer
Testar no Postman

Abre esta requisição na documentação pública da API, a fonte oficial da referência.

Descrição

Vincula um cliente à carteira de um vendedor. A partir do vínculo, o cliente passa a ser atendido por esse vendedor.

Parâmetros de Rota

Parâmetro Tipo Obrigatório Descrição
attendantIdOrDocument string Sim Identifica o vendedor: aceita o UUID do vendedor ou o CPF/CNPJ do titular da conta dele. A rota reconhece qual dos dois você enviou.

Parâmetros de Consulta

Parâmetro Tipo Obrigatório Descrição
uniqueAttendant boolean Não true faz este vínculo ser o único do cliente, substituindo o vendedor anterior. Padrão false, que acumula vendedores para o mesmo cliente.

Corpo da Requisição (JSON)

Campo Tipo Obrigatório Descrição
Identificação do cliente - Sim Não é um campo, é um grupo. Envie username ou document.
username string Condicional E-mail de acesso do cliente. Obrigatório se document não for enviado.
document string Condicional CPF ou CNPJ do cliente. Obrigatório se username não for enviado.

Regras de negócio

O cliente precisa ser da sua loja

O vínculo só é criado para cliente já cadastrado na loja autenticada. Cliente de outra loja, ou documento sem cadastro, é recusado.

Resposta · 200

O vínculo criado. Os campos de identificação refletem o que você enviou: só username, só document, ou os dois.

Campo Tipo Descrição
id uuid Id do vínculo. É o valor que a rota de desvínculo pede.
username string E-mail do cliente. Só quando você o enviou.
document string Documento do cliente. Só quando você o enviou.
createdAt · updatedAt string Criação e última alteração do vínculo, em UTC.

Erros

Código Quando
400 Corpo ausente ou vazio (Body não informado), corpo sem username e sem document, documento sem cliente na sua loja (Nenhum cliente localizado com esse documento), vendedor não encontrado (Nenhum vendedor localizado com esse documento / Nenhum vendedor localizado com esse ID), ou conta não localizada no serviço de atendimento (Conta não localizada).
401 Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request POST 'https://ws.autorei.net/sellerModule/addCustomer/:attendantIdOrDocument?uniqueAttendant=false' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "document": "29.893.264/0001-01"
}'

Respostas de exemplo

200Sucesso: cliente vinculado pelo documento

{
  "id": "2f9d4c17-8a53-41be-b06d-9c1e7f28a5d3",
  "document": "29.893.264/0001-01",
  "createdAt": "2026-09-02T10:15:33.204118Z",
  "updatedAt": "2026-09-02T10:15:33.204118Z"
}

Usado em

Endpoints relacionados

← Ver o grupo: Módulo Vendedor

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.