OAuth 2.0 URLs

Access Bringg's API using either service or OAuth 2.0 URLs. Generate unique service URLs in the Bringg platform, or use the OAuth 2.0 format detailed below.

Before you begin, follow the steps in Bringg API Access Management to obtain an authentication token.

All Bringg OAuth 2.0 URLs are structured as follows:https://< domain >/services/< service name identifier >.

< domain > is based on the relevant Bringg distributed server.
All Bringg API URLs include/services/ after the domain and before the endpoint-specific identifier.
< service name identifier > is unique to each Bringg endpoint. See the complete list below.

For example, the OAuth 2.0 URL for the Create Order endpoint using the US2 server looks like this:
<https://us2-admin-api.bringg.com/services/create_task>

📘
API Domains and Regional Endpoints
Each Bringg merchant (and its associated data) is hosted and managed on one of Bringg's distributed server regions. Each server region is geographically and physically separated from the others, but for most purposes, public access is via a common, security gateway: app.bringg.com.
For some API purposes however - such as for OAuth 2.0 - it may be required to call your own server region's endpoints directly. In these cases, please substitute the domains as follows:
US2: https://us2-admin-api.bringg.com
US3: https://us3-api.bringg.com
EU2: https://eu2-admin-api.bringg.com
EU3: https://eu3-admin-api.bringg.com

NAME	SERVICE NAME IDENTIFIER
Create Order (Task)	create_task
Update Order	update_task
Start Order	start_task
End Order (Task)	end_task
Cancel Order (Task)	cancel_task
Get Order	get_task
Get Open Orders (Tasks)	get_open_tasks
Create Note	create_note
Update Note	update_note
Arrived to Destination (Check in)	checkin
Left Destination (Checkout)	checkout
Get Post Optimization Orders (Tasks)	get_post_optimization_tasks
Create Customer	create_customer
Update Customer	update_customer
Create User (i.e. Driver / Dispatcher/ Admin)	create_user
Update User (i.e. Driver / Dispatcher/ Admin)	update_user
Get User	get_user
Delete User	delete_user
Start Shift	start_shift
End Shift	end_shift
Driver Home Events	driver_home_events
Create Team	create_team
Update Team	update_team
Show All Teams	team_index
Get Team Details	get_team
Delete Team	delete_team
Get Share	get_share
Get Quotes	get_quotes
Create Order Configuration	create_task_configuration
Get Driver Availability	get_realtime_availability
Generate Driver QR Code	generate_driver_qr_code
Create Delivery Block	create_delivery_block
Get Delivery Block	get_delivery_block
Assign Delivery Block to Driver	assign_delivery_block
Unassign Delivery Block from Driver	unassign_delivery_block
Update Delivery Block	update_delivery_block
Delete Delivery Block	delete_delivery_block
Get Drivers' Delivery Blocks	users_delivery_blocks
Team Delivery Blocks	team_delivery_blocks
Generate Pickup QR Code	generate_pickup_qr_code
Create Parking Spot	create_parking_spot
Update Parking Spot	update_parking_spot
Get All Parking Spots	get_parking_spot
Get Parking Spot by ID	get_by_id_parking_spot
Delete Parking Spot	delete_parking_spot
Create Vehicle	create_vehicle
Update Vehicle	update_vehicle
Get Vehicle by ID	get_vehicle_by_id
Get All Vehicles	get_all_vehicles
Delete Vehicle by ID	delete_vehicle
Create Order Payment Details	create_task_payment_history
Create Delivery Slot	create_planned_delivery_window
Update Delivery Slot	update_planned_delivery_window
Generate Undelivered Webhooks Report	get_undelivered_webhooks
Get Report	get_report
Create Order Refund	create_task_refund

📘API Domains and Regional Endpoints

📘
API Domains and Regional Endpoints