📋 Listagem de Campos Adicionais do Cliente
GET
/customer/additional-field
Lista todos os campos adicionais disponíveis para o cliente
📋 Descrição
Endpoint responsável por listar todos os campos adicionais disponíveis para os clientes.
Para saber mais sobre a feature de campos adicionais consulte o tópico Campos adicionais.
📝 Parâmetros
🏷️ Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
📊 Campos de Condição Disponíveis
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | ID do campo adicional |
name | string | Nome do campo adicional |
code | string | Código do campo adicional |
type | string | Tipo do campo adicional |
required | boolean | Filtro por obrigatoriedade |
createdAt | datetime | Data de criação |
updatedAt | datetime | Data de atualização |
📊 Campos de Ordenação Disponíveis
| Campo | Descrição |
|---|---|
id | ID do campo adicional |
createdAt | Data de criação |
updatedAt | Data de atualização |
💡 Exemplo de Requisição
1curl --request GET \2 --url 'https://sua-loja-uappi.com.br/api/v3/customer/additional-field' \3 --header 'Content-Type: application/json' \4 --data '{5 "fields": [],6 "order": [7 { "field": "id", "order": "ASC" }8 ],9 "condition": {10 "type": "AND",11 "conditions": []12 }13 }'✅ Resposta de Sucesso
HTTP Status: 200 OK
1{2 "status": true,3 "data": {4 "registers": [5 {6 "id": 1,7 "name": "Interesses de Compra",8 "code": "interesses-de-compra",9 "type": "array",10 "required": false,11 "options": [12 "Moda",13 "Tecnologia",14 "Casa e Decoração",15 "Esportes"16 ],17 "createdAt": "2026-03-19 14:00:00",18 "updatedAt": "2026-03-19 14:00:00"19 },20 {21 "id": 2,22 "name": "Data de Nascimento da Mãe",23 "code": "data-de-nascimento-da-mae",24 "type": "date",25 "required": true,26 "options": null,27 "createdAt": "2026-03-19 14:05:00",28 "updatedAt": "2026-03-19 14:05:00"29 }30 ],31 "pagination": {32 "limit": 10,33 "offset": 0,34 "pages": 1,35 "registers": 236 }37 }38}⚠️ Possíveis Erros
> Os cenários abaixo representam os principais erros que podem ocorrer neste endpoint, servindo como referência para entendimento e tratamento das falhas.
> Este endpoint não possui erros específicos da aplicação além dos erros padrão de autenticação e validação de payload.