Destinations Object (way points)

The Destinations object is included in some webhook callbacks. For example, the Order Is Created callback object includes the Waypoint object. Note: A single order can have up to two destinations (way points).

❗️

Up to two destinations per order

From May 2022 all Bringg orders can only have a either one or two destinations (waypoints). A single order cannot have more than two destinations.

Waypoint Object Attributes

id

Int32

The unique Id of the waypoint.

address

string

The address of this waypoint.

address_second_line

text

The second line of the address of this waypoint.

address_type

Int32

The values are:

  • 1 - commercial
  • 2 - residential
  • 3 - educational
  • 4 - government
  • 5 - medical
  • 6 - industrial

allow_automatic_set_coordinates

boolean

Indicates whether this waypoint location can be fine-tuned using history. The values are:

  • false or 0 - do not allow fine-tuning using history
  • true or 1 - allow fine-tuning using history

The default value is false.

allow_editing_inventory

boolean

Indicates whether the user (driver) is allowed to change inventory at this waypoint. The values are:

  • false or 0 - the user (driver) is not allowed to change the inventory
  • true or 1 - the user (driver) is allowed to change the inventory

The default value is true.

allow_editing_original_quantity

boolean

Indicates whether the user (driver) is allowed to change the quantity of the inventory. The values are:

  • false or 0 - the user (driver) is not allowed to change the quantity of the inventory
  • true or 1 - the user (driver) is allowed to change the quantity of the inventory

The default value is false.

allow_editing_payment

boolean

Indicates whether the user (driver) is allowed to change payment details and cost. The values are:

  • false or 0 - the user (driver) is not allowed to change payment details and cost
  • true or 1 - the user (driver) is allowed to change payment details and cost

allow_scanning_inventory

boolean

Indicates whether the user (driver) is allowed to scan the inventory. The values are:

  • false or 0 - the user (driver) is not allowed to scan the inventory
  • true or 1 - the user (driver) is allowed to scan the inventory

The default value is false.

allow_sending_email

boolean

Indicates whether emails are allowed to be sent to the customer on this waypoint. The values are:

  • false or 0 - do not send emails
  • true or 1 - allow emails to be sent

The default value is true.

allow_sending_sms

boolean

Indicates whether SMSes are allowed to be sent to the customer on this waypoint. The values are:

  • false or 0 - do not send SMSes
  • true or 1 - allow SMSes to be sent

The default value is true.

asap

boolean

Indicates whether this is an ASAP waypoint. The values are:

  • false or 0 - this not an ASAP waypoint
  • true or 1 - this is an ASAP waypoint

The default value is false.

automatically_checked_in

Int32

If checked in automatically, the type of automatic check in. The values are:

  • 0 - manual
  • 1 - automatic
  • 2 - suggested
  • 3 - NOT IN USE
  • 4 - auto_corrected_by_client
  • 5 - auto_corrected_by_server
  • 6 - automated_by_activity_trigger
  • 7 - from_dashboard
  • 8 - from_application
  • 9 - from_run_end

The default value is 0.

automatically_checked_out

Int32

If checked out automatically, the type of automatic check out. The values are:

  • 0 - manual
  • 1 - automatic
  • 2 - suggested
  • 3 - NOT IN USE
  • 4 - auto_corrected_by_client
  • 5 - auto_corrected_by_server
  • 6 - automated_by_activity_trigger
  • 7 - from_dashboard
  • 8 - from_application
  • 9 - from_run_end

The default value is 0.

borough

string

This waypoint's borough. This can also be used for any neighborhood or zone.

checkin_lat

double

The geoposition latitude of the user (driver) when the user (driver) checked into this way point.

checkin_lng

double

The geoposition longitude of the user (driver) when the user (driver) checked into this way point.

checkin_time

datetime

The date and time the user (driver) checked into this waypoint. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

checkout_lat

double

The geoposition latitude of the user (driver) when the user (driver) checked out this way point.

checkout_lng

double

The geoposition longitude of the user (driver) when the user (driver) checked out this way point.

checkout_time

datetime

The date and time the user (driver) checked out of this waypoint. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

city

string

This waypoint's city.

company_name

string

The company name associated with this waypoint.

contacts

Array of objects

An array of objects containing detailed information about all customers waiting for this order, including their contact information and whether the user (driver) is allowed to contact each.

customer

objects

The customer of the order.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer_contact_ids

Array of Int32

An array of all customers waiting for this order. customer_contact_ids cannot be null.

customer_id

Int32

The Id of the customer associated with this waypoint.

delete_at

datetime

If not null, the date and time this waypoint was deleted and this waypoint is not visible. This is in UTC in the format is " %Y-%m-%dT%H:%M:%S%z".

delivery_method

string

