Resources

id

number

The Id of this application.

name

string

The name of this application.

uuid

uuid

The unique universal Id for this application.

id

number

The Id of this application configuration.

shift_start_time

string

The start time for shifts in this application configurations.

token

uuid

The access token for this application configuration.

version

number

The version of this application configuration.

id

number

The Id of this application merchant configuration.

application_id

number

The Id of the application with which this application merchant configuration is associated.

created_at

datetime

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

merchant_id

number

The Id of the merchant with which this application merchant configuration is associated.

updated_at

datetime

The date and time this application merchant configuration was last updated. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

id

number

The Id of this contact.

contact_type

string

The contact type. The values are: phone, email.

contact_value

string

The contact information according to the contact_type. The contact_value for a contact_type of 'phone' is the phone number, and the contact_valuye for a contact type of 'email' is the email address.

customer_id

number

The Id of the customer associated with this contact.

sharing_allowed

boolean

Indicates whether this contact can received shared location notifications. The values are:

• false - cannot receive location sharing notifications
• true - can receive location sharing notifications.

id

number

The Id of this customer.

address

string

The address of this customer.

address_second_line

string

The second link of the address of this customer.

allow_login

boolean

Indicates whether this customer can login. The values are:

• false - customer cannot login
• true - customer can login

borough

string

The borough of this customer.

business_code

string

The business code of this customer/

city

string

The city of this customer.

client_name

string

The client name.

client_version

string

The client version.

confirmation_code

string

The confirmation code sent to this customer's phone for login verification.

customer_notes

Object

An array of CustomerNotes objects containing customer notes for this customer.

email

string

The email of the customer.

external_id

string

The Id of this customer in your own system.

extras

Object

Internal Use.

image

string

The URL of an image associated with this customer.

language

string

The language setting from this customer's app. This is a 2-letter code, for example "en" for English or "fr" for French. Note: This may be different than the company's default language.

lat

number

The geoposition latitude of this customer's address.

lng

number

The geoposition longitude of this customer's address.

merchant_id

number

The Id of this merchant associated with this customer.

mobile_type

number

The type of mobile.

name

string

The name of this customer.

phone

string

The phone number of this customer.

state

string

The state of this customer

street

string

The street of this customer.

zipcode

string

The ZIP code of this customer.

id

number

The Id of this customer note.

customer_id

number

The Id of the customer to which this customer note is associated.

note

string

The text of the customer note.

user_id

number

The Id of the user who created this customer note.

id

number

The Id of this driver tip configuration.

tip_amounts

number

The driver's tip percentage.

tip_driver_enabled

boolean

Indicates whether customers are allowed to enter tips. The values are:

• false - customers cannot enter tips
• true - customers can enter tips

tip_other_amount_enabled

boolean

Indicates whether customers are allowed to enter tips with other amounts. The values are:

• false - customers cannot enter tips with other amounts
• true - customers can enter tips with other amounts

tip_require_signature

boolean

Indicates a signature is required for tipping. The values are:

• false - a signature not is required for tipping
• true - a signature is required for tipping

tip_type

number

The type of tip. The values are:

• 0 - percentage
• 1 - money

id

number

The Id of the inventory item.

commodity

string

The description of the inventory item.

completed

boolean

Not in use.

delivery_cost

number

The delivery cost of this inventory item.

external_id

string

The Id of the inventory item in your own system.

extras

Object

Internal use.

height

number

The height of the inventory item.

image

string

The full path of an image file of the inventory item.

length

number

The length of the inventory item.

merchant_id

number

The Id of the merchant associated with this inventory item.

name

string

The name of this inventory item.

notes

string

The text of a note associated with this inventory item.

price

number

The price of this inventory item.

scan_string

string

If a scan code is associated with this task inventory item, this is that scan code.

size

number

The size of this inventory item.

weight

number

The weight of inventory item.

width

number

The width of the inventory item.

id

number

The Id of this merchant.

active_until

number

Indicates when the merchant's subscription expires.

address

string

The address of this merchant.

beta

boolean

Indicates whether the merchant is using any of the Beta Features found in Bringg Labs.

country_code

string

The country code of this merchant.

custom_payments

boolean

Not in use.

developer_account

boolean

Indicates whether the merchant has a developer account. The values are:

• false - does not have a developer account
• true - does have a developer account

extras

Object

Internal use.

feature_flags

Object

An object containing key/value pairs for the features allowed in the merchant

has_partner

boolean

Indicates whether this merchant is a member of a merchant group

• false - this merchant is not a member of a merchant group
• true - this merchant is a member of a merchant group

has_stripe_subscription

boolean

Indcates whether this merchant has a Stripe subscription. The values are:

• false - this merchant does not have Stripe subcription
• true - this merchant does have a Stripe subscription

home_area

Object

The home area of this merchant

lat

number

The geoposition latitude of this merchant.

lng

number

The geoposition longititude of this merchant.

name

string

The name of this merchant.

paid

boolean

Indicates whether this merchant's account is a paid account type. The values are:

• false - this not a paid account type
• true - this a paid account type

partner_id

number

The Id of this merchant's partner.

phone

string

The phone of this merchant.

pro

