Generate Demand Forecast

post

https://api.apicbase.com/api/v2/demand_forecasting/{outlet_id}/

Generate a demand forecast for an outlet.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

outlet_id

string

required

An outlet's ID.

Body Params

forecast_from

date

required

The date from which the forecast should be generated. It should be in the format YYYY-MM-DD. It can be any date but you may want to use future dates. It should be lower than the forecast_to date.

forecast_to

date

required

The date to which the forecast should be generated. It should be in the format YYYY-MM-DD. It can be any date but you may want to use future dates. It should be higher than the forecast_from date.

sales_period

string

enum

required

The sales period that should be considered for the forecast. If LAST_WEEK is selected, the forecast will be generated based on the sales of the last week. If LAST_4_WEEKS is selected, the forecast will be generated based on the sales of the last 4 weeks. If YEAR_AGO is selected, the forecast will be generated based on the sales of the same period last year.So if the forecast_from date is 2025-01-01 and the forecast_to date is 2025-01-31, the sales of 2024-01-01 to 2024-01-31 will be considered.

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

404404