Atualizar localização do cliente

PUThttps://carchost.fieldcontrol.com.br/customers/{customerId}/locations/{locationId}

Atualiza uma localização do cliente. A localização primária não pode ser arquivada nem trocar de cliente.

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

Requisição

Parâmetros de caminho

customerIdstringobrigatório

Identificador do cliente.

locationIdstringobrigatório

Identificador da localizaçã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 da localização.

notesstring

Observações da localização.

Aceita: null.

archivedboolean

Arquiva a localização. A localização primária não pode ser arquivada.

addressobjectobrigatório

Campos de address

postalCodestring

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

Aceita: null.

streetstring

Aceita: null.

numberstring

Aceita: null.

neighborhoodstring

Aceita: null.

citystringobrigatório

statestringobrigatório

complementstring

Aceita: null.

coordsobjectobrigatório

Campos de coords

latitudenumberobrigatório

De -90 a 90.

longitudenumberobrigatório

De -180 a 180.

Respostas

• 200

  Localização atualizada.

• 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.

• 404

  Recurso não encontrado. O corpo da resposta é vazio.

• 422

  Localização inválida, ou regra de localização primária violada (cannotArchivePrimaryLocation, cannotChangeCustomerOfPrimaryLocation).

  cannotArchivePrimaryLocation →
• 429

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

• 500

  Erro inesperado no servidor.