Operations location

addressstring

Postal address of the location

codestring

External reference for the location

external_idstringrequired

External reference for the location.

groupstring<uri-reference>

Reference to a Operations Location Group this location belongs to

h3string | nullnullable

namestring

Name of the location.

point object

coordinatesnumber[]

Longitude and latitude of the location in this order.

typestring

Type of the location

postal_codestring

Postal code of the location.

project objectrequired

Injected project data this location belongs to.

created_atstring<date-time>

Timestamp when the object has been created

data object

Optional arbitrary project data, primarily used by consuming applications (such as the web UI).

logistics_settings object

Settings for logistics applications.

allow_upload_after_simulation_start_timeboolean

If true, allows bookings to be uploaded even after the simulation has started.

Default value: false

can_manage_vehiclesboolean

UI setting to control vehicle management.

require_mark_all_ordersboolean

UI setting to require all orders to be marked.

use_solver_for_booking_assignmentsboolean

UI setting to use the solver for booking assignments.

public_holidaysobject

List of public holidays applicable to the project. Used to manage (and exclude) recurring simulation templates from recurrence for milk-run operations.

external_idnull

Arbitrary object ID.

idinteger

Project identifier

is_invalidatedboolean

latnumberrequired

Approximate latitude of the project to establish correct mapping and routing profiles for the project region

lonnumberrequired

Approximate longitutde of the project to establish correct mapping and routing profiles for the project region

modified_atstring<date-time>

Last time the object was modified.

namestringrequired

Project name

timezonestringrequired

Timezone of the project

notifications object

Flag allowing to enable notifications like SMS for the user for this project

delivery_on_the_wayboolean

Delivery on the way notification. Triggered when a booking's state changes to: PREPARED, QUEUED, CALCULATION, ASSIGNED, or SENT_OFFER.

operation_start_timestring<time>

Timestamp for notifications to be sent out from

found_a_rideboolean

Occurs when the system finds an offer after the user presses the 'Book' button.

vehicle_arrivalboolean

Occurs when the driver presses the 'Arrive' button for the pickup stop.

failed_to_boardboolean

Occurs when the driver presses 'Go to the next stop', but the passenger did not board.

offer_acceptanceboolean

Occurs the passenger accepts the offer

vehicle_eta_pickupboolean

vehicle_eta_dropoffboolean

settings object

logistics_geocoding_reject_multiple_results_per_addressboolean

If the geocoding engine returns multiple options for the same address, this setting controls the behavior. If set to true, multiple resolutions will fail the request. If set to false, the resolution with the highest score will be selected. This configuration is applied during booking upload as part of the automatic geocoding process.

Default value: false

logistics_geocoding_score_thresholdnumber

Configures the quality score threshold for geocoding. If the score is above the threshold, the geocoding will be successful; otherwise, it will fail. This configuration is applied during booking upload as part of the automatic geocoding process.

Possible values: >= 0 and <= 1

bookingprogress_v2_order_tracking_enabledboolean

Enables or disables anonymous access to order tracking information for the project.

Default value: false

mapbox_style_url object

Defines map styles to be used by SWAT Driver App

light_themestring

Mapbox URL style for light theme, e.g. mapbox://styles/njachowski/cledzgtfw000v01mlfquerbox

dark_themestring

Mapbox URL style for dark theme, e.g. mapbox://styles/njachowski/cledzgtfw000v01mlfquerbox

time_windows object[]

Array [

created_atstring<date-time>

idinteger

modified_atstring<date-time>

projectstring<uri-reference>

resource_uristring<uri-reference>

time_window object

close_time_tsstring<date-time>

Closing time for the time window

namestring

Name of the time window.

open_time_tsstring<date-time>

Opening time for the time window

projectstring<uri-reference>

Project reference this time window belongs to.

public_holidayboolean

Flag is true if this time window is applicable during a public holiday from the associated project data.

recurrencesstring

Recurrence iCal-compatible expression for this time window.

strictboolean

Flag specifying if this is a strict time window that the optimizer must respect.

created_atstring<date-time>

Creation timestamp of an object

id object

Identifier of the object

anyOf

integer
uuid

integer

Can be integer

modified_atstring<date-time>

Last modification timestampo of the object

resource_uristring<uri-reference>

URI of the object instance

]

calculation_params object

Calculation parameters that should be used for calculation in case this operations location object is used.

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 the time required to pass the gates to get to the location).

exit_time object

If the location belongs to a compound zone (fixed time is required to exit the zone where the location is based), fixed field will represent second required to exit the zone. This is converted into 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.

dataobject

Arbitrary data that can be associated with the location.

created_atstring<date-time>

Creation timestamp of an object

id object

Identifier of the object

anyOf

integer
uuid

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
{
  "address": "string",
  "code": "string",
  "external_id": "string",
  "group": "string",
  "h3": "string",
  "name": "string",
  "point": {
    "coordinates": [
      0
    ],
    "type": "string"
  },
  "postal_code": "string",
  "project": {
    "created_at": "2024-07-29T15:51:28.071Z",
    "data": {
      "logistics_settings": {
        "allow_upload_after_simulation_start_time": false,
        "can_manage_vehicles": true,
        "require_mark_all_orders": true,
        "use_solver_for_booking_assignments": true
      },
      "public_holidays": {}
    },
    "external_id": "null",
    "id": 0,
    "is_invalidated": true,
    "lat": 0,
    "lon": 0,
    "modified_at": "2024-07-29T15:51:28.071Z",
    "name": "string",
    "timezone": "string",
    "notifications": {
      "delivery_on_the_way": true,
      "operation_start_time": "string",
      "found_a_ride": true,
      "vehicle_arrival": true,
      "failed_to_board": true,
      "offer_acceptance": true,
      "vehicle_eta_pickup": true,
      "vehicle_eta_dropoff": true
    },
    "settings": {
      "logistics_geocoding_reject_multiple_results_per_address": false,
      "logistics_geocoding_score_threshold": 0,
      "bookingprogress_v2_order_tracking_enabled": false,
      "mapbox_style_url": {
        "light_theme": "string",
        "dark_theme": "string"
      }
    }
  },
  "time_windows": [
    {
      "created_at": "2024-07-29T15:51:28.071Z",
      "id": 0,
      "modified_at": "2024-07-29T15:51:28.071Z",
      "project": "string",
      "resource_uri": "string",
      "time_window": {
        "close_time_ts": "2024-07-29T15:51:28.071Z",
        "name": "string",
        "open_time_ts": "2024-07-29T15:51:28.071Z",
        "project": "string",
        "public_holiday": true,
        "recurrences": "string",
        "strict": true,
        "created_at": "2024-07-29T15:51:28.071Z",
        "id": 0,
        "modified_at": "2024-07-29T15:51:28.071Z",
        "resource_uri": "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
    }
  },
  "data": {},
  "created_at": "2024-07-29T15:51:28.071Z",
  "id": 0,
  "modified_at": "2024-07-29T15:51:28.071Z",
  "resource_uri": "string"
}