Campos de perfil

Leia os campos de perfil definidos pela loja para cada cliente, e saiba quais rotas de perfil de envio não são implementadas.

Além dos dados fixos da conta (e-mail, nome, telefone, documento), cada loja define campos de perfil: informações extras que ela quer saber do cliente, como "ramo de atividade", "nome do responsável" ou "inscrição municipal". A loja cria esses campos no painel e escolhe quais são obrigatórios no cadastro e se valem para PF, para PJ ou para os dois.

Cada campo tem um field_id (UUID) e um field_name (o nome técnico). Esta rota lê o valor de cada campo para um cliente específico. As definições dos campos (criar, renomear, tornar obrigatório) são feitas no painel da loja e não fazem parte desta seção.

Alguns campos são nativos e estão ligados a uma coluna da conta (first_name, last_name, email, phone e cpf): o valor devolvido é o da própria conta. Os demais campos guardam o valor à parte.

GET/api/v1.0/users/{user_id}/profile-fieldsAdmin

Valores dos campos de perfil de um usuário

Os mesmos valores que vêm em fields na consulta de um usuário (Consultar cliente), numa rota própria. Também responde em /api/users/{user_id}/profile-fields.

Parâmetros de caminho

user_idstringobrigatório

Id do usuário (UUID; na rota sem versão, o id decimal).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/users/3dc023ca-3746-4b6e-8afd-686a4a9af99f/profile-fields"

Resposta

200Campos do usuário

json

{
  "user_id": "3dc023ca-3746-4b6e-8afd-686a4a9af99f",
  "fields": [
    { "field_id": "1bf6d0a9-56a9-495d-a51a-160c39bcd2f9", "field_name": "company_name", "value": "Padaria Pão Doce Ltda" },
    { "field_id": "19d6bcb8-9d1f-4750-aa10-1e2feba51366", "field_name": "responsible_name", "value": "João Pereira" },
    { "field_id": "b7d6a164-ef12-4f83-8011-c9cb27e1e6be", "field_name": "email", "value": "contato@paodoce.example.com" }
  ],
  "params": { "total_items": 3 }
}

Campos da resposta

fieldsarray

Um item por campo de perfil habilitado na loja, mesmo sem valor (value vazio).

fields[].field_idstring

Id do campo.

fields[].field_namestring

Nome técnico do campo.

fields[].valuestring

Valor do cliente, como texto.

params.total_itemsinteger

Quantidade de campos devolvidos.

Perfis de envio (não implementados)

A Venddor 1.0 tinha user_profiles para guardar perfis de envio do cliente. A Venddor mantém as rotas para que clientes antigos recebam uma resposta clara, mas elas não fazem nada. Para endereços, use Endereços.

GET/api/v1.0/user_profilesAdmin

Listar perfis de entrega (não implementado)

Exige user_id na consulta (senão 400 user_id is required) e responde sempre 501. Com scope=get_fields responde 501 também.

Parâmetros de consulta

user_idstring

Id do usuário. Obrigatório, a menos que use scope.

scopestring

get_fields

Pedia as definições dos campos de perfil. Responde 501.

501Não implementado

json

{ "message": "shipping profiles are not implemented", "status": 501 }

POST/api/v1.0/user_profilesAdmin

Criar um perfil de entrega (não implementado)

Exige user_id e profile_data no corpo (senão 400) e responde 501 (shipping profile creation is not implemented).

Corpo da requisição

user_idstringobrigatório

Id do usuário.

profile_dataobjectobrigatório

Dados do perfil.

PUT/api/v1.0/user_profiles/{id}Admin

Atualizar um perfil de entrega (não implementado)

Mesmas regras do POST: valida user_id e profile_data e responde 501 (shipping profile update is not implemented).

Parâmetros de caminho

idstringobrigatório

Id do perfil.

Corpo da requisição

user_idstringobrigatório

Id do usuário.

profile_dataobjectobrigatório

Dados do perfil.

Erros

Status	Quando	Corpo
401	Sem credenciais ou token expirado	`{"message":"Invalid credentials","status":401}`
501	Qualquer chamada a `user_profiles`	`{"message":"shipping profile update is not implemented","status":501}`

Veja também

Campos de perfil

Leia os campos de perfil definidos pela loja para cada cliente, e saiba quais rotas de perfil de envio não são implementadas.

GET/api/v1.0/users/{user_id}/profile-fieldsAdmin

Valores dos campos de perfil de um usuário

Os mesmos valores que vêm em fields na consulta de um usuário (Consultar cliente), numa rota própria. Também responde em /api/users/{user_id}/profile-fields.

Parâmetros de caminho

user_idstringobrigatório

Id do usuário (UUID; na rota sem versão, o id decimal).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/users/3dc023ca-3746-4b6e-8afd-686a4a9af99f/profile-fields"

Resposta

200Campos do usuário

json

{
  "user_id": "3dc023ca-3746-4b6e-8afd-686a4a9af99f",
  "fields": [
    { "field_id": "1bf6d0a9-56a9-495d-a51a-160c39bcd2f9", "field_name": "company_name", "value": "Padaria Pão Doce Ltda" },
    { "field_id": "19d6bcb8-9d1f-4750-aa10-1e2feba51366", "field_name": "responsible_name", "value": "João Pereira" },
    { "field_id": "b7d6a164-ef12-4f83-8011-c9cb27e1e6be", "field_name": "email", "value": "contato@paodoce.example.com" }
  ],
  "params": { "total_items": 3 }
}

Campos da resposta

fieldsarray

Um item por campo de perfil habilitado na loja, mesmo sem valor (value vazio).

fields[].field_idstring

Id do campo.

fields[].field_namestring

Nome técnico do campo.

fields[].valuestring

Valor do cliente, como texto.

params.total_itemsinteger

Quantidade de campos devolvidos.

Perfis de envio (não implementados)

GET/api/v1.0/user_profilesAdmin

Listar perfis de entrega (não implementado)

Exige user_id na consulta (senão 400 user_id is required) e responde sempre 501. Com scope=get_fields responde 501 também.

Parâmetros de consulta

user_idstring

Id do usuário. Obrigatório, a menos que use scope.

scopestring

get_fields

Pedia as definições dos campos de perfil. Responde 501.

501Não implementado

json

{ "message": "shipping profiles are not implemented", "status": 501 }

POST/api/v1.0/user_profilesAdmin

Criar um perfil de entrega (não implementado)

Exige user_id e profile_data no corpo (senão 400) e responde 501 (shipping profile creation is not implemented).

Corpo da requisição

user_idstringobrigatório

Id do usuário.

profile_dataobjectobrigatório

Dados do perfil.

PUT/api/v1.0/user_profiles/{id}Admin

Atualizar um perfil de entrega (não implementado)

Mesmas regras do POST: valida user_id e profile_data e responde 501 (shipping profile update is not implemented).

Parâmetros de caminho

idstringobrigatório

Id do perfil.

Corpo da requisição

user_idstringobrigatório

Id do usuário.

profile_dataobjectobrigatório

Dados do perfil.

Erros

Status	Quando	Corpo
401	Sem credenciais ou token expirado	`{"message":"Invalid credentials","status":401}`
501	Qualquer chamada a `user_profiles`	`{"message":"shipping profile update is not implemented","status":501}`