Generate Demand Forecast

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

Generate a demand forecast for an outlet.

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

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.

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.apicbase.com/api/v2/demand_forecasting/outlet_id/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "sales_period": "LAST_WEEK"
8
}
9
'


xxxxxxxxxx
20
 
1
[
2
  {
3
    "recipe_id": "549390842500003",
4
    "pos_product_name": null,
5
    "total_quantity": "8",
6
    "total_revenue_without_tax": "113.21"
7
  },
8
  {
9
    "recipe_id": "949390932510004",
10
    "pos_product_name": null,
11
    "total_quantity": "10",
12
    "total_revenue_without_tax": "141.51"
13
  },
14
  {
15
    "recipe_id": "749390172500000",
16
    "pos_product_name": null,
17
    "total_quantity": "7",
18
    "total_revenue_without_tax": "99.06"
19
  }
20
]

200200

400400