This operation creates (imports) labor forecasts and replaces the deprecated Import Labor Forecasts (POST /v1/forecasting/labor_forecast/import
) API operation. This operation imports Labor Forecasts of type ADJUSTED. To generate a Labor Forecast of type EARNED, run the Earned Hours Engine.
Note: This operation allows a request payload size of 5 megabytes, supports HTTP status code 207 Partial Success responses, and requires the number of jobs multiplied by the number of days to be less than 5000.
The associated Access Control Point is WFF_LABOR_FORECAST.
Service limit
A service limit constrains the number of days multiplied by the number of jobs that can be processed in a single request.
- The Number of Days multiplied by the Number of Jobs cannot exceed 5,000.
Refer to the Limits topic for more information.
Best Practices
We recommend batching requests by passing jobs that belong to the same stores. Adjust the date range based on payload size and the service limit defined above.
For the best performance:
- import 1000 jobs per week or 166 jobs per month
Note: You will experience poor performance if you create multiple calls per store for the same timeframe, each call importing only part of the jobs for that store.