Presets

Preset overview

A preset is an existing set of settings that is stored in JSON format and can be included in an API request.

Each preset belongs to one of the following types:

• depot: Depot settings.
• location: Order settings.
• vehicle: Courier or vehicle settings.
• vehicle-shift: Courier shift settings.
• options: Global options.

A preset of a certain type can only be included in the corresponding field of the API request. To learn more, see Using presets.

Public presets are available to everyone. Companies can create their own presets from scratch or by modifying public ones.

Presets are usually created and used in sets, with each set containing presets of different types and geared towards solving a specific task. Presets in a set normally have the same name.

Creating a preset

1. Under Settings → Presets, click Private.
2. Click Add preset.
3. Select a preset type.
4. Enter a preset name. The name for presets of the same type must be unique. It cannot start with public_ or contain a comma.
5. Enter a description (optional) of the situations you plan to use it in.
6. In the edit window, prepare the preset (settings in JSON format). To format the text, click the Beautify button.
7. When the preset is ready, click Save.

When saving the preset, its contents are validated. If the JSON is invalid, you'll receive a message indicating the string that contain errors. Validation is also performed when changing the preset type. An invalid preset cannot be saved.

In the fields, you can specify geofences defined in your company's master data and public geofences.

Fields that cannot be used in presets

Preset type	Field
depot	address description id point ref title
location	address client_id comments delivery_to delivery_to_any depot_id description id phone pickup_from_any point ref title type
vehicle	depot_id ending_depot_id finish_at fixed_planned_route global_proximity_attraction_point id imei fixed_work_breaks middle_depot_id phone planned_route ref shifts start_at starting_depot_id visited_locations
vehicle-shift	id
options	date location_groups

You can use the created presets to implement various scenarios and planning strategies. For more information, see Using presets.

Copying a public preset

You cannot edit public presets. If you want to change the settings of a public preset, save a copy as a private preset and make the changes to that file.

Method 1

1. Under Settings → Presets, click Private.
2. Click Add preset.
3. Select a preset type, enter a preset name, and provide a description (optional). The name must be unique within the company, and it cannot start with public_ or contain a comma.
4. At the bottom, click Copy public preset to display a list of public presets of the selected type.
5. Select a preset, and its contents will be copied to the edit window.
6. Edit the settings and click Save.

Method 2

1. Under Settings → Presets, click Public.
2. Open the preset you want to copy.
3. Click Make personal copy of public preset.
4. Change the preset name and description (optional). You can't change the preset type.
5. Edit the settings and click Save.

Editing and deleting a preset

You can only edit your own presets that are available to your company. Only the latest (current) version is stored for each preset.

To edit a preset, click its name. In edit mode, you can change the name, description, and contents of the preset.

: Beautify code.

You can remove a preset from the list or in edit mode.

Removing from the list

1. Hover the mouse over the line with the preset.
2. Click at the end of the line.
3. Confirm the action.

Removing in edit mode

1. Open the preset you want to remove.
2. Click Delete.
3. Confirm the action.

Contact support