...
- Endpoint: /api/retaguarda/v2/clienteenderecos
- Versão: 2
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de Cliente endereço]s endereços para que possam ser enviados vários na mesma requisição
...
Expandir |
---|
|
Código | Tipo |
---|
0 | Entrega | 1 | Comercial | 2 | Cobranca |
|
Expandir |
---|
title | Definição dos campos de retorno |
---|
|
Expandir |
---|
| Campo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | Data | objeto | Objeto compartilhamento criado | Errors | Lista | Listas com os erros encontrados no processo | TotalTime | int | tempo da requisição | NumberOfRecords | int | número de dados inseridos |
|
Expandir |
---|
| Aviso |
---|
Devido a arquitetura implentada temos dois retornos de erros que foram padronizados na versão três deste endpoint |
Deck of Cards |
---|
| Card |
---|
| Informações |
---|
Este retorno ocorre quando um campo enviado não passa pela validação, por exemplo, não enviar um dado obrigatório |
Campo | Tipo | Descrição |
---|
code | string | Código de erro | message | string | Mensagem do erro | detailedMessage | string | Detalhamento do erro | helpUrl | string | url de ajuda | TotalTime | string | Tempo total de busca | details | lista de objeto | Lista de objeto de erros | details.guid | string | Identificador do erro | details.code | string | Código do erro | details.message | string | Mensagem do erro | details.detailedMessage | string | Detalhamento do erro |
|
Card |
---|
| Informações |
---|
Este retorno ocorre quando algo na aplicação não ocorreu da forma esperada, por exemplo, quando uma excessão é lançada pela aplicação |
Campo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do cliente foi feita com sucesso | Message | string | Messagem com os erros | Data | objeto | Objeto cliente | Errors | Lista | Listas com os erros encontrados no processo | TotalTime | int | tempo da requisição | NumberOfRecords | int | número de dados inseridos |
Expandir |
---|
| { "success": false, "message": "", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
|
|
|
|