Needs

This section contains a detailed technical explanation of all the endpoints necessary to manage the information related to needs through the API.

Considerations

The needs summary refers to the number of employees required to complete each task and includes the following information:

  • location. The name of the task.

  • locationId. The identifier of the task.

  • locationType. Type of task, whether fixed, variable or non-plannable (FIXED, VARIABLE, NON_PLANIFIABLE).

  • product. The external identifier of the product or section.

  • service. The external identifier of the service or store.

  • zone. The external identifier of zone.

  • timeSlots. Time intervals indicating when and for how long employees are needed to perform the task. Each time slot has a duration of 15 minutes and includes the following information:

    • from. Start time of the interval in UTC.

    • to. End time of the interval in UTC.

    • applied. The number of employees initially set to cover the task, e.g., if a different need proposal was applied than the reference proposal of the business.

    • real. The number of employees that will actually be used for the task. This is the final value considered by the engine.

    • reference. The number of employees suggested by the business’s reference proposal.