Waypoint Object

The Waypoint object is included in many of the Bringg API's requests, responses, and webhooks. Note: A single order can have up to two way points.

Waypoint Details

Waypoints are the stops along a route. Each order can have up to two waypoints.

Good to know:

The first waypoint is typically the location where the driver picks up an order, and the second is typically the location where the driver delivers an order.
Waypoints are sometimes referred to as destinations, locations, and stops.
The waypoint object is included in much of Bringg's API and is required in the Create Order (Task) request.

Below is a list of all parameters that you can send to Bringg for this object. If there are attributes that you want to include but are not listed here, you can create custom attributes that can be displayed and used throughout Bringg.

For more details about how different parameter types such as datetime are formatted and used in Bringg, read our Data Formatting article.

The truck icon 🚚 signifies that a parameter is displayed in the Bringg Driver App.

Parameter	Description	Validations and Notes
`address` _string 🚚	The first line of the waypoint address, including the street name and house number.	Required if the coordinates are not included, and always recommended. Maximum 255 characters
`address_second_line` _string 🚚	The second line of the waypoint address, for example an apartment number.
`address_type` _int32 🚚	The type of location.	Possible values: `1` - commercial `2` - residential `3` - educational `4` - government `5` - medical `6` - industrial
`asap` _boolean 🚚	Indicates whether the destination is an ASAP waypoint for an on-demand order that should be prioritized before planned orders. In a Get Quotes (ref:get_quotes) request, this parameter instructs carriers to provide only a single delivery ETA that represents the earliest possible delivery time. By default, the delivery time is set for 30 minutes from receipt of the payload.	For example, this could be used for an order for a VIP customer or the delivery of a replacement part to a mechanic who is in the middle of fulfilling a service request for a customer. `asap` can also mean that an order is due in the next hour. Possible values: `false` or `0` - This is not an ASAP waypoint. `true` or `1` - This is an ASAP waypoint. The default value is `false`.
`borough` _string 🚚	The borough of the destination address.
`city` _string 🚚	The city where the waypoint is located.
`company_name` _string 🚚	The name of the company located at the waypoint address.
`contacts` _json 🚚	An array of objects containing detailed information about all customers associated at this waypoint.
`customer` _object 🚚	An object containing detailed information about the customers associated with this waypoint.
`delivery_method` _string	Where supported by the carrier, this indicates the service level for the order.	Possible values: `"contactless"` - the driver should leave packages at the customer's door rather than initiate a return flow when they are not at home. `"home_delivery"`- default when no other value is specified. `"street_level"` - the driver does not need to carry the order upstairs. `"at_room"` - the driver is expected to carry inventory to the chosen room. `"third_party_point"` - the destination is a pickup/dropoff location (PUDO) and not the customer's home.
`district` _string 🚚	The district of the waypoint address.
`email` _string 🚚	The email of the contact associated with this waypoint.
`etos` _int32 🚚	The estimated time the driver will spend on site once they have reached the waypoint.	Measured in seconds (for example, `120` seconds for two minutes).
`extras` _json	This field can be used to send custom attributes to Bringg.	JSON format of field and value. For example: `"extras": { "member_id": "123", Ç "is_vip": true, },`
`first_attempt_promise` `_no_earlier_than` _datetime	When the promised delivery window spans multiple days, this is the earliest date and time when the order can be delivered.
`first_attempt_promise` `_no_later_than` _datetime	When the promised delivery window spans multiple days, this is the latest date and time when the order can be delivered.
`house_number` _int32 🚚	The house number of the waypoint address.	Can be omitted if included in `address`.
`inventory` _{array of objects} 🚚	An array of inventory associated with this order.
`lat` _double 🚚	The destination latitude.
`late` _boolean 🚚	Indicates if the driver has arrived late (not before or at the scheduled time) to any waypoint in the associated order.	Possible values: `0` or `false`: The driver is not late. `1` or `true`: The driver is late.
`lng` _double 🚚	The destination longitude.
`location_name` _string 🚚	The name used to describe the waypoint.
`must_approve_inventory` _boolean 🚚	Indicates whether the driver is allowed to leave this waypoint before scanning inventory.	Possible values: `0` or `false`- the driver may not leave the waypoint before scanning inventory `1` or `true` - the driver may leave the waypoint without scanning inventory
`name` _string 🚚	The name of your contact at the waypoint.	When included, `name` overrides customer data included in the `customer` object.
`no_earlier_than` _datetime 🚚	The date and time of the beginning of the time window, if one exists.
`no_later_than` _datetime 🚚	The date and time of the end of the time window, if one exists.
`notes` _array	An array of notes associated with this waypoint. Each note should include the `note` and `note_creator` parameters. This creates a `task_note` object.	For example: `"notes": [` `{` `"note": "Note by customer",` `"note_creator": "customer"` `},` `{` `"note": "System note via integration",` `"note_creator": "user"` `}` `]` Read more about the Order Notes Object .
`phone` _string 🚚	The phone number associated with this waypoint.
`pickup_dropoff_option` _int32 🚚	Indicates if this waypoint is a pickup, dropoff, or both.	Possible values: `0` - pickup `1` - dropoff `2` - both pickup and dropoff
`position` _int32 🚚	Indicates this waypoint's position in a sequence of waypoints.	Possible values: `1` - first waypoint `2` - second waypoint For linked orders, both orders should be assigned position `2`.
`scheduled_at` _datetime 🚚	The date and time the order was scheduled to be fulfilled.	When using Route Optimization, omit this field and use `no_earlier_than` and `no_later_than` instead.
`state` _string 🚚	The state where the waypoint is located.
`street` _string 🚚	The street where the waypoint is located.
`task_id` _integer	Bringg's ID for the order associated with this waypoint.
`verification_pin_code` _string 🚚	Where required, the code the user must enter to accept an order.
`zipcode` _string	The ZIP code of this waypoint.

