Pular para o conteúdo principal

Criar um cliente

POSThttps://carchost.fieldcontrol.com.br/customers

Cria um cliente. A API também cria a localização primária do cliente a partir do endereço enviado.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

namestringobrigatório

Nome do cliente. Textos com mais de 120 caracteres são truncados.

Mínimo de 5 caracteres.

codestring

Código do cliente.

Até 50 caracteres.Aceita: null.

notesstring

Observações do cliente.

Até 2000 caracteres.Aceita: null.

documentNumberstring

CPF ou CNPJ válido, somente números (sem pontos, traços ou barras). Deve ser único na conta.

Aceita: null.

externalobject
Campos de external
idstring

Identificador do cliente no seu sistema.

Até 100 caracteres.Aceita: null.

archivedboolean

Indica se o cliente está arquivado.

Padrão: false.

addressobjectobrigatório

Endereço do cliente. Também é usado para criar a localização primária.

Campos de address
zipCodestring

CEP com 8 dígitos, somente números.

Aceita: null.

streetstring

Logradouro. Textos com mais de 50 caracteres são truncados.

Aceita: null.

numberstring

Número. Textos com mais de 10 caracteres são truncados.

Aceita: null.

neighborhoodstring

Bairro. Textos com mais de 50 caracteres são truncados.

Aceita: null.

complementstring

Complemento. Textos com mais de 50 caracteres são truncados.

Aceita: null.

citystringobrigatório

Cidade. Textos com mais de 50 caracteres são truncados.

statestringobrigatório

Estado. Textos com mais de 30 caracteres são truncados.

coordsobjectobrigatório

Coordenadas do endereço. Sem geolocalização? Veja o guia Serviços de geolocalização.

Campos de coords
latitudenumberobrigatório

De -90 a 90.

longitudenumberobrigatório

De -180 a 180.

Respostas

  • 201

    Cliente criado.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 422

    Corpo inválido ou documentNumber já cadastrado em outro cliente da conta (reason: document number already exists).

    resourceValidationErr →
  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.