Overview
Metadata can be added on Bookings, Booking Stops, Packages, Users and Service Areas to include custom external data and to link between systems. Metadata is mainly visible to Admins only, in some cases also to Customers. If a task or instruction needs to be highlighted to drivers in the driver app, please use our Custom content feature instead.
- Metadata on Bookings
- Metadata on Stops
- Add Metadata to Stops or Bookings via the Webbooker
- Metadata on Service areas
- Metadata on Users
Metadata on Bookings
Admins can add metadata in the Webbooker, via CSV import or via API when creating a booking. The metadata is visible on every Booking card and Booking Details page. An admin can enable the metadata's visibility via the Display options for the Bookings card.
An admin can search for bookings that have a certain metadata value attached to it using the Search feature. In this example we search for a booking by the external id attached to it.
When fetching bookings via the API #ListBookings, you can also filter for a specific metadata value (on booking level) to find the booking(s) matching with your external id.
-
Example:
/api/hailing/bookings?filters[metadata][external_id]=123
Metadata on Stops
When merging bookings into tours we recommend adding metadata on the stop level for the individual bookings instead of on the booking level to ensure that you don’t lose the metadata when creating a tour.
Add Metadata to Stops or Bookings via the Webbooker
For more details on how to add metadata to stops and/ or bookings via the Webbooker, please see the 'Metadata' section here.
Metadata on Service areas
If you’re already managing your service areas with another tool and want to sync them with MotionTools, you can add metadata on a service area and link it to the external id on your current tool.
You can also do this via API #ChangeServiceAreaMetadata by mentioning the id on the service area.
Metadata on Users
Admins and org managers can attach metadata on every user role (Driver, Customer, Admin and Org manager). Metadata allows you to attach custom attributes to Customer accounts for differentiation purposes or attach an external id to better sync Driver accounts between two platforms.
You can add metadata on users via the dashboard or via the API #ChangeUserMetadata.
When fetching all Users via the API #ListUsers, we support filtering by metadata to find the right users. Besides this, the API call response also lists all metadata that got added to the user.
Metadata on Packages
If the Packages extension is enabled on your account, Admins and Customers can add metadata on each package upon creation, such as storing external id’s, shop systems and other valuable information.
Admins and Customers can add metadata when they Bulk create packages with a CSV file via the Packages importer by mentioning “Metadata: example_key“ in a column of the CSV file. The value will be attached automatically to the package as metadata.
If you’re creating packages via API, please check out Create a package via API for more details.
