Listar orçamentos
https://carchost.fieldcontrol.com.br/quotationsLista os orçamentos da conta, com os itens, com paginação e filtros. A listagem é ordenada pelo identificador.
Requer os headers
X-Api-KeyeUser-Agent. Limite: 1 requisição por segundo (saiba mais).
Requisição
Parâmetros de consulta
limitintegerQuantidade de itens por página.
De 1 a 100.Padrão: 10.
offsetintegerQuantidade de itens a pular.
De 0 a 200000.Padrão: 0.
qstringFiltros no formato campo:valor, separados por espaço (como filtrar). Os filtros aceitos estão na tabela abaixo.
Exemplo: status:pending customerId:NTc4NTQ1OjIyOTE1.
| Filtro | O que faz |
|---|---|
name | Parte do nome, sem diferenciar maiúsculas e minúsculas. |
identifier | Parte do número, sem diferenciar maiúsculas e minúsculas. |
status |
|
archived |
|
createdBy | Parte do nome de quem criou. |
customerId | Identificador do cliente. |
locationId | Identificador da localização. |
createdAt>= | Criados a partir da data informada, inclusive. |
createdAt<= | Criados até a data informada, inclusive. |
Headers
User-AgentstringobrigatórioIdentificação da sua aplicação.
Exemplo: MinhaIntegracao/1.0.
Respostas
- 200
Lista de orçamentos.
- 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
Filtro ou paginação inválidos (parametersValidationErr).
- 429
Limite de 1 requisição por segundo excedido. Ver Limite de requisições.
- 500
Erro inesperado no servidor.