Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleDefinição dos campos de requisição
CampoTipoDescriçãoObservaçõesObrigatório
idClienteRetaguardaStringIdentificador do cliente na retaguarda
Sim
descricaoTipoStringDescrição do tipo do endereço
Não
enderecoStringEndereçoTamanho máximo: 150 caracteresNão
numeroStringNúmero do endereçoTamanho máximo: 15 caracteresNão
complementoStringComplemento do endereçoTamanho máximo: 50 caracteresNão
bairroStringBairroTamanho máximo: 100 caracteresNão
cidadeStringCidadeTamanho máximo: 100 caracteresNão
estadoStringEstadoTamanho máximo: 30 caracteresNão
cepStringCEP do endereçoTamanho máximo: 10 caracteresNão
situacaoIntSituação do endereço 0 - Inativo, 1 - AtivoSim
tipoEnderecoIntTipo endereço.
CódigoTipo
0Entrega
1Comercial
2Cobranca
Não
idInquilinoStringIdentificador do inquilino
Sim
idRetaguardaStringIdentificador do endereço na retaguarda
Sim
idProprietarioStringIdentificador do proprietário
Sim
loteOrigemStringIdentificado do lote em que serão enviados os dados
Sim
enviapnetIntIdentifica se esse endereço vai ser enviado do PDV para a retaguarda
Não
idClienteIntIdentificador do cliente no PDV
Não



Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Expandir
title400 - Bad Request
Aviso

Devido a arquitetura implentada temos dois retornos de erros que foram padronizados na versão três deste endpoint

Deck of Cards
idclienteBadRequest
Card
labelCaso 1
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

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro
Card
labelCaso 2
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

SuccessboolIndica se a criação do cliente foi feita com sucesso
MessagestringMessagem com os erros
DataobjetoObjeto cliente
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Expandir
titleBody de retorno

{
    "success": false,
    "message": "",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

...