4.1 Optimise Request Object

The JSON input to the OLM when optimising is an optimise request object. It has the following fields:

  1. id: a non-empty string giving a UUID (GUID) in canonical textual representation that uniquely identifies each invocation of the OLM by the client system. This field may be null.
  2. sites: a non-empty array of site identifiers (strings). Sites are visited in the order they are listed in this array. It is an error for this field to be null.
  3. orders: a non-empty array of order objects. It is an error for this field to be null.
  4. vehicle: a vehicle object. It is an error for this field to be null.
  5. forbidden_compartment_orders: an array of compartment-orders objects specifying any compartment and order assignments that are disallowed. This field may be null.
  6. fill_level_lower_limits: an array of fill level objects specifying minimum fill level limits for specific compartments and orders. This field may be null.
  7. fill_level_upper_limits: an array of fill level objects specifying maximum fill level limits for specific compartments and orders. This field may be null.
  8. timeLimit: an integer, giving the number of seconds after which the optimisation is cut off and the best solution found so far is returned. A value of zero or less means that there is no time limit.