boolean

Indicates whether this merchant's account is a pro account type. The values are:

• false - this not a pro account type
• true - this a pro account type

production_env

boolean

Indicates whether the environment is a production environment.

• false - is not a production environment
• true - is a production environment

sms_from_field

string

The 'FROM' to use for SMS.

stripe_id

boolean

Indicates whether this merchant has a Stripe Id.

subscription_type

number

The subscription type of the merchant.

test_env

boolean

Indicates whether the environment is a test environment.

• false - is not a test environment
• true - is a test environment

time_zone

string

The time zone of this merchat.

trial

string

Not in use.

unpaid

boolean

Not in use.

acknowledge_flow_ui_config

Object

An object containing an array of task_fields and an array of way_point_fields to show on the acknowledge flow screen.

advance_configuration_enabled

boolean

Not in use.

alert_configurations

Object

An object containing the alerts and booleans indicating whether each alert is enabled/disabled for Admins and enabled/disabled for Dispatchers.

alert_if_user_rated_below

number

The rating number below which enabled alerts are sent to the Admins and Dispatchers for which the alerts are enables (see the alert_configurations param).

alerts_types

Object

An object containing key/value pairs with a string describing alerts and a number indicating the Id of the corresponding alert.

allow_access_to_all_open_tasks

boolean

Indicates whether to allow drivers access to unassigned tasks.

• false - do not allow access
• true - allow access

allow_customer_fb_like

boolean

Indicates whether customers of the merchant are allowed to use the Facebook like feature to "like" the merchant. The values are:

• false - do not allow customer Facebook "likes"
• true - allow customer Facebook "likes"

allow_customer_find_me

boolean

Indicates whether to allow customers to use the fine me feature. The values are:

• false - do not allow customers to use the find me feature
• true - allow customer to use the find me feature

allow_dispatcher_to_access_all_teams

boolean

Indicates whether dispatchers are allowed access to all of the merchant's teams. The values are:

• false - do not allow dispatchers to access all teams
• true - allow dispatchers to access all teams

allow_dispatcher_to_access_task_price

boolean

Indicates whether dispatchers are allowed access the task price of task. The values are:

• false - do not allow dispatchers to access the task price
• true - allow dispatchers to access the task price

allow_dispatcher_to_edit_drivers

boolean

Indicates whether dispatchers are allowed to modify the details of driver information. The values are:

• false - do not allow dispatchers to access to modify the details of driver information
• true - allow dispatchers to access to modify the details of driver information

allow_moving_tasks_to_planning_phase

boolean

Indicates whether tasks can be moved from the dispatch phase to the planning phase.

allow_offshift_drivers_to_be_assigned

boolean

Indicates whether drivers not currently on a shift can be assigned tasks. The values are:

• false - do not allow drivers not currently on a shift to be assigned tasks
• true - do allow drivers not currently on a shift to be assigned tasks

allow_rating

boolean

Indicates whether customers can rate drivers. The values are:

• false - do not allow customers to rate drivers
• true - allow customers to rate drivers

allow_share_location

boolean

Indicates whether this merchant allows location sharing. The values are:

• false - do not allow location sharing
• true - allow location sharing

allow_single_order_per_driver

boolean

Pending Update.

alternate_delivery_pin

string

The full path to the alternate map pin image for the delivery location.

ApplicationConfigurations

Object

An ApplicationConfigurations object containing the application confirmation associated with this merchant configuration.

ApplicationMerchantConfigurations

Array of Objects

An array of ApplicationMerchantConfigurations objects containing the application merchant configurations associated with this merchant configuration.

Application

Array of Objects

An array of Application objects containing applications associated with this merchant configuraiton.

auto_dispatch

boolean

Indicates whether this merchant allows automatic dispatching. The values are:

• false - do not allow automatic dispatching.
• true - allow automatic dispatching.

auto_dispatch_optimization_method

number

Indicates the method uses for dispatch optimization. The values are:

• 0 - optimize for customer experience
• 1 - optimize for distance
• 2 - optimize for driver efficiency
• 3 - use a custom optimization

auto_dispatch_timeout

boolean

Indicates whether to use the default time allowed for the automatic dispatch optimizer to dispatch. The values are:

• false - do not use the default time for the automatic dispatch optimizer
• true - use the default time for the automatic dispatch optimizer

auto_dispatch_timeout_per_driver

number

The specific length of time the optimization service uses to dispatch tasks to driver, if the auto_dispatch_timeout/span> paramater is set to specific. For this time out per driver, the longer the optimization service runs, the better the optimization.

auto_share_location

boolean

Indicates whether locations are automatically shared. The values are:

• false - do not automatically share locations
• true - automatically share locations

average_delivery_time

number

Pending Update

cancel_undone_tasks_by_eod

boolean

Indicates whether to automatically cancel tasks that are not completed by the end of the day. The values are:

• false - do not automatically cancel tasks
• true - automatically cancel tasks

cash_out_flow_enabled

boolean

Pending Update

cash_out_template_name

string

The name of the cash out template.

consumer_app_eta_display_method

Object

An object containing a method indicating the method used to dispaly the ETA on the customer app and a threshold indicating when the customer is notifified of the ETA and can track the driver.

