Editing stop details

Overview

MotionTools allows updating various stop attributes on existing bookings and tours. The availability and permissions for editing depend on the user's role, the stop attribute itself, as well as the stop and booking status. For instance, Customers can’t edit stops of dispatched bookings, and neither Admins nor Customers can edit stop locations if they were created from a Saved place. Learn more about the editing capabilities and restrictions below.

Tour stops and their corresponding stops on customer bookings are kept in sync. This means that any changes made to a stop of a booking are transferred to the corresponding tour stop and vice versa.

 

Stop location

Availability and Permissions

  • Available to Admins and Customers.
  • Permitted while a stop is Scheduled (scheduled), Approaching (approaching), or Failed (failed).
  • Not permitted on stops that are linked to Saved places.
  • Not permitted on stops with packages.
  • Not permitted to Customers on Dispatched (dispatched), Partially Dispatched (partially_dispatched), or En Route (en_route) bookings.

Impact on a booking price

If payments are enabled on your account, changing the stop location might also change the final price of a booking. If you edit a booking on behalf of a customer, it's important to inform them of any price changes that may result from editing the stop locations. MotionTools doesn’t notify customers automatically.

On the Dashboard

To edit the stop location, open the Booking Details page, click the More button on a stop, and select Edit location. In the window that appears, adjust the location by using address autocompletion in the Street input field or by moving a pin on the map.

Bookings Details - Edit location - HC.png

If you know the exact coordinates of the location, switch to the coordinates input. In the coordinates input mode, you can freely edit the address components to provide a human-readable description for your coordinates.

Editing via API

Use the "Update location" endpoint to perform editing via the API. Learn more about the endpoint in the API documentation.

 

Stop contact details

Availability and permissions

  • Available to Admins and Customers.
  • Permitted while a stop is Scheduled (scheduled), Approaching (approaching), or Failed (failed).
  • Not permitted on stops with packages.

On the Dashboard

To edit the contact details of a stop, open the Booking Details page, click the More button on a stop, and select Edit contact details. In the window that appears, enter the first and last name of the person at the stop, as well as their phone number and email.

Bookings Details - Edit contact details - HC.png

Whether some of this information is required depends on the settings of the Service for this booking.

Editing via API

Use the "Update contact info" endpoint to perform editing via the API. Learn more about the endpoint in the API documentation.

 

Stop arrival time

Availability and permissions

  • Available to Admins and Customers.
  • Permitted while a stop is Scheduled (scheduled), Approaching (approaching), or Failed (failed).

On the Dashboard

To edit the arrival time of a stop, open the Booking Details page, click the More button on a stop, and select Edit arrival time. In the window that appears, define the earliest and latest arrival time.

Bookings Details - Edit arrival times - HC.png

Editing via API

Use the "Update arrival times" endpoint to perform editing via the API. Learn more about the endpoint in the API documentation.

Stop additional information

Availability and permissions

  • Available to Admins and Customers.
  • Permitted while a stop is Scheduled (scheduled), Approaching (approaching), or Failed (failed).

On the Dashboard

To edit the additional information and order images of a stop, open the Booking Details page, click the More button on a stop, and select Edit additional information. In the window that appears you can define the additional information and upload an image.

Edit stops additional information.png

Editing via API

Use the "Update Additional Information" endpoint to perform editing via the API. Learn more about the endpoint in the API documentation.

Stop properties

Availability and permissions

  • Available to Admins and Customers.
  • Permitted while a stop is Scheduled (scheduled), Approaching (approaching), or Failed (failed).
  • Customer can only update the Type of a stop.
  • Admins cannot update the Type or Flow of stops that have package interactions on them.

Property types

  • Type (type)
    The stop type indicates the type of task needs to be performed at a stop. Can be pickup or drop-off.
  • Flow (flow)
    A stop with the Single step flow gets completed immediately once the driver confirms arrival. A stop with the Full flow stays in the Arrived state until a driver confirms the completion of the stop.
  • Priority (priority)
    Stops marked as high priority are displayed with a specific priority flag on both the dashboard and the driver app. This is only an indication and does’t impact route optimization. 
  • Geofencing (maximum_driver_distance_meters)
    When enabled, a driver can confirm the arrival at a stop only when they are within the defined proximity to the stop location.

On the Dashboard

To edit the stop properties, open the Booking Details page, click the More button on a stop, and select Edit stop properties. In the window that appears, define the Type, Flow, Geofencing, and Priority of the stop.

Edit stops properties.png

Editing via API

Use the "Update Stop properties" endpoint to perform editing via the API. Learn more about the endpoint in the API documentation.

 

Stop metadata

Availability and permissions

  • Available to Admins and Customers.
  • Permitted on all stop statuses.

On the Dashboard

To edit the metadata of a stop, open the Booking Details page, click the More button on a stop, and select Edit metadata.

Booking Details - Edit metadata.png

Editing via API

Use the "Update Metadata" endpoint to perform editing via the API. Learn more about the endpoint in the API documentation.

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more