Referência da API · Clientes · Grupo de Clientes

Excluir Grupo de Clientes

Método: DELETE
Rota: /customer/group
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

Exclui um grupo de clientes da sua loja. Os clientes que estavam no grupo continuam cadastrados, o que sai é o grupo e os vínculos com ele.

Corpo da Requisição (JSON)

Campo	Tipo	Obrigatório	Descrição
`externalId`	string	Sim	Id do grupo no seu sistema, o mesmo informado na criação.

Resposta · 200

O mesmo envelope da criação, com action: "DELETE" e a mensagem Grupo deletado com sucesso.

Campo	Tipo	Descrição
`status`	string	`SUCCESS`.
`message`	string	Confirmação da operação.
`action`	string	`CREATE` ou `DELETE`.
`dateHour`	string	Data e hora da operação, em UTC.
`responsable.user`	string	E-mail do usuário do token.
`responsable.origin`	string	`API`.
`group.internalId`	integer	Id interno do grupo.
`group.name`	string	Nome do grupo.
`group.externalId`	string	Id externo. `null` quando não informado.
`group.groupTypeId` · `group.groupTypeName`	string	Tipo de grupo. `null` quando não vinculado.

Erros

Código	Quando
400	`externalId` ausente, ou grupo inexistente. O motivo vem na mensagem, no mesmo envelope de erro da criação, com `status: "ERROR"`.
401	Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request DELETE 'https://ws.autorei.net/customer/group' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "externalId": "GRP-ATC-SE"
}'

Respostas de exemplo

200Sucesso: grupo excluído

{
  "status": "SUCCESS",
  "message": "Grupo deletado com sucesso.",
  "action": "DELETE",
  "dateHour": "2026-09-04T12:15:16Z",
  "responsable": {
    "user": "integracao@lojaexemplo.com.br",
    "origin": "API"
  },
  "group": {
    "internalId": 4470801,
    "name": "Atacado Sudeste",
    "externalId": "GRP-ATC-SE",
    "groupTypeId": null,
    "groupTypeName": null
  }
}

Usado em

Este endpoint ainda não aparece em nenhum caso de uso publicado.

Endpoints relacionados

GET Listar Grupos de Cliente /customer/group/byGroup
POST Criar 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.