4.3 Order Object

An order is described by an object with the following fields:

  1. id: a string giving the unique identifier for this order.
  2. tags: an array of strings, giving client-specific information about this order. This field is not used by the optimiser. It may be null or empty.
  3. product: a string giving the identifier for the product being delivered.
  4. density: a number giving the relative density of the product in kg∕L. Must be nonnegative.
  5. minimum_compartment_volume: a number giving the minimum volume that must be loaded into each compartment that is assigned to this order.
  6. target_volume: a number giving the target volume to be delivered for this order; must be greater than zero.
  7. maximum_volume: a number giving the maximum volume that can be delivered for this order; must be greater than target_volume.
  8. site: a string giving the identifier of the site to which this order must be delivered.
  9. required: A Boolean, if true, then this order is required.