country_code

string

The country code for this merchant configuration.

customer_fb_like_url

string>

The URL for customers to "like" this merchant.

dashboard_refresh_rate_secs

integer

The rate in second for refreshing the dashboard to show its current state.

debrief_flow_enabled

boolean

Indicates whether the pre-shift and post-shift procedures are active.

• false - pre-shift and post-shift procedures are not active
• true - pre-shift and post-shfit procedures are active

default_minutes_buffer_for_asap_orders

number

The required wait time before dispatching ASAP orders.

default_minutes_buffer_for_scheduled_orders

number

The required wait time before dispatching scheduled orders.

delivery_pin

string

The full path to the map pin image for the delivery location.

destination_pin

string

The full path to the map pin image for the destination location.

distance_threshold

number

The driver's distance from the target point at which a notification is sent.

driver_at_home_flow_options

number

Indicates whether to display drivers that are at home.

driver_preparation_time_seconds

number

Not in use.

email_logo

string

The full path and file name of the email logo.

email_style_color

string

The hex value for the email base color.

enable_dashboard

boolean

Indicates whether the Bringg dashboard is enabled for this merchant. The values are:

• false - do not enable the Bringg dashboard
• true - enable the Bringg dashboard

enable_dimension_editing_in_ui

boolean

Indicates whether the driver is allowed to edit the package size. The values are:

• false - do not enable the Bringg dashboard
• true - enable the Bringg dashboard

enable_future_tasks

boolean

Not in use.

enable_kds

boolean

Indicates whether to allow tasks by status for the kitchen delivery system. The values are:

• false - do not allow
• true - allow

enable_looping_alert_sound

boolean

Indicates whether to allow the alert snooze feature. The values are:

• false - do not allow
• true - allow

enable_map_overlays

boolean

Indicates whether to allow map overlays. The values are:

• false - do not allow
• true - allow

enable_reschedule_flow

boolean

Indicates whether to send a notification to customer to reschedule a task when a task is cancelled. The values are:

• false - do not send notification to reschedule
• true - send notification to reschedule

enable_shifts_actions

boolean

Indicates whether to allow manual start and stop shift actions. The values are:

• false - do not allow
• true - allow

enable_support

boolean

Indicates whether to allow support flow. The values are:

• false - do not allow
• true - allow

enable_task_acknowledge_flow

boolean

Indicates whether to allow task acknowledge flow. The values are:

• false - do not allow
• true - allow

enable_task_cancellation

boolean

Indicates whether to allow task cancellation. The values are:

• false - do not allow
• true - allow

enable_task_price

boolean

Indicates whether to allow task price. The values are:

• false - do not allow
• true - allow

enable_teams

boolean

Indicates whether the teams feature is enabled for the merchant. The values are:

• false - the teams feature is not enabled
• true - the teams feature is enabled

enable_user_types

boolean

Indicates whether the use of user types is allowed.

• false - do not allow
• true - allow

end_of_day_time

number

The time the work day ends.

eta_background_color

string

The hex value for the background color of the ETA display component.

eta_minutes_color

string

The hex value for the color of the minutes text of the ETA displaycomponent.

eta_time_color

string

The hex value for the text color of the ETA time display component .

eta_title_color

string

The hex value of the title color of the ETA display component..

extra_terms_and_conditions_url

string

The URL for additional Tearms and Conditions for this merchant.

grab_future_timeout

number

The time allowed for an external party to grab a task.

grab_mode_alert_type

number

Indicates the type of alerts sent in grab mode. The values are:

• No alerts
• Only At Home
• Always

grab_mode_radius

number

The maximum distance (in meters) to grab an order.

grab_mode_timeout

number

The maximum time to grab an order.

header_color

string

The hex value of the color for the header.

history_fields

Object

The task history fields.

initial_tasks_page_size

number

The number of task per page used for pagination

inverse_header_color

string

The hex value for the color that is the inverse of header base color.

invoice_printed_copies

number

The number of invoice copies to print.

language_code

string

The language setting from the merchant. This is a 2-letter code, for example "en" for English or "fr" for French. Note: This may be different than the company's default language.

lat

number

The geoposition latitude of this merchant.

late_buffer

number

Indicates when to mark a task as late.

lng

number

The geoposition longitutde of this merchant

logo

string

The full path and file name of the logo.

logout_idle_admin_minutes

number

The idle time in minutes for admin users to be automatically logged out.

logout_idle_dispatcher_minutes

number

The idle time in minutes for dispatcher users to be automatically logged out.

looping_alert_sound_type

number

Pending Update

map_type

number

Indicates the type of map shown. The values are:

• 0 - Google Map
• 1 - Street View
• 2 - MapQuest

max_distance_for_optimization_in_meters

number

The maximimum distance for optimization in meters.

max_distance_from_home_to_task_km

number

The maximimum distance from the home location to a way point in a task (km).

max_distance_to_not_report

number

Not in use.

merchant_id

number

The Id of the merchant with which this merchant configuration is associated.

merchant_mode

number

Indicates the Bringg merchant mode for this merchant. The values are:

