Listar localizações do cliente

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

Lista as localizações de um cliente.

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

Requisição

Parâmetros de caminho

customerIdstringobrigatório

Identificador do cliente.

Parâmetros de consulta

limitinteger

Quantidade de itens por página.

De 1 a 100.Padrão: 10.

offsetinteger

Quantidade de itens a pular.

De 0 a 200000.Padrão: 0.

qstring

Filtros no formato campo:valor, separados por espaço (como filtrar). Os filtros aceitos estão na tabela abaixo.

Exemplo: archived:false.

Filtro	O que faz
name	Nome da localização, exatamente igual ao cadastrado.
archived	true para arquivadas, false para ativas.
created_at	Data de criação igual à informada (ISO 8601, UTC).
created_at>=	Criados a partir da data informada, inclusive.
created_at<=	Criados até a data informada, inclusive.
created_at>	Criados depois da data informada.
created_at<	Criados antes da data informada.

sortstring

Ordenação.

Valores aceitos: id, created_at, -created_at.Padrão: id.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Respostas

• 200

  Lista de localizações.

• 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

  Identificador no path inválido ou de outra conta (uriValidationErr), ou parâmetro de query inválido (parametersValidationErr). Um identificador válido que não existe retorna 404.

• 429

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

• 500

  Erro inesperado no servidor.