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.

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.
• 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 using the credentials Bringg gave you.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

2. Select Show Credentials under the Admin Credentials.
   
   Get shipper credentials

    

3. Authenticate the call using Basic Auth Authentication. The username and password are the Client ID and Client Secret respectively.

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

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.