GuidesAPI Reference
Log In
API Reference

Team Object

The Team object is included in the Create and Update team API requests, and can also be included in various webhooks.

About the Team Object

A team groups together the people and resources needed to fulfill orders from a specific fulfillment center or service area. It can consist of drivers, dispatchers, vehicles, and orders. Teams are essential for managing logistics efficiently, ensuring that the right resources are assigned to each order, and fulfilling deliveries in a timely manner.

For example, a team might cover all orders and drivers associated with a particular store location or could focus on a specific type of delivery, such as refrigerated goods. The team structure allows dispatchers and drivers to coordinate their efforts within a defined scope, which is crucial for streamlining operations and meeting business goals.

Managing Teams

Use Bringg's API to manage teams:

You can also create teams directly in the Bringg Platform.

Assign a Team to an Order

You can assign a team to an order via API by including the team_id or team_external_id field in the Create Order (Task) payload.

Team Details

FieldDescriptionValidations and Notes
*address**
string		The first line of the address associated with the team.
  • Required.
  • Maximum 255 characters.
*address_second_line**
string		The second line of the address associated with the team.
*contact_phone**
string		The contact phone number for the team's dispatcher.
  • Required
    - Must be a valid phone number format
*country_code**
string		The two-letter ISO country code of the team’s location.
*default_customer_id**
int64		The default customer ID associated with this team.
*default_user_id**
int64		The default user (driver) ID for this team.
*description**
string		Additional details about the team.
  • Max length: 500 characters
*distance_pay_per_km**
float		The cost per kilometer for the team.
*emergency_contact_name**
string		Name of emergency contact (for use with the Rapid SOS application).
*emergency_contact_phone**
string		Phone number of emergency contact (for use with the Rapid SOS application).
*external_id**
string		Your external system's ID for the team.
  • Must be unique across teams
*extras**
object		Internal use or additional configuration data.
*franchisee_id**
int64		The Bringg ID for the related franchisee.
*geohash**
string		The geohash of the team's address.
*home_area**
object		An object containing home areas for the team.
*lat**
float		The latitude of the team's location.
  • Auto-populated from address if omitted
*lng**
float		The longitude of the team's location.
  • Auto-populated from address if omitted
*name**
string		The name of the team, such as a store or service area.
  • Required
    - Max length: 255 characters
*parent_team_id**
int64		The ID of the parent team associated with this team.
*printer_type**
string		The type of printer used by the team (e.g., 3", A4).
*service_boroughs**
array of strings		An array of boroughs serviced by the team.
*service_cities**
array of strings		An array of cities serviced by the team.
*service_zipcodes**
array of strings		An array of ZIP codes serviced by the team.
*time_zone**
string		The time zone of the team.
  • Required
    - Valid time zone values only
*web_site**
string		The website URL associated with the team.
*zipcode**
string		The ZIP code of the team's location.

Response and Webhook Data

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


ParameterDescription
*success**
boolean		Indicates whether the service completed successfully.
  • false* - the service failed.
  • true* - the service succeeded
*message**
string		If an error occurred, a message indicating the error is included.
*rc**
integer		If an error occurred, the return code is included.
*allow_access_to_all_open_tasks**
boolean

Indicates whether drivers receive unassigned tasks.

false - the drivers do not receive unassigned tasks.
true - the drivers do receive unassigned tasks.

*address**
string		The first line of the address associated with the team.
*address_second_line**
string		The second line of the address associated with the team. e.g. "1st floor", "Apartment 5a".
*beacon_ids**
array of strings		An array of beacon IDs associated with the team.
*city**
string		The city where the team is located.
*contact_phone**
string		The contact phone number associated with this team.
*country_code**
string		The two-letter ISO country code of the team’s location.
*created_at**
datetime		The timestamp when the user was created. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".
*default_customer_id**
int64		The default customer ID for the team.
*default_task_configuration_id**
int64
*default_user_id**
int64		The default user (driver) ID for the team.
*delete_at**
datetime		The timestamp when the team was deleted.
*description**
string		Additional details about the team.
*distance_pay_per_km**
float		The cost per kilometer for the team.
*emergency_contact_name**
string		Name of emergency contact (for use with the Rapid SOS application).
*emergency_contact_phone**
string		Phone number of emergency contact (for use with the Rapid SOS application).
*external_id**
string		Your system's ID for the team.
*extra**
object		Internal use.
*extras**
object		Internal use.
*franchisee_id**
int64		The Bringg ID for the related franchisee.
*geohash**
string		The geohash (public domain geocoding system hash) of this team.
*home_area**
object		An object containing the home area for this team.
*id**
int64		The unique identifier of the team.
*lat**
float		The geoposition latitude of the team's address.
*lng**
float		The geoposition longitude of the team's address.
*merchant_id**
int32		The ID of the merchant to which the team belongs.
*name**
string		The name of the team, such as a store or area.
*parent_team_id**
int64		The ID of the parent team associated with this team.
*printer_type**
string		The type of printer used to print receipts. The values are:
3"
A4
*required_coc_type**
string		The required chain of custody type. The values include:
  • 0* - weak
  • 1* - strong
  • 2* - none
  • 3* - unload
*service_boroughs**
array of strings		An array of boroughs serviced by the team.
*service_cities**
array of strings		An array of cities serviced by the team.
*service_zipcodes**
array of strings		An array of ZIP codes serviced by the team.
*state**
string		The state where the team is located.
*street**
string		The street where the team is located.
*task_invoice_template_name**
string
*team_type**
string
*time_zone**
string		The time zone of the team.
*updated_at**
datetime		The last date and time this team was updated. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".
*web_site**
string		The website URL associated with the team.
*zipcode**
string		The ZIP code of the team's location.

Updated 12 months ago

Did this page help you?

Updated 12 months ago

Did this page help you?