Sign in

v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Sales Forecast Service

getHourlySalesForecast

Retrieves an hourly sales forecast.

get/salesforecast/v1/hourly/getSalesForecast

Query parameters

locationCodestring required

The Code that identifies the Location in Crunchtime.

weekEndingDatestring required

Week ending 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

checksnumber

"checks" from salesforecast

guestsnumber

"guests" from salesforecast

revenueCenterCodestring required

"revenueCenterCode" from salesforecast

salesnumber

"sales" from salesforecast

startTimestring required

"startTime" from salesforecast

Example response

[
  {
    "checks": 14,
    "guests": 13,
    "revenueCenterCode": "BS002",
    "sales": 12,
    "startTime": "12:00 09/02/2024"
  }
]