Pular para o conteúdo
platform
PT EN

Referência da API · Módulo Vendedor

Listar Vendedores

Método
GET
Rota
/sellerModule/listSellers
URL base
https://ws.autorei.net
Parâmetros de consulta do exemplo
limit=20 offset=0
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

Lista os vendedores da sua loja, com as permissões de cada um. É por aqui que você descobre o id do vendedor, que as demais rotas do módulo pedem.

Parâmetros de Consulta

Parâmetro Tipo Obrigatório Descrição
limit integer Não Vendedores por página. Padrão 20, sem teto.
offset integer Não Vendedor inicial da página. Padrão 0.
email string Não Busca parcial pelo e-mail de acesso, sem diferenciar maiúsculas.

Resposta · 200

Array com um objeto por vendedor. Vem [] quando não há vendedor, ou quando o offset passa do último.

Campo Tipo Descrição
id uuid Id do vendedor. É um UUID, não um inteiro, é o valor que as demais rotas do módulo pedem no path.
username string E-mail de acesso do vendedor.
document string CPF ou CNPJ do vendedor.
restrictedCustomers boolean Se o vendedor atende só a carteira dele.
enabledFreight boolean Se pode alterar o frete.
enabledInsertFreight boolean Se pode inserir frete.
enabledCustomerRegistration boolean Se pode cadastrar cliente.
enableDiscountItemValue boolean Se pode dar desconto no valor do item.
enableAddItemValue boolean Se pode acrescentar valor ao item.
enableDiscountBranch boolean Se pode usar o desconto da filial.
enableDiscountFranchise boolean Se pode usar o desconto da franquia. Só volta true quando enableDiscountBranch também é true.
enableDiscountSeller boolean Se pode usar o desconto próprio.
enableCoupon boolean Se pode aplicar cupom.
enableChatSupport boolean Se atende pelo chat.
enableRestrictedCustomers boolean Atributo de carteira restrita, gravado no vendedor.
enableRestrictedGroupsAttendant boolean Se atende só grupos de cliente restritos.
attendantCode string Código do vendedor no seu sistema. Vem "" quando não informado.
allowedSellersId array Ids dos vendedores que este vendedor pode consultar. Vem [] quando não há.
profile objeto Perfil do vendedor (id, code, name). Vem null quando não há perfil.
createdAt · updatedAt string Criação e última alteração, em UTC.

Erros

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

Exemplo de requisição

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

Respostas de exemplo

200Sucesso: um vendedor da loja

[
  {
    "id": "7c3f1a8e-4b62-4d05-9e17-5a2c8d3f6b04",
    "username": "vendedor@lojaexemplo.com.br",
    "document": "528.871.928-41",
    "restrictedCustomers": true,
    "enabledFreight": false,
    "enabledInsertFreight": false,
    "enabledCustomerRegistration": false,
    "enableDiscountItemValue": true,
    "enableAddItemValue": false,
    "enableDiscountBranch": true,
    "enableDiscountFranchise": false,
    "enableDiscountSeller": false,
    "enableCoupon": true,
    "enableChatSupport": false,
    "createdAt": "2026-09-01T13:42:07.512034Z",
    "updatedAt": "2026-09-01T13:42:07.512034Z",
    "attendantCode": "VEND-001",
    "enableRestrictedCustomers": true,
    "enableRestrictedGroupsAttendant": false,
    "allowedSellersId": [],
    "profile": null
  }
]

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.