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

# getHourlySalesForecastByPage

`GET /salesforecast/v1/hourly/getSalesForecastByPage`

## Request

- Base URL: `//webservices-test.net-chef.com` (relative, and the document’s source URL is not known)
- URL: `//webservices-test.net-chef.com/salesforecast/v1/hourly/getSalesForecastByPage`
- Auth: none declared. Required headers: `authenticationtoken`, `password`, `sitename`, `userid`

Retrieves an hourly sales forecast by `pageNumber`. 
 Use to retrieve data in smaller chunks.

## Query parameters

- `endDate` string, required
- `locationCode` string
- `Retrieve one or more records by `pageNumber`.
Use to retrieve data in smaller chunks.
If left blank, the default is 1.` integer
- `startDate` string, required
- `includeNull` boolean

## Headers

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

## Response `200`

Success

- SalesForecastBatchResponseDto: List of forecasts grouped by locations divided into pages
  - `hasNext` boolean
  - `locationsForecast` SalesForecastDetails[]
    - `forecasts` 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
    - `locationCode` string, required: "locationCode" from salesforecast
  - `totalPages` integer

## 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.dev/crunchtime/apis/inventory-labor.md) - [All operations](https://skmtc.dev/crunchtime/apis/inventory-labor/llms.txt) - [OpenAPI document](https://skmtc.dev/crunchtime/apis/inventory-labor/revisions/fff247a87cc9?raw)