---
title: "getHourlySalesForecast"
method: GET
path: "/salesforecast/v1/hourly/getSalesForecast"
tags: ["Sales Forecast Service"]
---

# getHourlySalesForecast

`GET /salesforecast/v1/hourly/getSalesForecast`

Retrieves an hourly sales forecast.

## Query parameters

- `locationCode` string, required
- `weekEndingDate` string, required
- `includeNull` boolean

## Headers

- `authenticationtoken` string, required
- `password` string, required
- `sitename` string, required
- `userid` string, required
- `X-B3-TraceId` string

## Response `200`

Success

- SalesForecastDto[]
  - `checks` number — "checks" from salesforecast
  - `guests` number — "guests" from salesforecast
  - `revenueCenterCode` string, required — "revenueCenterCode" from salesforecast
  - `sales` number — "sales" from salesforecast
  - `startTime` string, required — "startTime" from salesforecast

## Other responses

- `400` — Validation Error
- `401` — Authorization
- `404` — sales forecast not found
- `429` — Too Many Requests
- `500` — Unexpected Error
- `503` — System under maintenance
- `504` — Timeout

---

[API](https://skmtc.net/crunchtime/apis/inventory-labor.md) · [All operations](https://skmtc.net/crunchtime/apis/inventory-labor/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crunchtime/inventory-labor/revisions/0af8e380ff2c/schema)