Integração de cadastro de Clientes


Método responsável por realizar a integração/cadastro de clientes (locais de coleta e de entrega).

Os clientes devem ser cadastrados, visto que na integração de viagem deve ser enviado o CNPJ Cliente Origem e CNPJ Cliente Destino. As informações de origem e destino da viagem são baseadas nos dados enviados através do cadastro dos clientes.


Request


  • ENDPOINT: Cliente/Integrar
  • VERBO: POST


Índice Chave Descrição Elem. Tipo Ocor. Tam. Versão
1 CNPJAplicacao CNPJ para autenticação. E Caractere 1-1 14 1.0
2 Token Gerado a partir do CNPJ de autenticação para validar permissões de acesso. E Caractere 1-1 100 1.0
3 DocumentoUsuarioAudit Documento do usuário que está realizando a operação E Caractere 1-1 14 1.0
4 NomeUsuarioAudit Nome do usuário que está realizando a operação E Caractere 1-1 60 1.0
5 CNPJEmpresa CNPJ da empresa vinculada a este cliente. E Caractere 1-1 14 1.0
4 IdCliente Código do cliente, deve ser enviado para edição do registro E Inteiro 1-0 14 1.0
5 BACENPais Código do BACEN do país deste cliente. E Inteiro 1-1 14 1.0
6 IBGEEstado Código IBGE do estado. E Inteiro 1-1 10 1.0
7 IBGECidade Código IBGE da cidade. E Inteiro 1-1 10 1.0
8 RazaoSocial Razão social do cliente. E Caractere 1-1 100 1.0
9 NomeFantasia Nome fantasia do cliente. E Caractere 1-1 100 1.0
10 TipoPessoa Tipo de Pessoa. 1 = Física, 2 = Jurídica E Inteiro 1-1 10 1.0
11 CNPJCPF CPF ou CNPJ E Caractere 1-1 14 1.0
12 RG Registro Geral / Numero do Documento de Identidade E Caractere 1-0 100 1.0
13 OrgaoExpedidorRG Órgão Expedidor E Caractere 1-0 5 1.0
14 IE Inscrição Estadual E Numerico 1-0 15 1.0
15 Celular Número de celular, apenas números E Caractere 1-0 10 1.0
16 Email E-mail E Caractere 1-0 100 1.0
17 CEP CEP do Cliente E Caractere 1-1 10 1.0
18 Endereco Endereço E Caractere 1-1 100 1.0
19 Complemento Complemento E Caractere 1-0 100 1.0
20 Numero Número E Inteiro 1-0 10 1.0
21 Bairro Bairro E Caractere 1-1 100 1.0


Modelo de Json - Request


{
  "CNPJAplicacao": "",
  "Token": "",
  "DocumentoUsuarioAudit": "",
  "NomeUsuarioAudit": "",
  "CNPJEmpresa": "",
  "BACENPais": 0,
  "IBGEEstado": 0,
  "IBGECidade": 0,
  "RazaoSocial": "",
  "NomeFantasia": "",
  "TipoPessoa": ,
  "CNPJCPF": "",
  "RG": "",
  "OrgaoExpedidorRG": "",
  "IE": "",
  "Celular": "",
  "Email": "",
  "CEP": "",
  "Endereco": "",
  "Complemento": "",
  "Numero": "",
  "Bairro": ""
}


Response


Índice Chave Descrição Elem. Tipo Ocor. Tam. Versão
1 Sucesso Requisição realizada com sucesso ou não E Booleano 1-1 True/False 1.0
2 Mensagem Mensagem de retorno E Caractere 1-1 100 1.0
3 Objeto Elemento pai que contém as informações da filial G 0-1
3.1 IdCliente Código do rogistro do cliente integrado E Inteiro 1-1 10 1.0
3.2 IdEmpresa Código do cliente, deve ser enviado para edição do registro E Inteiro 1-1 10 1.0
3.3 RazaoSocial Razão social do cliente. E Caractere 1-1 100 1.0
3.4 NomeFantasia Nome fantasia do cliente. E Caractere 1-1 100 1.0
3.5 TipoPessoa Tipo de Pessoa. 1 = Física, 2 = Jurídica E Inteiro 1-1 1 1.0
3.6 CNPJCPF CPF ou CNPJ E Caractere 1-1 14 1.0
3.7 RG Registro Geral / Numero do Documento de Identidade E Caractere 0-1 100 1.0
3.8 OrgaoExpedidorRG Órgão Expedidor E Caractere 0-1 5 1.0
3.9 IE Inscrição Estadual E Numerico 0-1 15 1.0
3.10 Celular Número de celular E Inteiro 0-1 0 1.0
3.11 Email E-mail E Caractere 0-1 100 1.0
3.12 CEP CEP do Cliente E Caractere 1-1 10 1.0
3.13 Endereco Endereço E Caractere 1-1 100 1.0
3.14 Complemento Complemento E Caractere 0-1 100 1.0
3.15 Numero Número E Inteiro 0-1 10 1.0
3.16 Bairro Bairro E Caractere 1-1 100 1.0
3.17 IdPais Código do pais do endereço E Inteiro 1-1 10 1.0
3.18 IdEstado Código do estado do endereço E Inteiro 1-1 10 1.0
3.19 IdCidade Código da cidade do endereço E Inteiro 1-1 10 1.0
3.20 Ativo Registro ativado ou desativado E Booleano 1-1 True/False 1.0
3.21 ClienteEnderecos Elemento pai array que contêm o endereço do cliente G 1-1
3.21.1 BACENPais Código do BACEN do país deste cliente. E Inteiro 1-1 10 1.0
3.21.2 IBGEEstado Código IBGE do estado. E Inteiro 1-1 10 1.0
3.21.3 IBGECidade Código IBGE da cidade. E Inteiro 1-1 10 1.0
3.21.4 CEP CEP do Cliente E Caractere 1-1 10 1.0
3.21.5 Endereco Endereço E Caractere 1-1 100 1.0
3.21.6 Complemento Complemento E Caractere 0-1 100 1.0
3.21.7 Numero Número E Inteiro 0-1 10 1.0
3.21.8 Bairro Bairro E Caractere 0-1 100 1.0


Modelo de Json - Response


{
  "Sucesso": true,
  "Mensagem": null,
  "Objeto": {
    "IdCliente": 0,
    "IdEmpresa": 0,
    "RazaoSocial": "",
    "NomeFantasia": "",
    "TipoPessoa": ,
    "CNPJCPF": "",
    "RG": "",
    "OrgaoExpedidorRG": "",
    "IE": "",
    "Celular": "",
    "Email": "",
    "CEP": "",
    "Endereco": "",
    "Complemento": null,
    "Numero": "",
    "Bairro": "",
    "IdPais": 0,
    "IdEstado": 0,
    "IdCidade": 0,
    "Ativo": true,
    "ClienteEnderecos": [
      {
        "BACENPais": 0,
        "IBGEEstado": 0,
        "IBGECidade": 0,
        "CEP": "",
        "Endereco": "",
        "Complemento": "",
        "Numero": 0,
        "Bairro": ""
      }
    ]
  }
}