Referência da API · Módulo Vendedor

Listar Carteira de Clientes do Vendedor

Método: GET
Rota: /sellerModule/listCustomers/:id
URL base: https://ws.autorei.net
Parâmetros de rota: :id
Parâmetros de consulta do exemplo: limit=20 offset=0
Token: Exige token Bearer

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

Descrição

Lista a carteira de clientes de um vendedor, os clientes que estão vinculados a ele.

Parâmetros de Rota

Parâmetro	Tipo	Obrigatório	Descrição
`id`	uuid	Sim	Id do vendedor, como veio em `id` na listagem de vendedores.

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
`limit`	integer	Não	Clientes por página. Padrão 20.
`offset`	integer	Não	Cliente inicial da página. Padrão 0.
`email`	string	Não	Busca parcial pelo e-mail do cliente.

Resposta · 200

Array com um objeto por vínculo. Vem [] quando o vendedor não tem cliente na carteira, e também quando o id informado não corresponde a nenhum vendedor.

Campo	Tipo	Descrição
`id`	uuid	Id do vínculo, não do cliente. É o valor que a rota de desvínculo pede.
`username`	string	E-mail de acesso do cliente.
`document`	string	CPF ou CNPJ do cliente.
`customerName`	string	Nome do cliente.
`createdAt` · `updatedAt`	string	Criação e última alteração do vínculo, em UTC.

Erros

Código	Quando
401	Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request GET 'https://ws.autorei.net/sellerModule/listCustomers/:id?limit=20&offset=0' \
  --header 'Authorization: Bearer {{access_token}}'

Respostas de exemplo

200Sucesso: um cliente na carteira

[
  {
    "id": "2f9d4c17-8a53-41be-b06d-9c1e7f28a5d3",
    "username": "compras@auroradistribuidora.com.br",
    "document": "29.893.264/0001-01",
    "customerName": "Comercial Aurora Ltda",
    "createdAt": "2026-09-02T10:15:33.204118Z",
    "updatedAt": "2026-09-02T10:15:33.204118Z"
  }
]

Usado em

Casos de usoVenda assistida e balcão: o caminho típico pela API

Endpoints relacionados

GET Listar Vendedores /sellerModule/listSellers
POST Adicionar Vendedor /sellerModule/addSeller
DELETE Remover Vendedor /sellerModule/deleteSeller/:id
POST Vincular Cliente ao Vendedor /sellerModule/addCustomer/:attendantIdOrDocument
DELETE Desvincular Cliente do Vendedor /sellerModule/deleteCustomer/:idAttendant/:idCustomer
POST Gerenciar Carteira em Lote /sellerModule/manageBulkWallet/:attendantInfo

← 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.