Custom Stop Property Schema

Model

CustomStopPropertyDefinition

CustomStopPropertyDefinition = object

Definition of a custom stop property that can be used in Stops and Unassigned Stops.

Example

{
  "id": "d24653f8-8327-4bc7-a02d-e74485ff1de3"
  "name": "Invoice number",
  "visibleToDrivers": true,
  "visibleToRecipients": false
}

Properties

Property	Type	Description
id	string	Unique id for this custom stop property, needed to reference it in the customProperties field of a Stop or UnassignedStop.
name	string	Human-readable name for this custom stop property.
visibleToDrivers	boolean	Whether this property is visible to drivers in the mobile app.
visibleToRecipients	boolean	Whether this property is visible to recipients in the delivery tracker.