📘

Projection Types

You can manually override sales projections used by 7shifts Optimal Labor Tool or Labor Budget Tool. It is recommended to provide the smallest projection timeframe available (up to 15 minutes). Reference the Override Sales Projections guide for additional details.

Interval projections can be passed in either 15 minute or hourly intervals. 7shifts uses these projections in the Optimal Labor Tool and Labor Budget Tool calculations.

Daily projections are passed in daily and are used in the Labor Budget Tool only.

NOTE: The payloads differ between each projection. Please see notes below.

Interval Projections

Please ensure that each object in the request body array is referring to one 15-minute interval or one 1-hour interval for which you wish to update the sales projection. 7shifts spreads the projection out for each interval over its span.

7shifts considers the end of the business day at 5 AM local time to the location. Thus, any projections edits that are made between 12 AM - 4:59 AM for any day will be considered in the total for the previous day. All times on are in UTC.

Parameter

Type

Required

Description

location_id

Integer

Yes

ID of the location you want to update the sales projection for

Get this from /v1/locations if needed

start

DateTime

Yes

Starting date/time (UTC) of the interval for which you wish to update the sales projection.

"YYYY-MM-DD hh:mm:ss"

end

DateTime

Yes

value

Float

Yes

Value of projected sales in dollars

change_type

String

Yes

Always set this to "new_value"

change_note

String

Yes

Always set this to "" (an empty string)

Sample body parameter for 15-min interval sales projections.

{
    "projected_sales_edits": [
        {
            "location_id": 25691,
            "start": "2021-11-03 13:00:00",
            "end": "2021-11-03 13:15:00",
            "value": 350.50,
            "change_type": "new_value",
            "change_note": ""
        },
        {
            "location_id": 25691,
            "start": "2021-11-03 13:15:00",
            "end": "2021-11-03 13:30:00",
            "value": 400,
            "change_type": "new_value",
            "change_note": ""
        }
    ]
}

Daily Projections

Daily projections are posted per location per day.

Parameter

Type

Required

Description

location_id

Integer

Yes

ID of the location you want to update the sales projection for

Get this from /v1/locations if needed

date

Date

Yes

The date/time (UTC) of sales projection

"YYYY-MM-DD"

projected

Float

Yes

Value of projected sales in dollars

Sample body parameter for daily sales projection.

{
      "location_id": 25691,
      "date": "2021-11-04",
      "projected": 2042
}
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!