This page was automatically generated from tracezilla’s Swagger API documentation 2026-09-15
GET /forecasting-records
Get list of forecasting records
Description
Returns forecasting records
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| sortBy | optional | Field to sort by. Without sort specified it will sort first by ref and then name. | movement_date, created_at, updated_at |
| sortDirection | optional | Direction of sort. | asc, desc |
| perPage | optional | Results to show per page. | |
| sku[eq] | optional | Search for forecast records based on SKU id. Allowed expression(s): eq, in | |
| sku_code[eq] | optional | Search for forecast records based on SKU code. Allowed expression(s): eq, in | |
| customer[eq] | optional | Search for forecasts based on customer id. Allowed expression(s): eq, in | |
| customer_ref[eq] | optional | Search for forecasts based on customer reference code. Allowed expression(s): eq, in | |
| scenario[eq] | optional | Search for forecasts based on scenario ID. Allowed expression(s): eq, in | |
| scenario_ref[eq] | optional | Search for forecasts based on scenario reference code. Allowed expression(s): eq, in | |
| movement_date[gte] | optional | Search for forecasts based on movement date. Allowed expression(s): eq, in, lte, lt, gte, gt | |
| qty_sold[gt] | optional | Search for forecast records based on expected sales quantity. Allowed expression(s): lte, lt, gte, gt | |
| qty_supplied[gt] | optional | Search for forecast records based on expected supplied quantity. Allowed expression(s): lte, lt, gte, gt | |
| qty_consumed[gt] | optional | Search for forecast records based on expected consumed quantity. Allowed expression(s): lte, lt, gte, gt | |
| qty_expired[gte] | optional | Search for forecast records based on expected expired quantity. Allowed expression(s): lte, lt, gte, gt | |
| include | optional | The resources that can be included in this request, delimited by a comma: sku, customer, scenario |
Responses
200
successful operation
406
not acceptable
500
internal server error