• 0 - Default
• 1 - Single Pickup Location, Multiple Dropoff Locations
• 2 - Multiple Pickup Locations, Multiple Dropoff Locations
• 3 - Route

minutes_until_first_wp_scheduled_at

number

Not in use.

name

string

The name of this merchant configuration.

number_of_retries_before_a_phone_call

number/p>

Number of retries to a task that is not accepted before sending making a voice reminder phone call.

paid_google_maps_api

boolean

Indicates whether to use a paid Google Maps API token.

• false - do not use a Google Maps API token
• true - use a Google Maps API token

phone_call_string

string

The text of a phone call voice reminder that a task was not accepted

planning_fields

Array of Objects

An array of TaskField objects containing task fields assocated with this merchant configuration.

planning_phase_exists

boolean

Indicates whethe future tasks are allowed. The values are:

• false - future tasks are not allowed
• true - future tasks are allowed

planning_phase_print_on_apply

boolean

Indicates whether to print working schedules (on Send to Drivers).

• false - do not print working schedules
• true - print working schedules

planning_phase_send_emails_to_drivers_on_apply

boolean

Indicates whether to send emails to drivers (on Send to Drivers).

• false - do not send emails to drivers
• true - send emails to drivers

preparation_flow_ui_config

Pending Update

Pending Update

price_currency

string

The currency used for prices.

printer_type

string

The type of printer used to print receipts. The values are:

• 3"
• A4

reminder_timeout

number

The frequency (time) for reminders if tasks are not accepted.

reply_to_shared_email

string

The merchant's email for replies in shared emails.

run_batcher_on_grab_mode

boolean

Indicates whether to run the batcher for deliveries in grab mode. The values are:

• false - do not run the batcher for deliveries in grab mode
• true - run the batcher for deliveries in grab mode

scan_code_unique

boolean

Indicates whether package and task scan code must be unique. The values are:

• false - the scan codes do not need to be unique
• true - the scan codes do need to be unique

secured_setup

boolean

Indicates whether to use complex password requirements. The values are:

• false - do not use complex password requirements
• true - do use complex password requirements

send_notifications_to_customers

boolean

Indicates whether to send notifications to customer. The values are:

• false - do not send notifications to customers
• true - send notifications to customers

send_sms_to_first_way_point

boolean

Not in use

share_if_too_close

boolean

Indicates whether to share a notification with the customer if the driver is too close to the customer. The values are:

• false - do not send notifications to customers if too close
• true - send notifications to customers if too close

sharing_mode

number

Indicates the mode of sharing notifications with customers. The values are:

• 0 - All methods
• 1 - Only via email
• 2 - Only via SMS
• 3 - Only webhook

show_bringg_logo

boolean

Indicates whether to display the Bringg logo. The values are:

• false - do not display the Bringg logo
• true - display the Bringg logo

show_eta_to_home

boolean

Indicates whether to show the estimated time of arrive to the home location. The values are:

• false - do not show the estimated time of arrival to the home location
• true - show the estimated time of arrival at the home location

soft_csv_import

boolean

Not in use.

sound_on_new_order

boolean

Indicates whether an audible alert is played when a new order is created. The values are:

• false - do not play an audible alert for new orders
• true - play an audible alert for new orders

support_parcel_shop_last_mile

boolean

Not in use.

task_fields

Array of Objects

An array of TaskField objects containing task fields assocated with this merchant configuration.

task_forwarding_enabled

boolean

Indicates whether forwarding tasks to another phone is enabled. The values are:

• false - do not forward tasks to another phone
• true - forward tasks to another phone

task_home_when_delivery_ends

boolean

Indicates whether a return task for the driver returning home is allowed. The values are:

• false - do not allow return tasks
• true - allow return tasks

task_invoice_template_name

string

The text for the task invoice template.

task_window_bottom_buffer_minutes

number

Not in use

task_window_top_buffer_minutes

number

Not in use

tasks_page_size

number

The number of task items per page.

the_batcher

boolean

Not in use.

time_to_remind_before_start_task

number

The amount of time before a task starts to remind the driver that the task is about to start.

tip_driver_enabled

boolean

Indicates the driver tip feature is enabled. The values are:

• false - do not enable the driver tip feature
• true - enable the driver tip feature

update_location_max_idle_time

number

Pending Update

use_coc

boolean

Indicates to use chain of custody. The values are:

• false - do not use chain of custody
• true - use chain of custody

use_time_windows

boolean

Indicates whether to use windows of time, or hours during which, deliveries can be done. The values are:

• false - do not use windows of time for deliveries
• true - use windows of time for deliveries

voice_reminder_frequency

number

The length of time to repeat sending a voice reminder to a driver if a task was not accepted.

voice_reminder_text

string

The text for a voice reminder to a driver if a task was not accepted.

windows

Array of Objects

An array of OpeningPeriod objects containing opening period information associated with this object.

windows_mode

boolean

Indicates whether the windows mode is enabled. The values are:

• false - windows mode is not enabled
• true - windows mode is enabled

id

number

The Id of this merchant configuration CSV field.

created_at

datetime

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

field_index

number

The index of this CSV field.

field_name

string

The name of this CSV field.

merchant_id

number

