Skip to main content

Operations location group model

The model is used to define tags for operations zones that can be used to match vehicles to bookings without setting geofences.

codestringrequired

Code or consumer identifier of the location group

geofencestring,null<uri-reference>nullable

Reference to a geofence if any associated to this group

projectstring<uri-reference>required

Project this group belongs to.

calculation_params object

Calculation pramaters that should be used for calculation in case of thie operations locaions that belong to this area is used. Operations location settings will override this setting if explicitely set for the location.

enter_time object

If the location belongs to a compound zone (fixed time is required to enter the zone where the location is based), fixed field will represent second required to enter the zone. This is converted into compound zone in the Optimization API.

fixedinteger

Fixed component of the service time at the location (or time required to pass the gates to get to the location)

exit_time object

If the location belongs to a compound zone (a fixed time is required to exit the zone where the location is based), the fixed field will represent the seconds required to exit the zone. This is converted into a compound zone in the Optimization API.

fixedinteger

Fixed component of the service time at the location (or the time required to pass the gates to get to the location).

service_time object

Per order service time managemenet for orders being dropped off at this location. It is calculated the total order service time for a given location, considering both a fixed service time and dynamic adjustments based on product kind and booking demand. It uses predefined coefficients to weigh different demand types. The final service time is returned as an integer, rounded up to the nearest whole number.

fixedinteger

Fixed per order service time for this location in seconds

coefficients object

Coefficients for dynamic service time calculation with the result in seconds. For example:

{  
  "coefficients": {
    "AMBIENT": {
      "cbcm": 0.000018
    }
  },
  "service_time": {
    "fixed": 10
  }
}

where AMBIENT should match the booking.product_kind field.

property name*object
cumulative_limitations object

Dispatch per hour limitation for this location when used as pickup location.

depot_service_timeinteger

Service time for one vehicle at this location in seconds.

max_cumulative_vehiclesinteger

Maximum number of vehicles that can be serviced at this location at the same time.

created_atstring<date-time>

Creation timestamp of an object

id object

Identifier of the object

anyOf
integer

Can be integer

modified_atstring<date-time>

Last modification timestampo of the object

resource_uristring<uri-reference>

URI of the object instance

Operations location group model
{
  "code": "string",
  "geofence": "string",
  "project": "string",
  "calculation_params": {
    "enter_time": {
      "fixed": 0
    },
    "exit_time": {
      "fixed": 0
    },
    "service_time": {
      "fixed": 0
    },
    "coefficients": {},
    "cumulative_limitations": {
      "depot_service_time": 0,
      "max_cumulative_vehicles": 0
    }
  },
  "created_at": "2024-07-29T15:51:28.071Z",
  "id": 0,
  "modified_at": "2024-07-29T15:51:28.071Z",
  "resource_uri": "string"
}
Last updated on