Bringg
Guides
API Reference
Changelog
{{user.name}}
Log In
Get Started
v1.0
v1.0
stable
Home
Guides
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Tutorials
Guides
API Reference
Changelog
discard
Save Edits
Submit
Suggested Edits
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.subdomain ? 'in ' + result.subdomain : ''}}
{{result.method}}
Reference {{result.subdomain ? 'in ' + result.subdomain : ''}}
Changelog {{result.subdomain ? 'in ' + result.subdomain : ''}}
Discussions {{result.subdomain ? 'in ' + result.subdomain : ''}}
Page {{result.subdomain ? 'in ' + result.subdomain : ''}}
View All Results
Guidelines
Overview
About Bringg
Main players and entities
The Basic Workflow
Bringg Use Cases
REST
Resources
Application
Company_Configuration
Companies
Customers
Form
Inventories
Places
Tasks (Orders)
Teams
Users
Way_Points
User_Configurations
Code Samples
Bringg Services
Bringg Webhooks
Bringg Tags
Bringg Applications
FAQs
Bringg SDK
Bringg SDK Terms of Service
Bringg SDK for Javascript
Customer SDK for Android
Customer SDK for iOS
Driver SDK for iOS
Getting Started
loginManager
shiftManager
tasksManager
logReportsManager
Resources
Driver SDK for Android
Getting Started
Authentication
Shifts
Task Flow Handling
Inventory Management
Observe data and state changes
Driver SDK for Android (Deprecated)
Getting Started
BringgSDKClient
Authentication
User Data
Shifts
Tasks
Reporting Driver Location
Data Models
Examples
Real-Time Events
Dispatcher SDK
Getting Started
Initializing a Session
Exception Handling
Resources
Merchants
Merchant Configurations
Users
User Types
Teams
Tasks
Click & Collect SDK for Android
Installation
Permission Management
Initialization
ActiveCustomerActions Interface
Customizing the experience
Optional: Registering for login live data events
Optional: Registering for online live data events
Optional: Registering task state live data
Example Code
Click & Collect SDK for iOS
ActiveCustomerManager
Click & Collect SDK for React Native
Usage
Fleet Self-Registration
Overview
Terminology
What Can You Expect From Bringg
What Is Expected From You
Get Started With Sandbox
Conducting End-To-End Test
Getting Certified
Merchant Adds Your Fleet
Webhooks
Merchant Registered Webhook
Delivery Created Webhook
Delivery Updated Webhook
Delivery Cancelled Webhook
Get Quote Webhook
API Calls
Get Token
Get Merchant Credentials
Assign Driver
Start Order
Update Driver Location
Check In / Driver Arrives to Location
Create Note / Add POD (Proof of Delivery)
Check Out / Driver Leaves Location
Complete Order
Cancel Order
Cluster Checkin/Checkout
Troubleshooting
Guidelines
Overview
About Bringg
Main players and entities
The Basic Workflow
Bringg Use Cases
REST
Resources
Application
Company_Configuration
Companies
Customers
Form
Inventories
Places
Tasks (Orders)
Teams
Users
Way_Points
User_Configurations
Code Samples
Bringg Services
Bringg Webhooks
Bringg Tags
Bringg Applications
FAQs
Bringg SDK
Bringg SDK Terms of Service
Bringg SDK for Javascript
Customer SDK for Android
Customer SDK for iOS
Driver SDK for iOS
Getting Started
loginManager
shiftManager
tasksManager
logReportsManager
Resources
Driver SDK for Android
Getting Started
Authentication
Shifts
Task Flow Handling
Inventory Management
Observe data and state changes
Driver SDK for Android (Deprecated)
Getting Started
BringgSDKClient
Authentication
User Data
Shifts
Tasks
Reporting Driver Location
Data Models
Examples
Real-Time Events
Dispatcher SDK
Getting Started
Initializing a Session
Exception Handling
Resources
Merchants
Merchant Configurations
Users
User Types
Teams
Tasks
Click & Collect SDK for Android
Installation
Permission Management
Initialization
ActiveCustomerActions Interface
Customizing the experience
Optional: Registering for login live data events
Optional: Registering for online live data events
Optional: Registering task state live data
Example Code
Click & Collect SDK for iOS
ActiveCustomerManager
Click & Collect SDK for React Native
Usage
Fleet Self-Registration
Overview
Terminology
What Can You Expect From Bringg
What Is Expected From You
Get Started With Sandbox
Conducting End-To-End Test
Getting Certified
Merchant Adds Your Fleet
Webhooks
Merchant Registered Webhook
Delivery Created Webhook
Delivery Updated Webhook
Delivery Cancelled Webhook
Get Quote Webhook
API Calls
Get Token
Get Merchant Credentials
Assign Driver
Start Order
Update Driver Location
Check In / Driver Arrives to Location
Create Note / Add POD (Proof of Delivery)
Check Out / Driver Leaves Location
Complete Order
Cancel Order
Cluster Checkin/Checkout
Troubleshooting
Support
Services API
post
Create Order (Task)
post
Update Order (Task)
post
Start Order (Task)
post
End Order (Task)
post
Cancel Order (Task)
post
Get Order (Task)
post
Open Orders (Tasks)
post
Create Note
post
Update Note
post
Arrived to Location (Check-in)
post
Left Location (Check-out)
post
Post Optimization Orders (Tasks)
post
Create Customer
post
Update Customer
post
Create User
post
Update User
post
Get User
post
Delete User
post
Start Shift
post
End Shift
get
Get Shifts Schedule
post
Driver Home Events
post
Create Team
post
Update Team
post
Show All Teams
post
Get Team Details
post
Delete Team
post
Get Share
post
Import Orders CSV
post
Import Orders CSV (async)
post
Import Orders CSV Progress
post
Import Users CSV File
post
Import Users CSV API
post
JustEat Integration
post
eCourier Integration
post
Get Quote
post
Create Task Configuration
get
Get Real-time Driver Availability
post
Create Quote For External Fleet
get
Get Quote Status For External Fleet
post
Generate customer one-time code
post
Generate Driver QR Code
post
Create a Delivery Block
get
Get Delivery Block
post
Assign a Driver to a Delivery Block
post
Unassign a Driver from a Delivery Block
post
Update a Delivery Block
get
Delete a Delivery Block
post
Drivers Delivery Blocks
post
Team Delivery Blocks
post
Create Blacklisted Customer Driver
post
Delete Blacklisted Customer Driver
get
Get List of Blacklisted Customer Drivers
post
Generate Pickup QR Code
post
Create Vehicle
post
Create Task Payment Details
post
Create Planned Delivery Window
post
Update Planned Delivery Window
post
Create Inventory
post
Update Inventory
Services API: Menu
get
Get Menu
Webhooks
Any Scan
Customer Created
Customer opted in to SMS
Customer opted out of SMS
Customer Tipped Driver
Driver Arrived On Location
Driver Changed Type
Driver On Way
Driver Left Home
Driver Got Home
Order Created
Order Assigned To Driver
Order Accepted By Driver
Order Was Rejected By Driver
Order Unassigned From Driver
Order Was Marked Late
Order ETA Changed
Order Is Cancelled
Order Is Done
Task Rescheduled
Arrived To Way Point
Left Way Point
Note Was Added to Task
Form Was Added To Task
Shift Started For Driver
Shift Ended For Driver
Inventory scanned
Shared Location Created (SMS Sent)
Planning Done
Schedule Change
Masked Call
Task Payment History
Objects
Task Status - List
Cancel Reasons Object
Customer Object
Task Inventories Object
Task Notes Object
Waypoint Object
Run Object
Overview
Suggest Edits
Updated 4 months ago
Table of Contents
{{ node.data[1] }}
{{ node.data[1] }}
Table of Contents
{{ node.data[1] }}
{{ node.data[1] }}
Overview
Suggested Edits are limited on API Reference Pages
You can only suggest edits to Markdown body content, but not to the API spec.
Updated 4 months ago