The Id of the merchant associated with this CSV field.

updated_at

datetime

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

id

number

The Id of this public task format.

color

string

The hex value of the mobile task form color.

forms

Array of Objects

An array of PublicTaskForm objects associated with this PublicTaskFormFormat.

logo

string

The full path and file name for the logo image file?

day_of_week

number

The number of the day of the week for this opening period.

closing_hour

datetime

The date and time this opening period ends. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

opening_hour

datetime

The date and time this opening period begins. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

id

number

The Id of this PublicTaskForm.

customer

Object

A Customer object containing detailed information about the customer associated with this PublicTaskForm.

customer_id

number

The Id of the customer associated with the PublicTaskForm.

services

Array of Objects

Pending Update

status

number

Indicates whether a public form can be closed without deleting the form and perserve the shared link with the clients. The values are:

• 0 - opened
• 1 - closed

team_ids

Array of numbers

An array of team numbers associated with this PublicTaskForm.

tracker_uuid

string

A URL to share on the same route.

uuid

string

The unique universal identfier of this PublicTaskForm.

id

number

The Id of this public task format.

color

string

The hex value of the public task form color.

forms

Array of Objects

An array of PublicTaskForm objects associated with this PublicTaskFormFormat.

logo

string

The full path and file name for the logo image.

id

number

The Id of this rating.

post_rating_reason_id

number

The id of the rating reasoning associated with this rate.

rating

number

The rating number.

task_id

number

The Id of the task associated with this rating.

user_id

number

The Id of the user associated with this rating.

way_point_id

number

The Id of the way point associated with this rating.

id

number

The Id of this rating reason.

created_at

datetime

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

icon

string

The path and file name for the icon image.

merchant_configuration_id

number

The Id of the merchant configuration with which this rating reason is associated.

text

string

The text of the rating reason.

updated_at

datetime

The date and time the rating reason was last updated. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

id

number

The Id of this rating reason configuration.

rating_reason_positive_title

string

The title of the positive reasons (comments) question. If blank, will not be shown.

rating_reason_screen_rating

number

The rating reason number used to determine whether the positive or negative rating reason question is shown.

rating_reason_title

string

The rating reason title.

rating_reasons

Array of Objects

An array of RatingReason objects associated with this PublicTaskFormFormat.

use_rating_reason_screen

boolean

Indicates whether to use this rating reason screen. The values are:

• false - do not use this rating reason
• true - use this rating reason

created_at

datetime

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

inventory_id

number

The Id of the inventory item with which this scan is associated.

lat

number

The geolocation latitude at which this scan was done.

lng

number

The geolocation longtitude at which this scan was done.

manual_scan

boolean

Indicates whether this scan was manually done. The values are:

scanning_role

number

The role of the user performing this scan. The values are:

• 0 - driver
• 1 - dispatcher for staging
• 2 - dispatcher for chain of custody

scan_string

string

The value of a barcode scan.

scanned

boolean

Indicates whether this scan was done The values are:

• false - a scan was not done
• true - a scan was done

task_id

number

The Id of the task with which this scan is associated.

task_inventory_id

number

The Id of the task inventory item with which this scan is associated.

user_id

number

The Id of the user who performed this scan.

way_point_id

number

The Id of the way point with which this scan is associated.

id

number

The Id of this shared location.

customer_id

number

The Id of the customer with which this shared location is associated.

expired

boolean

Indicates whether this shared location expired. The values are:

• false - the shared location has not expired
• true - the shared location has expired

failure_reason

string

If the SMS and email failed, the reason for failure.

first_seen_on

datetime

The date and time the shared location was seen for the first time. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

shared_on

datetime

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

shared_successfully

boolean

Indicates whether the SMS for this shared location was successfully sent. The values are:

• false - the SMS was not successfully sent
• true - the SMS was successfully sent

sharing_method

number

The type of the SMS share. The values include:

• 0 - phone
• 1 - email
• 2 - websocket
• 3 - none
• 4 - other
• 5 - api
• 6 - push

url

string

The URL of the webpage for this shared location update.

uuid

uuid

The universal unique Id of this order.

view_counter

number

The number of times the shared location was viewed.

was_forwarded

boolean

Indicates whether the SMS for this shared location was forwarded The values are:

• false - the SMS was not forwarded
• true - the SMS was forwarded

way_point_id

number

The Id of the way point with which this shared location is associated.

id

number

The unique Id of the task.

active_way_point_id

number

The Id of the way point currently active (the driver is on the way to or at) in this task.

address

string

The address of this way point.

asap

boolean

Indicates whether this is an ASAP way point. The values are:

• false - this not an ASAP way point
• true - this is an ASAP way point

automatically_cancelled

number

If the task was automatically cancelled, indicates the method. The values are:

• 0 - manually
• 1 - automatically
• 2 - from an application

cancelled_at

datetime

If this task is cancelled, the date and time it was cancelled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer

Object

A Customer object containing the detailed information about the customer associated with this task.

customer_id

number

The Id of the customer associated with this way point.

delivery_price

number

The amount of the delivery price for this task.

discount

number

The amount of the discount for this taks (order).

dispatcher_id

number

The Id of the dispatcher associated with this task.

