Árvore de páginas

Versões comparadas

Chave

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

Este método é responsável pela criação de novos Clientes

  • Endpoint: /api/retaguarda/v2/clienteenderecos
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Este endpoint recebe uma lista de Cliente endereços para que possam ser enviados vários na mesma requisição

Aviso

Para que a baixa do Cliente endereço criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo  56 = ClienteEndereco

Expandir
titleExemplo de body da requisição

[
  {
    "idCliente": 0,
    "idClienteRetaguarda": "string",
    "descricaoTipo": "string",
    "endereco": "string",
    "numero": "string",
    "complemento": "string",
    "bairro": "string",
    "cidade": "string",
    "estado": "string",
    "cep": "string",
    "situacao": 0,
    "tipoEndereco": 0,
    "enviarPnet": 0,
    "idInquilino": "string",
    "idRetaguarda": "string",
    "idProprietario": "string",
    "loteOrigem": "string"
  }
]

Expandir
titleDefinição dos campos de requisição
idClienteRetaguardaStringIdentificador do cliente na retaguardaObrigatório
descricaoTipoStringDescrição do tipo do endereçoOpcional
enderecoStringEndereçoOpcional
numeroStringNúmero do endereçoOpcional
complementoStringComplemento do endereçoOpcional
bairroStringBairroOpcional
cidadeStringCidadeOpcional
estadoStringEstadoOpcional
cepStringCEP do endereçoOpcional
situacaoIntSituação do endereço (0 - Inativo, 1 - Ativo)Obrigatório
tipoEnderecoIntTipo endereço (Definição abaixo)Opcional
idInquilinoStringIdentificador do inquilinoOpcional
idRetaguardaStringIdentificador do endereço na retaguardaOpcional
idProprietarioStringIdentificador do proprietárioOpcional
loteOrigemStringIdentificado do lote em que serão enviados os dadosOpcional
Expandir
titleTipoEndereco
CódigoTipo
0Entrega
1Comercial
2Cobranca
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

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