| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retorno |
|
|
| | Expandir |
|---|
| title | 200 - OkCampo | 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 |
|
|
|
|
|---|
expand | title | | 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 |
| Section |
|---|
| Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | 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 |
| Section |
|---|
| Column |
|---|
| Exemplo de body de retorno{
"success": false,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | 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 |
|
|
|
|
|
|
|
| Card |
|---|
| | Informações |
|---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
Requisição| Section |
|---|
| Column |
|---|
| Exemplo de body da requisição[
{
"bairro": "string",
"cep": "string",
"cidade": "string",
"complemento": "string",
"descricaoTipo": "string",
"endereco": "string",
"enviarPnet": 0,
"estado": "string",
"idCliente": 0,
"idClienteRetaguarda": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"numero": "string",
"situacao": 0,
"tipoEndereco": 0
}
] |
| Column |
|---|
| Definições dos campos do body| Campo | Tipo | Descrição | Obrigatório | Observações |
|---|
| idClienteRetaguarda | String | Identificador do cliente na retaguarda | Sim |
| | descricaoTipo | String | Descrição do tipo do endereço | Não |
| | endereco | String | Endereço | Não | Tamanho máximo: 150 caracteres | | numero | String | Número do endereço | Não | Tamanho máximo: 15 caracteres | | complemento | String | Complemento do endereço | Não | Tamanho máximo: 50 caracteres | | bairro | String | Bairro | Não | Tamanho máximo: 100 caracteres | | cidade | String | Cidade | Não | Tamanho máximo: 100 caracteres | | estado | String | Estado | Não | Tamanho máximo: 30 caracteres | | cep | String | CEP do endereço | Não | Tamanho máximo: 10 caracteres | | situacao | Int | Situação do endereço | Sim | 0 - Inativo, 1 - Ativo | | tipoEndereco | Int | Tipo endereço. | Não | | Código | Tipo |
|---|
| 0 | Entrega | | 1 | Comercial | | 2 | Cobranca |
| | idInquilino | String | Identificador do inquilino | Sim |
| | idRetaguarda | String | Identificador do endereço na retaguarda | Sim |
| | idProprietario | String | Identificador do proprietário | Sim |
| | loteOrigem | String | Identificado do lote em que serão enviados os dados | Sim |
| | enviapnet | Int | Identifica se esse endereço vai ser enviado do PDV para a retaguarda | Não |
| | idCliente | Int | Identificador do cliente no PDV | Não |
|
|
|
Retornos| Deck of Cards |
|---|
| | Card |
|---|
| | Expandir |
|---|
| title | Body de retorno{
"success": falsetrue,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
|---|
| Column |
|---|
| Definições dos campos do retornoCampo | 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 |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | 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 |
|
|
|
|
|
