---
title: "Test your Integrations with Bringg as a Carrier"
slug: "test-your-integrations-with-bringg-as-a-carrier"
tags: ["Admin", "On Demand", "Partner", "Delivery Hub", "Planned"]
updated: 2023-06-19T07:59:33Z
published: 2023-06-19T07:59:33Z
canonical: "help.bringg.com/test-your-integrations-with-bringg-as-a-carrier"
stale: true
---

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

# Test your Integrations with Bringg as a Carrier

Once you complete the initial implementation of your Bringg integrations, use the Bringg Integrations Portal to thoroughly test and ensure the communication flow with shippers works effectively before going live. Simulate a shipper by creating test orders to verify that you configured your endpoints correctly. Test each API and webhook end to end, first using simulated orders in your Bringg sandbox account. Once Bringg certifies your integrations, implement and test them with your registered shippers as well, first with their staging environments, and eventually moving to production.

For example: check that you receive an event notification (webhook) when a delivery request is created in Bringg, and that Bringg receives an API call when your driver starts the delivery.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/image-1678715217676.png)***Test your Bringg integration***

#### Before You Begin

- Ensure you have added all the APIs and webhook endpoints to match your order delivery flows and capabilities, including standard (happy), cancellation, returns, or bulk pickup flows. [Learn more](/v1/docs/implement-your-integration-with-bringg-as-a-carriert).
- Coordinate with Bringg and registered shippers to ensure viability of end-to-end testing. Ensure that you have communication flows for each delivery scenario and that the shipper is ready to begin testing.

#### Procedure

**Step 1**: Sign in to the Integrations Portal at [fleet.bringg.com](http://fleet.bringg.com) using the credentials Bringg gave you.

**Step 2**: Begin with the sandbox simulation in the Integrations Portal by selecting **Dispatch** from the navigation bar.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/image-1678715266216.png)***Navigate to Dispatch to begin testing your integrations***

This page offers you a visualization of the order creation process using your own sandbox shipper account that triggers notifications to and from your system.

**Step 3**: (Optional) Select **Get Quote** to test that the **Get Quote** webhook request reaches the endpoint URL your provided to Bringg.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/image-1678715288337.png)***Activate and test the Get Quote webhook***

If your integration works correctly, your company's system returns a response with the carrier quote details.

Choose this option only if your company supports carrier quotes.

**Step 4**: Review and edit the payload data to ensure the webhook sends the order information your system needs to see.

You can choose to select and edit fields from a default list of order fields, or paste your own custom payload in JSON or XML format.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/image-1678715311192.png)***Select the fields you want to include or add a custom payload***

**Step 5**: Select **Create Order** to start the sandbox shipper's delivery creation process.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/image-1678715329621.png)***Simulate a shipper activating a delivery creation***

Selecting this option generates a test order in the sandbox shipper account using two random geolocations within a set delivery radius taken from the sandbox shipper's address settings.

The order appears in the list on the dispatch page but remains **Unassigned** to a carrier.

**Step 6**: Select the order's row in the **Fleet** column to select your company as the carrier for that order.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/image-1678715356914.png)***Assign your company as the carrier.***

This sends the **Delivery Created** webhook to the endpoint URL you provided Bringg. Review and edit the **Delivery Created** webhook's payload data as detailed in this article.

In response to the webhook, verify that you send the delivery ID for that order from your system.

- Returning the correct response ensures the order remains assigned to you as the carrier.
- If you return an incorrect response, the order reverts to unassigned, indicating a problem with your integration.

