Criar cliente

Cadastra um cliente pessoa física ou jurídica, um administrador ou um usuário de seller.

Use esta operação quando o cadastro nasce fora da vitrine: um ERP que exporta sua base, um atendimento que abre a conta por telefone, uma migração de outro sistema. O cliente criado já pode entrar com o e-mail e a senha, comprar e receber os e-mails de cadastro que a loja tiver configurado (o mesmo evento de cadastro de uma conta criada na vitrine é disparado).

Antes de criar, procure o e-mail e o documento com Listar clientes: o e-mail é único entre os usuários não excluídos. Esta rota cria só o essencial (e-mail, nome, telefone, CNPJ) e devolve apenas os ids do novo usuário.

POST/api/v1.0/usersAdmin

Criar um usuário

Também responde em POST /api/users. Só email e user_type são obrigatórios na checagem da rota, mas na prática é preciso um nome (firstname ou name); sem ele a chamada volta 400.

Sem password, a plataforma gera uma senha aleatória e descartável (nunca uma senha fixa). O cliente criado assim entra pelo fluxo "esqueci a senha". Não existe senha padrão.

Corpo da requisição

emailstringobrigatório

E-mail de login. Vira minúsculo. Precisa ser um e-mail válido e ainda não estar em uso.

user_typestringobrigatório

AVC

C cliente, V usuário de seller, A administrador. Qualquer outro valor cria um cliente, sem erro.

firstnamestring

Nome. name é aceito como sinônimo. Obrigatório na prática.

lastnamestring

Sobrenome.

passwordstring

Senha. Se omitida, é gerada uma aleatória. Esta rota não aplica a regra de senha forte da vitrine; use uma senha longa.

phonestring

Telefone, gravado em formato internacional.

CNPJstring

CNPJ da empresa, com ou sem máscara. Validado pelos dígitos verificadores. Com CNPJ, o cadastro nasce PJ e o nome informado vira a razão social.

statusstringpadrão: A

ADP

Status inicial (letra ou palavra). Padrão: ativo.

company_idinteger

Aceito para compatibilidade e ignorado: criar um usuário V por aqui não o liga a nenhum seller.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X POST "$BASE_URL/api/v1.0/users" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "maria.souza@example.com",
    "user_type": "C",
    "firstname": "Maria",
    "lastname": "Souza",
    "phone": "11999990000"
  }'

Resposta

201Usuário criado

json

{
  "user_id": "a52840fe-442d-4e77-b3c5-624965b38aaf",
  "profile_id": "a52840fe-442d-4e77-b3c5-624965b38aaf"
}

Campos da resposta

user_idstring

Id do novo usuário (UUID; decimal em /api/users). Guarde-o: é a chave para tudo o resto.

profile_idstring

Igual a user_id (na plataforma antiga eram dois ids).

Erros

Status	Quando	Corpo
400	Corpo que não é JSON	`{"message":"Invalid JSON body","status":400}`
400	Falta `email` ou `user_type`	`{"message":"Required field: email","status":400}` ou `{"message":"Required field: user_type","status":400}`
400	Cadastro recusado: nome ausente, e-mail ou CNPJ inválido	`{"message":"<motivo>","status":400}`
400	E-mail já em uso	`{"message":"email already registered","status":400}`
401	Sem credenciais, chave inválida ou token expirado	`{"message":"Invalid credentials","status":401}`
403	Não é administrador	`{"message":"Forbidden: admin scope required","status":403}`

Veja também