Referência da API · Clientes · Grupo de Clientes

Listar Grupos de Cliente

Método: GET
Rota: /customer/group/byGroup
URL base: https://ws.autorei.net
Token: Exige token Bearer

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

Descrição

Consulta grupos de cliente da sua loja por nome ou por id externo.

Corpo da Requisição (JSON)

Campo	Tipo	Obrigatório	Descrição
Critério de busca	-	Sim	Não é um campo, é um grupo. Envie `name` ou `externalId`.
`name`	array	Condicional	Nomes dos grupos.
`externalId`	array	Condicional	Ids externos dos grupos.

Regras de negócio

Os critérios são arrays, sempre

name e externalId têm de ser arrays, mesmo para um único valor: {"name": ["Atacado"]}. Valor escalar é recusado.

Resposta · 200

Objeto com a chave groups, array com um objeto por grupo encontrado. Sem correspondência, vem {"groups": []}.

Campo	Tipo	Descrição
`internalId`	integer	Id interno do grupo. É o que a exclusão pede.
`name`	string	Nome do grupo.
`externalId`	string	Id externo do grupo. `null` quando não informado.
`groupTypeId` · `groupTypeName`	string	Tipo de grupo vinculado. `null` quando não há.
`details.showToSeller`	boolean	Se o grupo aparece para o vendedor.
`details.enableGroupDisplayInRegistration`	boolean	Se o grupo aparece no cadastro.
`details.enableGroupDisplayInMyAccount`	boolean	Se o grupo aparece na conta do cliente.
`details.applicationGroupDocumentType`	string	Tipo de documento a que o grupo se aplica: `all`, `pj`, `iepr` ou `pf`.
`details.restrictionDeliveryType`	string	Restrição de entrega: `no_restriction`, `restrict_all_except_pickup_in_store`, `restrict_all_except_carrier` ou `restrict_all_except_deliveries`.
`details.restrictionPaymentType`	string	Restrição de pagamento: `no_restriction`, `restrict_online_payment` ou `restrict_offline_payment`.

Os três campos de details devolvem a mesma chave que você enviou na criação do grupo.

Erros

Código	Quando
400	Nenhum critério informado, critério escalar em vez de array, ou todos os arrays vazios. O motivo vem na mensagem.
401	Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request GET 'https://ws.autorei.net/customer/group/byGroup' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": [
    "Atacado Sudeste"
  ]
}'

Respostas de exemplo

200Sucesso: um grupo encontrado

{
  "groups": [
    {
      "internalId": 4470801,
      "name": "Atacado Sudeste",
      "externalId": "GRP-ATC-SE",
      "groupTypeId": null,
      "groupTypeName": null,
      "details": {
        "showToSeller": true,
        "enableGroupDisplayInRegistration": true,
        "enableGroupDisplayInMyAccount": false,
        "applicationGroupDocumentType": "pj",
        "restrictionDeliveryType": "no_restriction",
        "restrictionPaymentType": "restrict_offline_payment"
      }
    }
  ]
}

Usado em

Casos de usoVarejo complexo e B2B2C: o caminho típico pela API

Endpoints relacionados

POST Criar Grupo de Clientes /customer/group
DELETE Excluir Grupo de Clientes /customer/group
PUT Vincular cliente a um Grupo /customer/:document/priceType/:customerGroupId
DELETE Desvincular cliente de um grupo /customer/:document/priceType/:customerGroupId

← Ver o grupo: Clientes

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