Response and Webhook Data

Below is a list of the data returned in webhooks and responses to your API requests. The inclusion of specific parameters may depend on your use case, your API request, and the webhook fields you have subscribed to.

Parameter	Description
`allow_editing_inventory` _boolean	Indicates whether the driver is allowed to change inventory at this waypoint. Possible values: `false` or `0` - the driver is not allowed to change the inventory `true` or `1` - the driver is allowed to change the inventory The default value is `true`.
`allow_editing_original_quantity` _boolean	Indicates whether the driver is allowed to change the quantity of the inventory. Possible values: `false` or `0` - the driver is not allowed to change the quantity of the inventory `true` or `1` - the driver is allowed to change the quantity of the inventory The default value is `false`.
`allow_editing_payment` _boolean	Indicates whether the driver is allowed to change payment details and cost. Possible values: `false` or `0` - the driver is not allowed to change payment details and cost `true` or `1` - the driver is allowed to change payment details and cost
`allow_scanning_inventory` _boolean	Indicates whether the driver is allowed to scan inventory as part of the handover process. Possible values: `false` or `0` - the driver is not allowed to scan the inventory `true` or `1` - the driver is allowed to scan the inventory The default value is `false`.
`allow_sending_email`	Indicates whether emails are allowed to be sent to the customer on this waypoint. Possible values: `false` or `0` - do not send emails `true` or `1` - allow emails to be sent The default value is `true`.
`automatically_checked_in` _int32	The method used to check in to the waypoint. Possible values: `0` - Manually using the Driver App `1`- Automatic check-in or check-out via geofence `2`- Driver's action when prompted by the Driver App `4`- Updated by linked task `5`- Updated via API `6`- Automated by activity trigger `7`- Updated using the Bringg platform `8`- Updated using the store app `9`- Triggered by route end `10`- Automatically updated by server `11`- Updated via API `13` - Triggered by completion of cluster pickup
`automatically_checked_out` _int32	The method used to check out of the waypoint. Possible values: `0` - Manually using the Driver App `1`- Automatic check-in or check-out via geofence `2`- Driver's action when prompted by the Driver App `4`- Updated by linked task `5`- Updated via API `6`- Automated by activity trigger `7`- Updated using the Bringg platform `8`- Updated using the store app `9`- Triggered by route end `10`- Automatically updated by server `11`- Updated via API `13` - Triggered by completion of cluster pickup
`base_etos` _int32	The standard estimated time on site (ETOS) before inventory- and customer-based ETOS are calculated. This is measured in seconds. To calculate ETOS, Bringg takes the largest ETOS from the list as the initial value, and then adds a preconfigured value for each additional order. For example, for a group of orders including a bed and desk with installation times of 15 and 30 minutes, with a base value of 5 minutes, the combined ETOS is 35 minutes (30 + 5 ).
`automatically_geocoded` _boolean	Indicates if the address was automatically geocoded. Geocoding allows Bringg to ensure accurate display and navigation to waypoints. Possible values: `false` or `0` - was not automatically geocoded `true` or `1` - was automatically geocoded
`checkin_lat` _double	The driver's geographical latitude when checking in (arriving) at the waypoint.
`checkin_lng` _double	The driver's geographical longitude when checking in (arriving) at the waypoint.
`checkin_origin` _int32	Indicates which system initiated check-in (arrival) at the waypoint. Possible values: `1` - Driver App `2` - Bringg Platform `3`- Background operations on the Bringg platform `4` - Scheduled background operation on the Bringg platform `5` - Customer experience app `6` - Carrier via API `7` - Floating inventory (for example, if the status of a floating inventory item changes) `8` - Bringg automation
`checkin_time` _datetime	The date and hour of driver check-in (arrival) at the waypoint.
`checkout_lat` _double	The driver's geographical latitude when checking out (departing) from the waypoint.
`checkout_lng` _double	The driver's geographical longitude when checking out (departing) from the waypoint.
`checkout_origin` _int32	Indicates which system initiated checkout (departure) from the waypoint. Possible values: `1` - Driver App `2` - Bringg Platform `3`- Background operations on the Bringg platform `4` - Scheduled background operation on the Bringg platform `5` - Customer experience app `6` - Carrier via API `7` - Floating inventory (for example, if the status of a floating inventory item changes) `8` - Bringg automation
`checkout_time` _datetime	The date and hour of driver check-out (departure) from the waypoint.
`customer_contact_ids` _{array of integers}	An array of customer IDs associated with this waypoint.
`customer_id` _int32	Bringg's ID for the customer.
`delete_at` _datetime	A null timestamp indicates that the entity is still active or present in Bringg.
`distance_traveled` _double	The actual distance traveled (in km).
`distance_traveled_client` _double	The distance traveled by the driver, calculated using the Driver App.
`distance_traveled_server` _double	The distance traveled by the driver, calculated by the Bringg server.
`driver_preparation_time` _int32	The amount of time spent on site before delivering the order, such as the amount of time needed to go through security before reaching the customer.
`done` _boolean	Indicates whether this waypoint is done.
`find_me` _boolean 🚚	Indicates whether the "find me" feature is active for this waypoint. When enabled, the "find me" feature allows customers to share their locations with the driver associated with their order. Possible values: `0` or `false` - the find me feature is not active for this waypoint `1` or `true`- the find me feature is active for this waypoint.
`id` _int32	Bringg's ID for the destination.
`late_reason` _string	The reason the driver is late.
`location_id` _int32	Bringg's ID for the waypoint.
`masked_phone_number` _string	The associated phone number, if is is hidden in the Driver App.
`original_eta` _datetime	The post-optimization (promised) estimated time of arrival.
`original_etl` _datetime	The post-optimization estimated time of departure, based on `original_eta`and `etos` (estimated time on site).
`parking_spot` _object	For curbside pickup, this indicates the customer's parking spot.
`pending_geocode` _boolean	Indicates whether the geoposition latitude and longitude upload to Bringg are pending validation. Possible values: `0` or `false`- The `lat`and `lng` are not pending validation. `1` or `true` - the `lat` and `lng` are pending validation.
`predicted_etos` _int32	When an estimated time on site (ETOS) is not available, Bringg predicts the ETOS based on existing data, such as similar orders and previous driver TOS.
`scheduled_at` _datetime	The date and time the order is scheduled to be fulfilled.
`silent` _boolean	Indicates if Bringg records the time when the driver arrived at the waypoint geofence but relies on manual input for check-in and check-out. Possible values: `0` or `false`- silent mode is not active `1` or `true` - silent mode is active.
`start_lat` _double	The geoposition latitude of the driver when this order started.
`start_lng` _double	The geoposition longitude of the driver when this order started.
`start_time` _datetime	The date and time when the order started.
`task` _object	The order associated with this waypoint.
`task_id` _int32	Bringg's ID for the associated order.
`task_inventories` _object	An array of objects containing the inventory associated with this waypoint. See Order Inventories Object
`time_window_change_origin` _string	The system, process, or user action that initiated a change in the time window for this waypoint. Possible values: `order_creation_api` `order_creation_csv` `order_creation_web` `customer_experience_web_user_rescheduled` `customer_experience_customer_rescheduled` `quotes_for_first_availability` `planned_delivery_window_without_quotes` `narrow_time_window` `order_update_api` `order_update_web` `automation_platform`
`updated_at` _datetime	The date and time that this waypoint was last updated.
`workflow_id` _int32	If a change was triggered by an automation, the automation ID is included here.