Implement your Integration with Bringg as a Carrier
13 Apr 2023
12 Minutes to read
Share this
Print
Share
Dark
Light
Contents
Implement your Integration with Bringg as a Carrier
Updated on 13 Apr 2023
12 Minutes to read
Print
Share
Dark
Light
Article Summary
As the IT integrator of a carrier, you can integrate your systems with the Bringg Platform to receive orders from shippers by adding Bringg's APIs and webhooks to your systems. Use the Bringg Integrations Portal to discover the APIs and webhooks needed, and access a dedicated staging site for you to test your integrations before going live.
Once you finish planning your integrations together with your business manager as well as with Bringg, map the names of your objects and fields with those Bringg uses. Then use the Integrations Portal to set up the Bringg APIs and webhooks. Once you have completed the set-up process, continue to the next topic to begin testing in staging and production.
Implement your Bringg integration to partner with shippers
For example, set up an endpoint to receive webhook notifications from Bringg when a shipper creates, updates, or cancels a delivery request.
Before You Begin
Contact your Bringg customer service representative to verify your login credentials to the Bringg Integrations Portal.
Meet with your business manager to understand the data flows and their triggers between Bringg and your enterprise systems.
Identify the technical capabilities you support such as quotes, driver location updates, proof of delivery, multi-package shipment, and so on.
Procedure
Step 1: Sign in to the Integrations Portal at fleet.bringg.com using the credentials Bringg gave you.
Open the Integrations Portal
The Integrations Portal includes a unified implementation platform for both staging and production, step-by-step guidelines outlining the integration process, and access to all the necessary keys and endpoint URLs.
Note
You can receive login credentials only once Bringg approves working with you. Contact your Bringg customer service representative to learn more.
Step 2: Review the API calls and webhooks Bringg used in the context of sample delivery flows, like happy flows as well as canceled and returned items.
Understand Bringg APIs and webhooks within different flows
Step 3: Perform a detailed analysis with your colleagues from business and operations to identify the events which trigger a Bringg API or webhook, and identify the correct API or webhook to implement your integration.
Tip
Bringg updates you about changes coming from the shipper using webhooks, while you update Bringg through APIs.
When this happens...
Trigger this event...
Transfer this data...
Direction of flow
Request API authorization
Get Token (API)
You request an authorization token from Bringg using the Client ID and Client Secret for a particular shipper. Learn more.
carrier to Bringg
New shipper registration
Merchant Registered (webhook)
Bringg sends you the identification information of a shipper who registers to work with you. Your IT integrator can then access their credentials in the integration sandbox.
You need to retrieve credentials of a shipper who registers to work with you
Get Merchant Credentials (API)
You want the technical credentials for the shippers who register to work with you. Learn more.
carrier to Bringg
Shipper requests a quote
Get Quote (webhook)
(Recommended) Send a quote response with your estimated delivery price and your availability to complete the order. The shipper may also request details like ETA, ability to fulfill green delivery, and so on.
Bringg notifies you that a shipper wants you to deliver goods, so you create a delivery in your system with an identification and the terms of the delivery that you quoted.
Share any authorized identification information about the driver who receives the assignment or reassignment. The shipper passes this to consumers for better customer experience, added feeling of safety, and so on. This is also where you can add a cost to the order once you know who is delivering it.
(Recommended) Share the timestamp and exact geolocation of the driver as they leave the pickup location. Upon leaving the dropoff location, use the Complete Order API instead.
Bringg notifies you that the shipper canceled the order and includes a reason why, like if the customer decides to cancel it. This helps you know you can end a delivery immediately and avoid wasting time and resources.
(Optional) The Shipper requests that your driver take the inventory item back to the fulfillment center, so it creates a new delivery with the same order id.
You must authorize each API call with a bearer token that utilizes the Client ID and Client Secret available in the Integrations Portal. To receive the token from Bringg, use the Get Token webhook. The token is valid for only 30 minutes. Learn more.
Step 4: Find the API keys for your testing shipper sandbox in Registered Merchants.
Each shipper has a separate API key for their staging and production accounts respectively. The key appears in the header of all webhooks that Bringg sends you so that you can identify from which shipper they originate.
Copy the API key for the sandbox shipper to test webhooks.
Tip
Once you complete end-to-end testing using the sandbox shipper , you can access API keys for any other shippers who register to work with you in Registered Merchants. Learn more.
Step 5: Set up the endpoint URLs to listen for webhook events from Bringg.
Tip
You need separate endpoint URLs for your staging and production environments. All staging shipper webhooks reach your staging endpoints, while all production shipper webhooks reach your production endpoints.
Step 6: Enter your endpoint URLs for each webhook Bringg sends you. This includes mandatory as well as optional webhooks you listen to.
For example, enter a staging and production endpoint URL for when Bringg notifies you when any shipper creates a delivery for you to fulfill.
Input endpoint URLs for each environment you use
Step 7: Copy the Bringg API endpoints for any calls you send Bringg as part of the delivery flow, including common API calls as well as those used only in edge cases.
Include URLs for recommended technical capabilities like driver location updates.
For example, copy the endpoints for when you assign a driver to a delivery or when the driver is unable to complete a delivery and cancels it.
Check Registered Merchants > Endpoint Prefix to verify which Bringg URL aligns with the Bringg environment the sandbox shipper uses. Once you complete the end-to-end testing using your sandbox shipper, you will do the same to set up implementations with other registered shippers.
Select the URL corresponding to the Bringg environment the shipper uses
Step 8: Configure the JSON payloads for webhook responses and API calls. Learn more.
For example, send this payload when assigning a delivery to a new driver.
You can customize your payloads according to the details you want to share. For example, you can include a driver's name for greater transparency to increase shipper and customer satisfaction.
Step 9: Begin testing your integrations using the simulated sandbox shipper in the Integrations Portal to prepare for testing with active shippers and going live. Learn more.
A delivery provider (DP) offers their fleet of vehicles to fulfill orders on behalf of the shipper. carriers promise different levels of service, cover specific territories, and may specialize in different types of goods and services, such as parcel retail, restaurant, and grocery delivery. You can add more carriers to expand your service coverage by finding the best fit for your business in our carrier catalog.
There are two types of carriers:
Carriers are often the more established carriers with their own branded fleet of vehicles and drivers, which they offer to shippers to fulfill their orders. Carriers can typically deliver higher volumes and a wider variety of goods around the world, and can therefore batch planned orders together, sometimes several days in advance, to offer shippers cheaper rates.
A crowd-sourced last mile carrier uses independently contracted drivers to populate its fleet. Since the drivers usually use their own vehicles, this type of carrier often fulfills hyper local orders that require more immediate fulfillment (on demand, same day, or next day orders). Their wide pool of local drivers enables them to offer cheaper rates for these deliveries.
The Bringg Platform is the leading cloud provider for delivery and fulfillment, helping you scale and optimize your last mile delivery operations and omnichannel customer experiences. With a real-time view of the delivery process, you get the visibility you need to ensure goods and services reach consumers safely, affordably, and on time.
Bringg empowers a collaborative ecosystem, putting the power back in your hands to drive exceptional delivery experiences at minimum cost.
Bringg helps you make fast, accurate decisions by alerting you to potential problems before they become larger issues, and presenting the information needed for you to react. With Bringg, you can fulfill orders efficiently, with more peace of mind, and better consumer satisfaction.
Bringg helps you keep pace with consumers' growing demands by offering them flexible options like express shipping, Click & Collect, green delivery, and the ability to schedule delivery when they choose.
With Bringg 's Delivery Hub you can access a diverse global network of 300+ delivery providers to expand your business and meet changing market demands. Learn more.
Increase efficiency with optimized routes and AutoDispatch, and keep track of your overall performance with real time report data.
An order is a request for fulfillment of goods and services at a specific destination. It includes all information needed to complete it, such as the requested service or goods, the consumer's contact information, up to two destinations (e.g. pickup and delivery), and the time window.
The properties of the order's goods or services determine the vehicle and skills required to fulfill that order. For example, food deliveries may require a refrigerated vehicle while an appliance installation requires a driver with the relevant training.
You fulfill orders by assigning them to a driver, store associate, or delivery provider. You can also assign orders to routes and then assign each route to a vehicle and driver.
Inside the Bringg database and payloads an order is sometimes referred to as a task.
A carrier quote is an estimate from a carrier for the time or price to fulfill a specific order, and often includes more details like their availability to deliver, predicted ETA, and so on.
Bringg's fleet router requests a carrier quote for each order from all qualified carriers and assigns the order to the best one according to your preferences.
Enter your delivery strategy in Bringg to qualify carriers automatically.
As a driver using the Bringg Driver App, you can sign up to a shift and see the orders in your route as a list of destinations and breaks, with contact information for each order, extra notes from the consumer or dispatcher and step-by-step instructions to handoff successfully. The Bringg Platform has already optimized your route, and you can navigate turn-by-turn with your favorite map app.
An order flow defines all the stages of fulfillment from when an order enters Bringg to when the order is completed or cancelled.
You can define order flows for different types of goods and consumers to fit your company's policy. These flows can determine who prepares the order, its time window, and the driver actions to complete fulfillment.
If you mark a step as mandatory, the flow cannot proceed until the driver starts and completes this step. For example, you may define a separate flow for prescription medicines to require a signature at handoff.
Building order flows includes all eventualities, including defining the steps for drivers if goods are damaged. Or, if you work mostly with Own Fleet, you may need a spillover plan to assign orders to carriers during high volume periods.
The Bringg Driver App can prompt drivers to perform driver actions for any order, or only those which have certain types of goods. It can suggest to perform these actions at the start of a shift, at the end, or during handoff (after check-in or before checkout).
You can add variations to your order flows using service plans in order to offer consumers different levels of service. For example, a basic plan may assign default delivery slots, while over the threshold plans may offer consumers faster fulfillment, or the option to choose a specific arrival date or time.
An order is a request for the fulfillment of goods and services at a specific address. It includes all information needed to complete it, such as the requested service or goods, the customer’s contact information, required services (such as fragile care), and the time window.
The estimated time of arrival (ETA) is the time a driver is expected to arrive at a destination. Bringg's route optimization typically schedules an order's ETA to be within its time window.
Green delivery defines when an Own Fleet or carrier can fulfill orders using sustainable and eco-friendly means. This can be accomplished by using sustainable materials and eco-friendly vehicles (such as electric or hybrid vehicles, bicycles, or electric scooters) or committing to achieving carbon neutrality by investing in carbon offset projects (such as planting trees).
A time window is the time range when you intend to fulfill an order. Therefore, an order is considered fulfilled on time if it arrives within the time window. The time window is set when you schedule an order in Bringg and is usually defined by the no_earlier_than and no_later_than fields. Narrower time windows are seen as better service, like 9 to 10 am, while longer windows are more typical of larger carriers.
You can share the time window with your consumers for an improved experience. For example, if a consumer places an order for the 8:00-12:00 the following day, in the morning notify them that you intend to arrive between 8:00-9:00.
If you allow consumers to select their preferred delivery slot, the time window is scheduled accordingly.
Green delivery defines when an Own Fleet or carrier can fulfill orders using sustainable and eco-friendly means. This can be accomplished by using sustainable materials and eco-friendly vehicles (such as electric or hybrid vehicles, bicycles, or electric scooters) or committing to achieving carbon neutrality by investing in carbon offset projects (such as planting trees).
Was this article helpful?
Thank you for your feedback! Our team will get back to you