Pular para o conteúdo
platform
PT EN

Referência da API · Clientes · Grupo de Clientes

Criar Grupo de Clientes

Método
POST
Rota
/customer/group
URL base
https://ws.autorei.net
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

Cria um grupo de clientes da sua loja. O grupo define a que tipo de documento se aplica e quais formas de entrega e de pagamento ficam restritas para quem estiver nele.

Corpo da Requisição (JSON)

Campo Tipo Obrigatório Descrição
name string Sim Nome do grupo. Único na sua loja.
enableGroupDisplayInRegistration boolean Sim Se o grupo aparece no cadastro do cliente.
enableGroupDisplayInMyAccount boolean Sim Se o grupo aparece na conta do cliente.
applicationGroupDocumentType objeto Sim A que tipo de documento o grupo se aplica. Exatamente uma chave true, ver a regra.
restrictionDeliveryType objeto Sim Restrição de entrega. Exatamente uma chave true.
restrictionPaymentType objeto Sim Restrição de pagamento. Exatamente uma chave true.
showToSeller boolean Não Se o grupo aparece para o vendedor.
externalId string Não Id do grupo no seu sistema. Único na loja, máximo 20 caracteres.
colorHexadecimal string Não Cor do grupo em hexadecimal, sem #: exatamente 3, 6 ou 8 caracteres, só 0-9 e A-F.
groupTypeId string Não Id externo de um tipo de grupo já cadastrado na sua loja. Máximo 20 caracteres.
groupTypeName string Não Nome de um tipo de grupo já cadastrado na sua loja. Máximo 70 caracteres.
anonymousCustomer boolean Não Marca o grupo como o de cliente anônimo. Só um por loja.

Chaves aceitas em cada um dos três objetos:

Campo Chaves
applicationGroupDocumentType all · pj · iepr · pf
restrictionDeliveryType no_restriction · restrict_all_except_pickup_in_store · restrict_all_except_carrier · restrict_all_except_deliveries
restrictionPaymentType no_restriction · restrict_online_payment · restrict_offline_payment

Regras de negócio

Exatamente uma chave true em cada objeto

Nos três objetos, uma e só uma chave pode vir true. Nenhuma e mais de uma são recusadas, com mensagens diferentes, Pelo menos uma das opções ... deve ser definida como true. e Somente uma das opções ... deve ser definida como true.

O tipo de grupo precisa existir antes

groupTypeId e groupTypeName não criam um tipo de grupo: eles referenciam um que já esteja cadastrado na sua loja. Valor sem correspondência é recusado com Tipo Grupo de id X e name Y não cadastrado!. Enviando os dois, os dois têm de apontar para o mesmo tipo.

Resposta · 200

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 Qualquer recusa: campo obrigatório ausente, contagem de chaves true errada, name ou externalId já cadastrado, tipo de grupo inexistente, ou limite de tamanho estourado.
401 Token ausente, malformado ou expirado.

A recusa vem no mesmo envelope da operação, com status: "ERROR", e o message traz o código HTTP como prefixo:

{"status":"ERROR","message":"400 BAD_REQUEST: O campo 'name' é de preenchimento obrigatório.",
 "action":"CREATE","dateHour":"2026-09-04T12:14:15Z",
 "responsable":{"user":"integracao@lojaexemplo.com.br","origin":"API"}}

Quando há mais de um motivo, eles vêm no mesmo message, separados por , .

Exemplo de requisição

curl --request POST 'https://ws.autorei.net/customer/group' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Atacado Sudeste",
  "externalId": "GRP-ATC-SE",
  "showToSeller": true,
  "enableGroupDisplayInRegistration": true,
  "enableGroupDisplayInMyAccount": false,
  "colorHexadecimal": "1F7A4D",
  "applicationGroupDocumentType": {
    "pj": true
  },
  "restrictionDeliveryType": {
    "no_restriction": true
  },
  "restrictionPaymentType": {
    "restrict_offline_payment": true
  }
}'

Respostas de exemplo

200Sucesso: grupo criado

{
  "status": "SUCCESS",
  "message": "Grupo criado com sucesso.",
  "action": "CREATE",
  "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

Endpoints relacionados

← Ver o grupo: Clientes

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