This is for waypoint 2 only. Possible values:

  • contactless : This tells the driver or external fleet that the delivery needs to be contactless.

distance_traveled

double

The actual distance travelled (in km).

distance_traveled_client

double

The distance traveled by the user (driver) using the app calculation from where the user (driver) began traveling to the waypoint until the user (driver) arrived at this waypoint (in km).

distance_traveled_server

double

The distance traveled by the user (driver) using the server calculation from where the user (driver) began traveling to the waypoint until the user (driver) arrived at this waypoint (in km).

district

string

The district of the order.

done

boolean

Indicates whether this waypoint is done. The values are:

  • false or 0 - this waypoint is not done
  • true or 1 - this waypoint is done

The default value is false.

etos

Int32

The estimated time on site, if this feature is active. Value is in seconds.

email

string

The email address of this waypoint.

estimated_distance

Int32

The estimated, optimized distance to travel (in km).

estimated_time

Int32

The estimated, optimized time to travel.

eta

datetime

The estimated time of arrival (ETA) at this waypoint, added only after the user (driver) has started order or after optimization. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

etl

datetime

The estimated time of leaving this waypoint (ETA plus time on site). This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

find_me

boolean

Indicates whether the find me feature is enabled for this waypoint. The values are:

  • false or 0 - the find me feature is not enabled for this waypoint
  • true or 1 - the find me feature is enabled for this waypoint

The default value is false.

full_address

string

The full address of the order.

has_to_leave_by

datetime

The time that the user (driver) must leave this waypoint to be on time at the next waypoint. This is in UTC in the format is " %Y-%m-%dT%H:%M:%S%z".

house_number

Int32

The house number of the order

lat

float

The geoposition latitude of this waypoint.

late

boolean

Indicates whether the user (driver) has not arrived at waypoints in the order on or before the scheduled times. The values are:

  • false or 0 - the user (driver) is not late
  • true or 1 - the user (driver) is late

The default value is false.

late_reason

string

The reason the user (driver) is late.

lng

float

The geoposition longitude of this waypoint.

location_name

string

name of the location e.g. "Public Library"

marked_late_at

datetime

The date and time the order was marked late. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

masked_phone_number

string

The phone number, if the phone is masked.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

must_approve_inventory

boolean

Indicates whether the user (driver) is allowed to leave this waypoint before scanning inventory. The values are:

  • false or 0 - the user (driver) is not required to scan all inventory or mark it as collected before completing the order
  • true or 1 - the user (driver) must scan all inventory or mark it as collected before completing the order

The default value is false.

no_earlier_than

datetime

The date and time of the beginning of the time window, if one exists. This is in UTC in the format is " %Y-%m-%dT%H:%M:%S%z".

no_later_than

datetime

The date and time of the end of the time window, if one exists. This is in UTC in the format is " %Y-%m-%dT%H:%M:%S%z".

note

string

A note on this waypoint. The maximum length is 255 characters.

original_eta

datetime

The post optimization (promised) estimated time of arrival. This is UTC in the format is " %Y-%m-%dT%H:%M:%S%z".

pending_geocode

boolean

Indicates whether the geoposition latitude and longitude upload to Bringg are pending.

  • false or 0 - geocode upload is not pending
  • true or 1 - geocode upload is pending

phone

string

The phone number of this waypoint.

pickup_dropoff_option

Int32

Indicates whether this waypoint is a pickup, dropoff, or both. The values are:

  • 0 - pickup
  • 1 - dropoff
  • 2 - both


position

Int32

Indicates the arrangement of a sequence of waypoints. For example, a task with 2 waypoints would have a waypoint with position 1 (the first waypoint) and a waypoint with position 2 (the second waypoint).

scheduled_at

datetime

The date and time the order was scheduled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

scheduled_arrival

datetime

The date and time the inventory is supposed to arrive at this location. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

silent

boolean

Indicates whether this waypoint is invisible to the user (driver). The values are:

  • false or 0 - this waypoint is not invisible
  • true or 1 - this waypoint is invisible

start_lat

double

The geoposition latitude of the user (driver) when this order started.

start_lng

double

The geoposition longitude of the user (driver) when this order started.

start_time

datetime

The date and time when the order was started. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

state

string

This waypoint's state.

street

string

The street of the order.

task_id

Int32

Bringg order Id.

time_windows

Array of Objects

Contains the details of time windows for this destination.

twilio_number_id

Int32

Internal number.

updated_at

datetime

The last update date and time for this waypoint. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

time_window_change_origin

string

The system, process, or user action that initiated a change in the time window for this waypoint. Values include:

  • `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`

workflow_id

string

When a change was triggered by an automation, the ID of that automation.

zipcode

string

The ZIP code of this waypoint.