List quotations
https://carchost.fieldcontrol.com.br/quotationsLists the account's quotations, with their items, with pagination and filters. The list is sorted by identifier.
Requires the
X-Api-KeyandUser-Agentheaders. Limit: 1 request per second (learn more).
Request
Query parameters
limitintegerNumber of items per page.
From 1 to 100.Default: 10.
offsetintegerNumber of items to skip.
From 0 to 200000.Default: 0.
qstringFilters in the field:value format, separated by spaces (how to filter). The accepted filters are in the table below.
Example: status:pending customerId:NTc4NTQ1OjIyOTE1.
| Filter | What it does |
|---|---|
name | Part of the name, case-insensitive. |
identifier | Part of the number, case-insensitive. |
status |
|
archived |
|
createdBy | Part of the creator's name. |
customerId | Customer identifier. |
locationId | Location identifier. |
createdAt>= | Created on or after the given date. |
createdAt<= | Created on or before the given date. |
Headers
User-AgentstringrequiredIdentification of your application.
Example: MinhaIntegracao/1.0.
Responses
- 200
List of quotations.
- 401
API key missing (
Missing API Key) or invalid (Invalid API Key). See Authentication. - 403
Account blocked (
Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication. - 422
Invalid filter or pagination (parametersValidationErr).
- 429
Limit of 1 request per second exceeded. See Rate limit.
- 500
Unexpected server error.