distance_traveled_server

number

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

ended_time

datetime

If this task completed, the date and time it completed. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

external_id

string

The Id of task in your own system.

extras

Object

Internal use.

group_leader_id

number

If this order is a group of orders, this is the Id of the order representing the entire collection of orders in the group (the parent order containing all child orders in the group). This is the Id that Bringg operators (for example, dispatchers and users/drivers) view. NOTE: Bringg internally maintains each order and each order contains the same group leader Id.

group_uuid

uuid

If this order is a group of orders, this is the UUID of the group (see group_leader_id above).

lat

number

The geoposition latitude of this way point.

late

boolean

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

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

left_to_be_paid

number

The amount remaining to be paid on this task.

linked_task_id

number

The Id of another task linked to this task.

lng

number

The geoposition longitude of this way point.

merchant_name number

The name of the merchant associated with this task.

parent_task_id

number

The Id of the task inventory item of which this task inventory item is a member. For example, in the case of two task inventories A (Id 1) and B (Id 2) where B is a member of A, Id 1 is the parent_task_inventory_Id.

payment_method

number

The method of payment for this task. The values are:

• 0 - unknown
• 1 - cash
• 2 - credit
• 3 - cheque

payment_type_name

string

The name of the payment type. For example, the value could be AMEX, if the payment_method is 2 for "credit".

post_delivery_tip_credit

number

The tip (gratuity) paid to the user (driver) in cash after this order delivery.

pre_delivery_tip

number

The tip (gratuity) paid to the user (driver) before this order delivery.

preparation_end_time_planned

datetime

The planned date and time by which preparation for this task will complete. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

preparation_ready_for_pickup_time_planned

datetime

The planned date and time by which this task will be ready for pickup. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

preparation_start_time_planned

datetime

The planned date and time by which preparation for this task will start. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

preparation_status

number

The status of this task's preparation. The values are:

• 0 - acknowledged
• 1 - preparation started
• 2 - preparation ended
• 3 - ready for pick up
• 4 - picked up

price_before_tax

number

The amount of the price of this task before taxes are applied.

priority

number

The priority of this task.

ready_to_execute

boolean

Indicates whether this task is ready to execute. The values are:

• false - not ready to execute
• true - ready to execute

scans

Array of Objects

An array of Scan objects containing the detailed scan information for this task.

scheduled_at

datetime

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

shared_locations

Array of Objects

An array of SharedLocation objects containing the detailed shared location information for this task.

started_time

datetime

If this task started, the date and time it started. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

status

The status of this task. The values are:

• 0 - created
• 1 - assigned
• 2 - on the way
• 3 - checked in
• 4 - done
• 6 -accepted
• 7 - cancelled
• 8 - rejected

task_cancellation_reason

Object

If the task was cancelled, a TaskCancellationReason object containing detailed information about the reason this task was cancelled.

task_inventories

Array of Objects

An array of TaskInventory objects containing detailed information about the task inventory items in this task.

tax_price

number

The amount of taxes on this task.

teams

Array of Objects

An array of Team objects containing detailed information about the teams associated with this task.

tip

number

The amount of tip for this task.

tip_driver_enabled

boolean

Indicates whether the user (driver) is allowed to be tipped. The values are:

• false - the driver is not allowed to accept tips
• true - the driver is allowed to accept tips

title

string

The title of this task.

total_price

number

The amount of the total price of this task.

user

Object

A User object containing detailed information about the user associated with this order.

user_id

number

The Id of the user associated with this task.

uuid

uuid

The universal unique Id of this task.

way_points

Array of Objects

An array of WayPoint objects associated with this order.

task_notes

Array of Objects<

An array of TaskNote objects associated with this order.

id

number

The Id of this task cancellation reason.

created_at

datetime

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

other_text

string

Additional text for the task cancellation reason.

reason_to_cancel_task_id

number

The Id of the reason to cancel this order.

task_id

number

The Id of the task with which this task cancellation reason is associated.

updated_at

datetime

The date and time the task cancelleation reason was last updated. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

id

string

The Id of this task field

active

boolean

Indicates whether this task field is active. The values are:

filter

string

Pending Update

position

number

The position of this way point in all way points in the order to which this way point belongs. For example, the order may contain 5 way points and this way point is position 2 (the second).

postDefaultFilter

string

Pending Update

title

string

The title of this task field.

translate

boolean

Pending Update

id

number

The Id of this task inventory item.

coc_type

number

The chain of custody type. The values are:

• 0 - weak
• 1 - strong
• 2 - none
• 3 - unloaded

external_id

string

The Id of the task inventory item in your own system.

image

string

A URL to a file containing an image of the inventory item.

inventory

Object

An Inventory object containing the detailed inventory information.

inventory_id

number

The Id of this inventory associated with this task inventory item.

merchant_id

number

The Id of the merchant associated with this task inventory item.

name

string

The name of this task inventory items.

note

string

The text of a note associated with this task inventory item.

original_quantity

number

The original quantity of this task inventory item.

parent_task_inventory_id

number

The Id of the task inventory item of which this task inventory item is a member. For example, in the case of two task inventories A (Id 1) and B (Id 2) where B is a member of A, Id 1 is the parent_task_inventory_Id.

