CustomerCreate
A mutation CustomerCreate permite o cadastro de novos clientes/usuários a partir do checkout headless e, opcionalmente, preenche campos adicionas de grupos cadastrais.
Para obter as informações do grupo de informação cadastral de um determinado tipo, como pessoa física ou pessoa jurídica, basta realizar a consulta na query InformationGroupFields, para assim ser inserido nesta mutation.
Parâmetros
input
input
Argumento | Tipo | Obrigatório | Descrição |
---|---|---|---|
address | String | Sim | Endereço do cliente |
addressComplement | String | Não | Complemento do endereço |
addressNumber | String | Sim | Número de endereço |
birthDate | DateTime | Sim, se customerType = PERSON | Data de nascimento do cliente. Formato aceito: DD/MM/YYYY. |
cep | String | Sim | CEP do endereço |
city | String | Sim | Cidade do endereço |
cnpj | String | Sim, se customerType = COMPANY | CNPJ da empresa |
corporateName | String | Sim, se customerType = COMPANY | Nome da empresa |
cpf | String | Sim, se customerType = PERSON | CPF do cliente |
customerType | EntityType | Sim | Tipo de cliente (PERSON _ou _COMPANY) |
String | Sim | Email do cliente | |
fullName | String | Sim, se customerType = PERSON | Nome completo do cliente |
gender | Gender | Não | Gênero do cliente (MALE ou FEMALE) Caso não seja informado, será apresentado no minha conta como uma terceira opção, com um traço (-) e retornará null na query Customer. |
isStateRegistrationExempt | boolean | Não | Isento de inscrição estadual |
neighborhood | String | Sim | Bairro do endereço |
newsletter | Boolean | Não | Assinar newsletter |
password | String | Sim | Senha de cadastro |
passwordConfirmation | String | Sim | Confirmação da senha de cadastro |
primaryPhoneAreaCode | String | Sim | DDD do telefone principal do cliente |
primaryPhoneNumber | String | Sim | Telefone principal do cliente |
receiverName | String | Sim | Nome do destinatário |
reference | String | Não | Refêrencia de endereço |
reseller | Boolean | Não | Cadastro como revendedor |
secondaryPhoneAreaCode | String | Não | DDD do telefone secundário do cliente |
secondaryPhoneNumber | String | Não | Telefone secundário do cliente |
state | String | Sim | Estado do endereço (sigla ex.: SP, RJ, MG). |
stateRegistration | String | Não | Inscrição estadual da empresa |
informationGroupValues | InformationGroupValueInput | Não | Valores dos campos adicionais de grupos cadastrais. Cada item do array deve conter o id do campo cadastral e o value a ser salvo. |
Campos de retorno
Os campos de retorno são os mesmo da query Customer
Exemplo:
mutation {
customerCreate(input: {
fullName: "Teste Test"
email: "[email protected]"
password: "123456"
passwordConfirmation: "123456"
birthDate: "01/01/1991"
customerType: PERSON
address: "Rua"
addressNumber: "00"
neighborhood: "Bairro A"
city: "BH"
state: "MG"
cep: "30609000"
primaryPhoneAreaCode: "31"
primaryPhoneNumber: "99999-9999"
cpf: "11111111111"
informationGroupValues: [
{ id: "eyJFbnRpdHkiOiJ...MTR9", value: "Desenvolvedor" }
]
}) {
customerId
}
}
Variáveis
{
"input": {
"customerType": "COMPANY",
"email": "[email protected]",
"cnpj": "12.345.678/0001-90",
"corporateName": "Empresa LTDA",
"stateRegistration": "123456789",
"isStateRegistrationExempt": false,
"password": "c0rpor@t3_p@ssw0rd",
"passwordConfirmation": "c0rpor@t3_p@ssw0rd",
"primaryPhoneAreaCode": "11",
"primaryPhoneNumber": "987654321",
"receiverName": "Carlos Silva",
"cep": "12345-678",
"address": "Av. Paulista",
"addressNumber": "1000",
"addressComplement": "8o andar",
"city": "São Paulo",
"neighborhood": "Bela Vista",
"state": "SP",
"reference": "Próximo ao metrô Trianon Masp",
"newsletter": false,
"reseller": false
}
}
Mostrar resposta
{
"data": {
"customerCreate": {
"corporateName": "Empresa LTDA",
"email": "[email protected]"
}
}
}
- Os campos adicionais de grupos cadastrais também podem ser enviados/atualizados via customerUpdate (Minha Conta).
- Para exibir esses campos no Storefront 2.0 (checkout SSR), é necessário habilitar no
settings.json
do template da loja:
{ "show_information_groups_fields": true }
Updated 15 days ago