VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Conta do cliente

Perfil, documentos, endereços, campos extras e privacidade do cliente logado.

A conta do cliente reúne o que pertence à pessoa, e não a um pedido: o perfil e os documentos (CPF ou CNPJ), a senha e o e-mail de login, o caderno de endereços, os campos extras de cadastro que a loja define e a escolha de receber (ou não) recomendações personalizadas. Tudo é chamado com o token do próprio cliente, e cada cliente só enxerga e altera a sua conta.

Pontos-chave
  • Criar a conta e entrar são rotas de Autenticação; esta seção começa depois do login.
  • O token do cliente é a única identidade: não há customer_id na URL. Para mexer na conta de outra pessoa não existe rota aqui.
  • Trocar a senha ou o e-mail (pelas rotas dedicadas) invalida todos os tokens e sessões: o aplicativo precisa pedir login de novo.
  • Quem entrou por uma sessão de suporte (um administrador "entrando como o cliente") não pode trocar e-mail nem senha.
  • Uma conta nova pode ficar P (aguardando aprovação) em lojas que aprovam cadastros; o token dela só abre perfil e envio de documentos.

Como funciona

CPF, CNPJ e o tipo de pessoa

No Brasil, quem compra é pessoa física (CPF, 11 dígitos) ou jurídica (CNPJ, 14 dígitos). A conta guarda isso em person_type: F ou J. Uma conta jurídica mantém o CNPJ da empresa e, separado, o CPF do responsável (responsible_cpf). Em lojas B2B, vários usuários do mesmo CNPJ formam uma conta corporativa e enxergam os pedidos uns dos outros (Meus pedidos).

Regra do documentoDetalhe
FormatoCom ou sem máscara (123.456.789-09 ou 12345678909). A plataforma valida os dígitos verificadores e grava só os números.
Trocar o documentoO cliente não troca um documento que a conta já tem (403 document_locked: "fale com a loja"). Preencher quando está vazio, ou reenviar o mesmo valor, é aceito.
DuplicidadeO mesmo CPF em duas contas é recusado (409 cpf_already_registered).
Trocar de física para jurídicaPelo campo person_type do perfil, se a loja aceitar o tipo (403 person_type_not_accepted caso contrário).

Endereços: caderno e pedido

O caderno de endereços (Endereços) é a lista salva do cliente. Ao fechar um pedido, o endereço escolhido é copiado para dentro do pedido: editar ou apagar o endereço depois não altera pedidos antigos.

Campos extras de cadastro

Além dos campos fixos (nome, telefone, CPF), a loja pode definir campos extras (inscrição estadual, ramo de atividade, anexos...) que aparecem no cadastro e no perfil. A lista dos campos é pública e os valores do cliente ficam em Campos do perfil.

Endpoints

Método e caminhoPara quêAutenticaçãoPágina
GET /api/v1/storefront/profileLê o perfilclientePerfil
PUT /api/v1/storefront/profileAltera nome, telefone, documentos e preferênciasclientePerfil
POST /api/v1/storefront/profile/avatarEnvia a foto de perfilclientePerfil
POST /api/v1/storefront/profile/passwordTroca a senhaclienteSenha e e-mail
POST /api/v1/storefront/profile/emailTroca o e-mail de loginclienteSenha e e-mail
GET /api/v1/storefront/addressesLista os endereçosclienteEndereços
POST /api/v1/storefront/addressesCria um endereçoclienteEndereços
PUT /api/v1/storefront/addresses/{id}Altera um endereçoclienteEndereços
DELETE /api/v1/storefront/addresses/{id}Apaga um endereçoclienteEndereços
GET /api/v1/storefront/profile/fieldsCampos extras definidos pela lojapúblicaCampos do perfil
GET /api/v1/storefront/profile/field-valuesValores do clienteclienteCampos do perfil
PUT /api/v1/storefront/profile/field-valuesGrava os valoresclienteCampos do perfil
GET /api/v1/storefront/account/personalizationVê o que a loja aprendeuclientePersonalização
POST /api/v1/storefront/account/personalization/optoutDesliga a personalizaçãoclientePersonalização
POST /api/v1/storefront/account/personalization/optinLiga a personalizaçãoclientePersonalização
DELETE /api/v1/storefront/account/personalizationApaga o perfil aprendidoclientePersonalização

Pedidos, devoluções e contestações do cliente estão em Pedidos e conta do cliente e Devoluções e contestações.

Erros comuns

Os tropeços mais frequentes
  1. Mandar o e-mail novo pelo PUT /profile. Funciona, mas sem pedir a senha e sem encerrar as sessões. Use Senha e e-mail.
  2. Não refazer o login depois de trocar a senha. O token antigo deixa de valer na hora (401).
  3. Tentar trocar o CPF/CNPJ de uma conta que já tem documento. Responde 403 document_locked; o fluxo é falar com a loja.
  4. Esperar 404 ao apagar ou alterar um endereço de outra pessoa. Hoje a plataforma responde 500 ao apagar e 200 com corpo null ao alterar um id que não é seu; valide no seu lado.
  5. Salvar endereço sem número ou bairro em lojas com política de endereço: volta 422 com um código como address_number_required.
  6. Ler o campo cpf como sempre CPF. Em conta jurídica ele pode ser o CPF do responsável; o CNPJ vem em cnpj.
  7. Enviar foto de perfil como JSON. O envio é multipart/form-data com o campo file.

Próximos passos

Perfil
Leia e altere os dados do cliente.
Endereços
O caderno de endereços.
Senha e e-mail
Credenciais de login.
Campos do perfil
Campos extras da loja.
Anterior
Carteira, conta-corrente e alçadas
Próxima
Perfil
Nesta página
  • Como funciona
  • CPF, CNPJ e o tipo de pessoa
  • Endereços: caderno e pedido
  • Campos extras de cadastro
  • Endpoints
  • Erros comuns
  • Próximos passos