---
updatedAt: 2026-06-12T14:08:37.000Z
agentTools:
  projectIndex: https://developer.crunchtime.com/llms.txt
---

# get15MinutesSalesForecastByPage

Retrieves a 15 minute sales forecast by `pageNumber`. 
 Use to retrieve data in smaller chunks.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger documentation supporting mobile development of Crunchtime.",
    "version": "2.99",
    "title": "Inventory & Labor",
    "termsOfService": "http://springfox.io",
    "contact": {
      "name": "Crunchtime Development Team",
      "url": "http://www.crunchtime.com",
      "email": "apiquestions@crunchtime.com"
    },
    "license": {
      "name": "Apache License Version 2.0",
      "url": "https://github.com/springfox/springfox/blob/master/LICENSE"
    }
  },
  "tags": [
    {
      "name": "Sales Forecast Service",
      "description": "The Sales Forecasts Service can be used to ensure that Sales Forecasting data aligns between Crunchtime and other systems. You can use the service to get Forecast data that has been systematically calculated based on a Location's Suggested Order configuration or post a Sales Forecast, overriding the systemcalculated value."
    }
  ],
  "paths": {
    "/salesforecast/v1/15-minutes/getSalesForecastByPage": {
      "get": {
        "tags": [
          "Sales Forecast Service"
        ],
        "summary": "get15MinutesSalesForecastByPage",
        "description": "Retrieves a 15 minute sales forecast by `pageNumber`. \n Use to retrieve data in smaller chunks.",
        "operationId": "get15MinutesSalesForecastByPageV1UsingGET",
        "parameters": [
          {
            "name": "authenticationtoken",
            "in": "header",
            "description": "Secure token for API authentication.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "endDate",
            "in": "query",
            "description": "End date of forecast to retrieve in format dd-MMM-yy.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "locationCode",
            "in": "query",
            "description": "The Code that identifies the Location in Crunchtime.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageNumber",
            "in": "query",
            "description": "Retrieve one or more records by `pageNumber`.\nUse to retrieve data in smaller chunks.\nIf left blank, the default is 1.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "password",
            "in": "header",
            "description": "Password for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sitename",
            "in": "header",
            "description": "Crunchtime site identifier. (test or production)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "description": "Start date of forecast to retrieve in format dd-MMM-yy.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userid",
            "in": "header",
            "description": "User ID for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-B3-TraceId",
            "in": "header",
            "description": "Optional trace identifier for troubleshooting.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeNull",
            "in": "query",
            "description": "Specify 'true' to output null data elements.",
            "required": false,
            "allowEmptyValue": true,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/SalesForecastBatchResponseDto"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalesForecastBatchResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "401": {
            "description": "Authorization",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "sales forecast not found",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "503": {
            "description": "System under maintenance",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "504": {
            "description": "Timeout",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "externalDocs": {
    "description": "Crunchtime Developer Hub",
    "url": "https://developer.crunchtime.com/"
  },
  "servers": [
    {
      "url": "//webservices-test.net-chef.com"
    }
  ],
  "components": {
    "schemas": {
      "SalesForecastBatchResponseDto": {
        "type": "object",
        "properties": {
          "hasNext": {
            "type": "boolean"
          },
          "locationsForecast": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SalesForecastDetails"
            }
          },
          "totalPages": {
            "type": "integer",
            "format": "int32"
          }
        },
        "title": "SalesForecastBatchResponseDto",
        "description": "List of forecasts grouped by locations divided into pages"
      },
      "SalesForecastDetails": {
        "type": "object",
        "required": [
          "locationCode"
        ],
        "properties": {
          "forecasts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SalesForecastDto"
            }
          },
          "locationCode": {
            "type": "string",
            "example": 120012,
            "description": "\"locationCode\" from salesforecast"
          }
        },
        "title": "SalesForecastDetails",
        "description": "Contains forecasts for multiple periods for a single location"
      },
      "SalesForecastDto": {
        "type": "object",
        "required": [
          "revenueCenterCode",
          "startTime"
        ],
        "properties": {
          "checks": {
            "type": "number",
            "example": 14,
            "description": "\"checks\" from salesforecast"
          },
          "guests": {
            "type": "number",
            "example": 13,
            "description": "\"guests\" from salesforecast"
          },
          "revenueCenterCode": {
            "type": "string",
            "example": "BS002",
            "description": "\"revenueCenterCode\" from salesforecast"
          },
          "sales": {
            "type": "number",
            "example": 12,
            "description": "\"sales\" from salesforecast"
          },
          "startTime": {
            "type": "string",
            "example": "12:00 09/02/2024",
            "description": "\"startTime\" from salesforecast"
          }
        },
        "title": "SalesForecastDto",
        "description": "Representation of single period sales, guests and checks forecast in a revenue center"
      }
    }
  }
}
```