WarningCorrecting this error is mandatory. Otherwise, any subsequent API call you make to Bringg will receive a 403 error response. [Learn more.](https://developers.bringg.com/docs/troubleshooting)

**Step 7**: Use the sandbox shipper account to make changes to an order, or to cancel it.

This helps you verify that your own system receives the webhooks correctly and responds as needed.

| To test this webhook event... | Do this... | So that... |
| --- | --- | --- |
| **Delivery Cancelled** (webhook) | Select the context menu ![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/image-1678715428348.png) and choose **Cancel** | Bringg notifies you that the sandbox shipper canceled the order. [Learn more.](https://developers.bringg.com/docs/order-is-cancelled-webhook) |
| **Delivery Updated** (webhook) | Select the context menu ![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/image-1678715428348.png) and choose Update order. Edit or paste new payload details in the popup screen. | The shipper makes changes to the address, goods, time window, or customer information. [Learn more.](https://developers.bringg.com/docs/order-is-updated-webhook) |

**Step 8**: Test each API call by following the technical steps of order fulfillment from your company's own staging account to the sandbox shipper account.

| Send this API call... | To... |
| --- | --- |
| **Assign Driver** (API) | Share any authorized identification information about the driver who receives the assignment or reassignment. [Learn more.](https://developers.bringg.com/docs/driver-is-assigned-to-order) |
| **Start Order** (API) | Notify Bringg that the driver has begun the delivery process. Include the location, time, delivery price, and whether or not it is a green delivery. [Learn more.](https://developers.bringg.com/docs/start-order-1) |
| **Update Driver Location** (API) | (Recommended) Share the timestamp and exact geolocation of the driver. [Learn more.](https://developers.bringg.com/docs/update-driver-location) |
| **Check In** (API) | (Recommended) Share the timestamp and exact geolocation of the driver upon arrival at either the pickup or dropoff location. [Learn more.](https://developers.bringg.com/docs/note-added) |
| **Add Note** (API) | (Recommended) Update the order when the driver adds a note, signature, proof of delivery, or any other delivery documentation the driver collects. [Learn more.](https://developers.bringg.com/docs/note-added) |
| **Check Out** (API) | (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. [Learn more.](https://developers.bringg.com/docs/check-out) |
| **Cancel Order** (API) | Cancel a delivery, like if the customer is not home, or there are no available drivers. [Learn more.](https://developers.bringg.com/docs/order-is-cancelled-webhook) To test this API, send it at any stage of the order fulfillment process. NoteIf the sandbox shipper enables the **Failed Delivery Manager**, you canceling the order can trigger the **Return Delivery Created** webhook which tells you to return the inventory item back to the fulfillment center. [Learn more.](https://developers.bringg.com/docs/return-delivery-created) |
| **Update Order** (API) | (Optional) Update the scheduled pickup or delivery time, the time window, driver ETA, green delivery, delivery price, and so on. [Learn more.](https://developers.bringg.com/docs/cancel-order) |
| **Complete Order** (API) | Send the timestamp, delivery price, order number, or geolocation of the driver when you complete the delivery. [Learn more.](https://developers.bringg.com/docs/return-delivery-created) |
| **Cluster Checkin/Checkout** (API) | (Optional) Do a bulk pickup of orders from a *fulfillment center* or other similar location and deliver them to your warehouse or store location. [Learn more.](https://developers.bringg.com/docs/cluster-checkincheckout) |

**Step 9**: Troubleshoot errors you encounter during testing to resolve integration issues.

For example, if you try to assign a driver to your fleet from the sandbox, and it returns a 400 error, check that you sent the order field as an integer rather than a string. [Learn more.](https://developers.bringg.com/docs/troubleshooting)

Once you resolve all errors, contact your Bringg customer service representative to request that Bringg certifies your integration so you can begin working directly with a shipper staging account.

NoteOnce Bringg connects you to the shipper staging account, you will see their credentials in **Registered Merchants**. These credentials allow you to begin testing directly with your shippers' staging accounts, and eventually to go live.

**Step 10**: (Optional) Automate the process of receiving shipper credentials directly to your company's system by listening to the **Merchant Registered** webhook.

1. Copy the **Get Merchant Credentials** endpoint to make the API call.

NoteTo obtain the endpoints of only one specific shipper, add the shipper's UUID from the payload of the Merchant Registered webhook to the end of Get Merchant Credentials endpoint. [Learn more.](https://developers.bringg.com/docs/get-merchant-credentials)

1. Select **Show Credentials** under the **Admin Credentials**.  
![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/image-1678715628847.png)***Get shipper credentials***
2. Authenticate the call using Basic Auth Authentication. The username and password are the **Client ID** and **Client Secret** respectively.

| To... | Do this... |
| --- | --- |
| Automatically obtain the endpoints and credentials for all shippers who registered to work with you. | 1. Copy the **Get Merchant Credentials** endpoint to make the API call. NoteTo obtain the endpoints of only one specific shipper, add the shipper's UUID from the payload of the **Merchant Registered** webhook to the end of **Get Merchant Credentials** endpoint. [Learn more.](https://developers.bringg.com/docs/get-merchant-credentials) 1. Select **Show Credentials** under the **Admin Credentials**. 2. Authenticate the call using Basic Auth Authentication. The username and password are the **Client ID** and **Client Secret** respectively. All shipper credentials then appear in the **Registered Merchants** table. |

**Step 11**: Copy shipper credentials to begin testing with their staging environments.

| Field | Description |
| --- | --- |
| **Merchant** | The name of the registered shipper interested in working with you. |
| **Client ID** and **Client Secret** | Use these to generate a token to authenticate the API calls you are sending to the shipper through Bringg. |
| **API Key** | Use this to authenticate the webhook notifications you receive from Bringg. |
| **Endpoint Prefix** | This will differ based on the shipper's configuration with Bringg. Therefore, you need to verify that you are using the right prefix for each shipper. |

**Step 12**: Test and troubleshoot delivery flows end to end between your company's system and each shipper's staging, then production environments.

Contact your Bringg customer service representative to facilitate this process.

Once the integrations prove successful with the shipper's production environment, you are ready to go live.

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.

The Bringg Integrations Portal is an app the Bringg Platform offers carrier (carrier)s who wish to self-integrate with Bringg in order to begin working with interested shippers who also use Bringg.

A shipper is a term used by carriers (carriers) to describe a company that ships goods or services to consumers. Shippers sometimes use carriers to fulfill their orders, often to augment their Own Fleet.

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.

Quotes are carrier-provided fulfillment estimates and often include pricing, availability, and ETA. You can display quotes to customers at checkout, auto-assign carriers based on order attributes with Carrier Selector rules, or manually assign carriers in the Bringg platform.

For each order, Bringg sends quote requests to carriers who match your Carrier Selector rules and delivery terms.

You can also set up rate cards for carriers whose quotes do not match agreed-upon pricing.

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).