pending

boolean

Indicates whether the task inventory item is ready for pickup at the location. The values are:

• false - the task inventory item is not ready for pickup
• true -the task inventory item is ready for pickup

price

number

The price of this task inventory item.

quantity

number

The quantity of this task inventory item.

scan_string

string

If a scan code is associated with this task inventory item, this is that scan code.

size

number

The quantity of this task inventory item.

source_task_id

number

If the task inventory item originated from another order, this is the Id of that other order.

task_id

number

The Id of the task with which this task inventory item is associated.

way_point_id

number

The Id of the way point with which this task inventory item is associated.

id

number

The Id of this task note.

author_name

string

The name of the author of this task note.

created_at

datetime

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

lat

number

The geoposition latitude at which this task note was created.

lng

number

The geoposition longitutde at which this task note was created.

note

string

The text of the task note.

title

string

The title of this task note.

type

string

The type of task note.

url

string

URL added to this note.

user_id

number

The Id of the user who created this task note.

way_point_id

number

The Id of the way point to which this task note is associated.

id

number

The Id of this team.

address

string

The address of this team.

allow_access_to_all_open_tasks

boolean

Indicates whether the team is allowed access to all open tasks.

beacon_ids

Array of Strings

An array of Ids for the beacons associated with the team.

contact_phone

string

The contact phone number for this team.

country_code

string

The country code of this team. The maximum length is 255 characters.

description

string

The description of this team.

distance_pay_per_km

number

The distance pay per kilometer for this team.

external_id

string

The Id of this team in your own system.

extras

Object

An extras object.

feature_flags

Object

An object containing key/value pairs for the features allowed in the merchant

home_area

Object

An object containing the home areas for this team.

lat

number

The geoposition latitude of this team's address.

lng

number

The geoposition longititude of this team's address.

merchant_id

number

The Id of the merchant.

name

string

The name of this team.

parent_team_id

string

The Id of the team to which this team is member.

printer_type

Object

An object containing the types of printer used to print receipts. The values include:

• 2inch
• 3inch

The default values is a blank (empty) string.

required_coc_type

number

The required chain of customer type for this team. The values are:

• 0 - weak
• 1 - strong
• 2 - none
• 3 - unload

service_boroughs

Array of Strings

An array of boroughs serviced by this team.

service_cities

Array of Strings

An array of cities serviced by this team.

service_zipcodes

Array of Strings

An array of ZIP Codes serviced by this team.

task_invoice_template_name

string

The name of the task invoice template for this team.

time_zone

string

The time zone of this team.

id

number

The Id of this new user.

access_token

string

The new user's access token for login.

active_shift_id

number

The Id of the user's current shift.

admin

boolean

Indicates whether this user is a Bringg administrator. The values are:

• false - the user is not an administrator
• true - the user is an administrator

at_home

boolean

Indicates whether the user is at home.

• false - the user is not at home
• true - the user is at home

authentication_token

string

The new user's authentication token.

authorization_flags

Object

A object containing user privileges.

average_rating

number

The user's average rating.

battery

number

The user's current battery.

beta

boolean

Indicates whether the user is a beta.

• false - the user is not a beta
• true - the user is a beta

blocked_email

boolean

Indicates whether this user's email is blocked. The values are:

• false - user's email is not blocked
• true - user's email is blocked

company

string

The name of the company.

confirmation_code

string

The confirmation code sent to this user's phone for login verification.

confirmation_code_sent_at

datetime

The date and time this user's confirmation code was sent. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

created_at

datetime

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

current_task_id

number

The Id of this user's current order.

default_user_activity

number

The user's default activity. The values are:

• 0 - unknown
• 1 - stationary
• 2 - walking
• 3 - running
• 4 - bicycle
• 5 - driving

delete_at

datetime

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

device_model

string

The model of the mobile device used by this user.

dispatcher

boolean

Indicates whether this user is a Bringg dispatcher. The values are:

• false - the user is not an dispatcher
• true - the user is an dispatcher

dispatcher_push_token

text

Pending Update

driver

boolean

Indicates whether this user is a Bringg driver. The values are:

• false - the user is not an driver
• true - the user is an driver

driver_current_sign_in_at

datetime

The date and time the user signed into the current session. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

driver_last_sign_in_at

datetime

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

driver_sign_in_count

number

The number of times the user signed into the app.

email

string

The email address of this customer. The maximum length is 255 characters.

estimated_last_address

string

The last known address of the user using approximation based on last or next delivery.

estimated_last_etl

datetime

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

estimated_last_lat

double

The last known latitude of the user using approximation based on last or next delivery.

estimated_last_lng

double

The last known longitude of the user using approximation based on last or next delivery.

estimated_last_waypoint_id

number

The Id of the last known way point for the user using approximation based on last or next delivery.

eta_to_home

datetime

The date and time of the expected time of arrival to home for this user. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

external_id

string

The customer's external Id.

fleet_id

number

If this user is assigned to an external fleet, this is the Id of that external fleet.

force_change_password_date

datetime

The date and time of this user will be required to change passwords. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

force_change_password_token

string

