List movements
https://carchost.fieldcontrol.com.br/storages-movements-v2Lists the account's inventory movements (entries and removals), with pagination, filters and sorting. A transfer appears as one removal and one entry. Requires the inventory control module.
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: storage_id:MWY5ZGE5YzgtZDY3MC00NWJhLTk0MGUtNzQxYjk3ODI0MzllOjIyOTE1 type:entry.
| Filter | What it does |
|---|---|
storage_id | Storage identifier. |
product_id | Product identifier. |
order_id | Work order identifier. |
type |
|
created_at | Date equal to the given date (ISO 8601, UTC). |
created_at>= | Given on or after the given date. |
created_at<= | Given on or before the given date. |
created_at> | Given after the given date. |
created_at< | Given before the given date. |
sortstringSorting. The - prefix reverses the order.
Accepted values: id, created_at, -created_at.Default: id.
Headers
User-AgentstringrequiredIdentification of your application.
Example: MinhaIntegracao/1.0.
Responses
- 200
List of movements.
- 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, pagination or sorting (parametersValidationErr). Account without the inventory control module: resourceNotAllowed.
- 429
Limit of 1 request per second exceeded. See Rate limit.
- 500
Unexpected server error.