> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Bringg

> How to set up the Bringg connector, plus the actions that are available.

![Bringg](https://stackone-logos.com/api/bringg/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/bringg/changelog.md)

[55 actions](#actions) · 1 auth method

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/bringg/guides/connector-profile/oauth-2-0.md)
>
> Requires creating an OAuth2 API app in Bringg. Access is limited to the scopes selected on that app, and tokens are re-i...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/bringg/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

55 actions

ActionDescription

Generate Undelivered Webhooks Report`bringg_get_undelivered_webhooks`

This API retrieves a list of webhooks which Bringg sent without receiving a confirmation during a specified time period....

Get Report`bringg_get_report`

Use this API to get the latest version of a scheduled analytics report. This method redirects requests to a data file.

Create Customer`bringg_create_customer`

Use to create a new customer.

Update Customer`bringg_update_customer`

Use to update a customer's details.

Create Delivery Block (Resource-based Optimization)`bringg_create_delivery_block`

Create a new delivery block that considers resource availability, and allows you to add and pair drivers and vehicles wi...

Get Delivery Block`bringg_get_delivery_block`

Get the details of a delivery block by delivery block Id.

Assign Delivery Block To Driver`bringg_assign_delivery_block`

Assign a driver or drivers to a delivery block by driver ID(s) and delivery block ID.

Unassign Delivery Block From Driver`bringg_unassign_delivery_block`

Unassign a delivery block from a driver or drivers by driver Id(s) and delivery block Id.

Update Delivery Block (Resource-based)`bringg_update_delivery_block`

Make updates to an existing delivery block, including adding or removing resources.

Delete Delivery Block`bringg_delete_delivery_block`

Delete a delivery block by its Bringg delivery block ID, removing its driver and vehicle resource assignments.

Get Drivers' Delivery Blocks`bringg_users_delivery_blocks`

Gets a list of delivery blocks assigned to specified drivers by time range.

Get Team Delivery Blocks`bringg_team_delivery_blocks`

Gets a list of delivery blocks assigned to a specific team by time range.

Create Delivery Slot`bringg_create_planned_delivery_window`

Create delivery slots (previously known as Planned Delivery Windows) to represent fulfillment availability by time and d...

Update Delivery Slot`bringg_update_planned_delivery_window`

Update delivery slots (previously known as Planned Delivery Windows) to allow customers to schedule their orders.

Check-in (Arrived To Destination)`bringg_checkin`

Use to indicate that the driver arrived at a destination in the order.

Checkout (Left Destination)`bringg_checkout`

Use to indicate the driver left a destination. If the driver checks out of the last destination, then this API call will...

Initiate Driver Home Events`bringg_driver_home_events`

Use to determine whether a driver is at or has departed their "home" base.

Get Driver Availability`bringg_get_realtime_availability`

Use to get the driver availability details of drivers in the teams you specify.

Start Shift`bringg_start_shift`

Use to start a driver's shift.

End Shift`bringg_end_shift`

Use to end a driver's shift.

Generate Driver QR Code`bringg_generate_driver_qr_code`

Use to generate an access token and secret key for the Driver App QR Code login of a specified driver.

Create Note`bringg_create_note`

Use to create a note for a waypoint.

Update Note`bringg_update_note`

Make text updates to an existing note

Create Order Configuration`bringg_create_task_configuration`

Use to create task configurations which are sets of operational capabilities you can apply to specific sets of tasks usi...

Create Order (Task)`bringg_create_task`

Send the details of a new order to Bringg from your Order Management System (OMS).

Update Order`bringg_update_task`

Update the details of an order (also known in Bringg as a task).

Start Order`bringg_start_task`

Use to start an order (task).

End Order`bringg_end_task`

Use to end an order (task).

Cancel Order (Task)`bringg_cancel_task`

Use to cancel an active order (task).

Get Order`bringg_get_task`

Get the details of an order using its id or external\_id. The response also includes details of any linked orders.

Get Open Orders (Tasks)`bringg_get_open_tasks`

Use to get a list of open orders.

Get Post Optimization Orders (Tasks)`bringg_get_post_optimization_tasks`

Get a list of post-optimization orders.

Create Order Refund`bringg_create_task_refund`

Use this API to create an order refund in Bringg. This is used in Analytics reports only.

Generate Pickup QR Code`bringg_generate_pickup_qr_code`

Use to generate QR Code for a task to be scanned by the driver

Create Parking Spot`bringg_create_parking_spot`

Use this endpoint to create a parking spot in Bringg and associate it with a specified team and address.

Update Parking Spot`bringg_update_parking_spot`

Update a parking spot using either the ID created by Bringg or your external ID.

Get All Parking Spots`bringg_get_all_parking_spots`

Get the details of all parking spots.

Get Parking Spot By ID`bringg_get_parking_spot_by_id`

Get a parking spot using either the ID created by Bringg or your external ID.

Delete Parking Spot`bringg_delete_parking_spot`

Delete a parking spot using either the ID created by Bringg or your external ID.

Get Quotes`bringg_get_quotes`

The quotes service check when, who, and at what cost an order can be delivered, considering the order's requirements. Th...

Create Team`bringg_create_team`

Create a new team (fleet, store or warehouse group) in Bringg with its address, contact details and dispatch settings.

Update Team`bringg_update_team`

Update the details of a team using its Bringg ID or your system's ID (external\_id).

Show All Teams`bringg_team_index`

Use to return all the teams for a merchant.

Get Team Details`bringg_get_team`

Get the details of a team using its Bringg id.

Delete Team`bringg_delete_team`

Delete a team from Bringg using its Bringg team ID.

Create User`bringg_create_user`

Create a new driver or dispatcher in Bringg.

Update User`bringg_update_user`

Update a user's details by external\_id or Bringg id.

Get User`bringg_get_user`

Get the details of a user (driver, dispatcher, or admin) using their external\_id or Bringg id.

Delete User`bringg_delete_user`

Use to delete a user (driver, dispatcher, or admin).

Create Vehicle`bringg_create_vehicle`

Use to create a vehicle or trailer in Bringg.

Get Vehicle`bringg_get_vehicle_by_id`

Get the details of a specific vehicle using its external\_id or the id generated by Bringg.

Get All Vehicles`bringg_get_all_vehicles`

Get the details of all vehicles in Bringg.

Update Vehicle`bringg_update_vehicle`

Update the details of a vehicle or trailer in Bringg, for example to assign a team or parking spot.

Delete Vehicle`bringg_delete_vehicle`

Delete a specific vehicle using its external\_id or the id generated by Bringg.

Get All Vehicle Profiles`bringg_get_vehicle_types`

Retrieve a list of all vehicle profiles (vehicle types) for your merchant.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.