The token for this user's required change of passwords.

home_address

string

This user's (driver's) home address.

home_lat

float

The geolocation latitude of this user's (driver's) home address.

home_lng

float

The geolocation longitude of this user's (driver's) home address.

in_beacon_range

boolean

Indicates whether the user is in range of a known beacon.

• false - the user is not in range of a beacon
• true - the user is in range of a beacon

job_description

string

The user's job description. The maximum length is 255 characters.

language

string

The user's language.

lat

double

The geoposition latitude of the user when the customer tipped the user.

lng

double

The geoposition longitude of the user when the customer tipped the user.

merchant_id

number

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

mobile_type

number

The type of mobile.

mobile_version

string

The mobile version of the app.

name

string

The name of this customer. The maximum length is 255 characters.

num_ratings

number

The number of times the user (driver) was rated.

original_phone_number

string

The original phone number of this user, if the phone number was changed.

original_user_id

number

The original Id of this user, if the Id was changed.

password_hash

string

The hash of this user's password.

phone

string

The phone number of this customer.

private_vehicle

boolean

Indicates whether the user uses a private vehicle

• false - the user does use a private vehicle
• true - the user does not use a private vehicle

privilege_id

number

The Id of the privileges for this user.

profile_image

text

The URL of a profile image associated with this customer.

push_token

string

This customer's push token.

status

number

The user's status. The values are:

• Free
• Assigned
• Started
• Checked-In
• Late

sub

string

The sub status of the user. The maximum length is 255 characters.

team_ids

Array of numbers

An array of numbers containing the Ids of all teams to which this user belongs.

updated_at

datetime

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

user_type_id

number

The Id of the user type.

uuid

UUID

The universal unique Id of this customer.

vehicle_type_id

number

The Id of the user's vehicle type.

cost_per_shift

number

The user's payment per shift.

cost_per_task

number

The user's payment per task.

default_for_merchant

boolean

Indicates whether this new user type is the default for the merchange. The values are:

• false - the new user type is not the default user type.
• true - the new user type is the default user type.

external_id

string

The Id of this user type in your own system.

is_crowd

boolean

Pending Update

maximum_tasks_per_shift

number

The maximum number of allowed tasks per shift for this new user type.

max_total_weight

number

The maximum total weight a user with this user typ can carry.

merchant_id

number

The Id of the merchant for which a user type is to be created.

minimum_tasks_per_shift

number

The minimum number of allowed tasks per shift for this new user type.

title

number

The title of the new user type.

vehicle_height

number

The height of vehicles in this user type.

vehicle_length

number

The length of vehicles in this user type.

vehicle_width

number

The width of vehicles in this user type.

id

number

The Id of this way point.

address

string

The address of this way point.

address_second_line

string

The second line of the address of this way point.

allow_editing_inventory

boolean

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

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

allow_editing_payment

boolean

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

• false - the user (driver) is not allowed to change payment details and cost
• true - 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 - the user (driver) is not allowed to scan the inventory
• true - the user (driver) is allowed to scan the inventory

asap

boolean

Indicates whether this is an ASAP way point. The values are:

• false - this not an ASAP way point
• true - this is an ASAP way point

automatically_checked_in

number

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

automatically_checked_out

number

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

borough

string

The borough of this way point.

checkin_time

datetime

The date and time the driver arrived at this way point. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

checkout_time

datetime

The date and time the driver left this way point. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

city

string

The city of this way point.

contacts

Array of Objects

An array of Contacts objects associated with this way point.

customer

Object

The Customer object with which this way point is associated.

customer_id

number

The Id of the customer with which this way point is associated.

distance_traveled_server

number

The distance traveled towards the way point.

done

boolean

Indicates whether this way point is done. The values are:

• false - this way point is not done
• true - this way point is done

eta

datetime

The date and time of the driver's estimated arrival at the way point. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

etl

datetime

The date and time of the driver's estimated leaving at the way point. 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 way point. The values are:

• false - the find me feature is not enabled for this way point
• true - the find me feature is enabled for this way point

has_to_leave_by

datetime

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

inventory_changes

Array of Objects

An object containing the comments, and the date and time of each comment, for changes to the inventory. Each object contains the following two fields:

• comment - a string
• created_at - a datetime (This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z")

lat

number

The geoposition latitude of this way point.

late

boolean

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

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

lng

number

The geoposition longtitude of this way point.

must_approve_inventory

boolean

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

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

no_earlier_than

datetime

The date and time before which the driver cannot arrive at this way point. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

no_later_than

datetime

The date and time by which the driver must arrive at this way pont. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

note

string

The text of a note added to this way point.

pending_geocode

boolean

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

• false - geocode upload is not pending
• true - geocode upload is pending

phone

string

The phone at this way point.

position

number

The position of this way point in all way points in the order to which this way point belongs. For example, the order may contain 5 way points and this way point is position 2 (the second).

raiting

number

If the driver was rated at this way point, the rating.

scheduled_at

datetime

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

silent

boolean

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

• false - this way point is not invisible
• true - this way point is invisible

street

string

The street of this way point.

task_id

number

The Id of the task with which this way point is associated.

zipcode

string

The ZIP code of this way point.