Sales Forecast Service
get15MinutesSalesForecastByPage
Retrieves a 15 minute sales forecast by pageNumber. Use to retrieve data in smaller chunks.
get/salesforecast/v1/15-minutes/getSalesForecastByPage
Query parameters
endDatestring required
End date of forecast to retrieve in format dd-MMM-yy.
locationCodestring
The Code that identifies the Location in Crunchtime.
pageNumberinteger
Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.
startDatestring required
Start date of forecast to retrieve in format dd-MMM-yy.
includeNullboolean
Specify 'true' to output null data elements.
Headers
authenticationtokenstring required
Secure token for API authentication.
passwordstring required
Password for the Crunchtime Application User.
sitenamestring required
Crunchtime site identifier. (test or production)
useridstring required
User ID for the Crunchtime Application User.
X-B3-TraceIdstring
Optional trace identifier for troubleshooting.
Response
Success
Example response
{
"locationsForecast": [
{
"forecasts": [
{
"checks": 14,
"guests": 13,
"revenueCenterCode": "BS002",
"sales": 12,
"startTime": "12:00 09/02/2024"
}
]
}
]
}