Atualização dos campos adicionais no cliente logado
PUT
/customers/{customerId}/additional-field
Atualiza os campos adicionais de um cliente
Descrição
Endpoint que permite usários administrativos atualizar os campos adicionais de um cliente especificado via URL.
Para saber mais sobre a feature de campos adicionais consulte o tópico Campos adicionais.
⚠️ Esse endpoint atualiza dados em lote, portanto os erros ocorridos em cada campo adicional enviado serão reportados dentro do próprio campo adicional enviado.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Authorization | Bearer {userToken} | Token de autenticação do usuário |
Content-Type | application/json | Tipo de conteúdo |
Parâmetros de rota
| Campo | Tipo | Descrição |
|---|---|---|
| customerId | integer | ID do cliente recebendo a atualização. |
Parâmetros do Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| items | array | Sim | Campos adicionais que serão atualizados (máximo de 100 itens). |
| items.*.code | string | Sim | Código do campo sendo atualizado (máximo 100 caracteres). |
| items.*.value | string, boolean, integer, float, array | Sim | Novo valor do campo. |
Exemplo de Requisição
1curl --request PUT \2 --url https://sua-loja-uappi.com.br/api/v3/customers/4/additional-field \3 --header 'Authorization: Bearer SEU_TOKEN_AQUI' \4 --header 'Content-Type: application/json' \5 --data '{6 "items": [7 {8 "code": "quantidade-filhos",9 "value": 210 },11 {12 "code": "tem-intolerancia-a-lactose",13 "value": "Valor inválido"14 },15 {16 "code": "interesses-de-compra",17 "value": ["Moda", "Tecnologia"]18 }19 ]20}'✅ Resposta de Sucesso
1{2 "status": true,3 "data": [4 {5 "code": "quantidade-filhos",6 "value": 2,7 "error": null8 },9 {10 "code": "tem-intolerancia-a-lactose",11 "value": "Valor inválido",12 "error": {13 "errorCode": "UAPPI_CORE_COMMON_ADDITIONAL_FIELD_INVALID_VALUE_TYPE",14 "code": 400,15 "message": "The type of value provided is invalid.",16 "details": []17 }18 },19 {20 "code": "interesses-de-compra",21 "value": ["Moda", "Tecnologia"],22 "error": null23 }24 ]25}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | Código HTTP | Descrição |
|---|---|---|
| UAPPI_CORE_COMMON_ADDITIONAL_FIELD_INVALID_VALUE_TYPE | 400 | O tipo do valor informado não é aceitável para o tipo do campo. Em caso de campos do tipo "upload" indica que o formato do arquivo enviado é inválido. |
| UAPPI_CORE_COMMON_ADDITIONAL_FIELD_FILE_TOO_LARGE | 400 | O tamanho do arquivo enviado é maior que 2048 kilobytes. |
| UAPPI_CORE_COMMON_ADDITIONAL_FIELD_INVALID_OPTION | 400 | A opção escolhida como valor do campo não é aceitável entre as opções configuradas. |
| UAPPI_CORE_COMMON_ADDITIONAL_FIELD_MISSING_REQUIRED_FIELD | 400 | O campo adicional é obrigatório. |
| UAPPI_CORE_INVALID_PHONE_NUMBER | 400 | O telefone informado não é valido, ele deve ser iniciado com + e seguindo por 7 a 15 dígitos. |
| UAPPI_CORE_INVALID_EMAIL | 400 | O e-mail informado não é valido. |
| UAPPI_CORE_INVALID_CPF | 400 | O CPF informado não está no padrão válido (quantidade de caracteres, dígito verificador, etc). |
| UAPPI_CORE_INVALID_CNPJ | 400 | O CNPJ informado não está no padrão válido (quantidade de caracteres, primeiro dígito verificador, segundo dígito verificador). |