Signing Up For Burq

In order to use the Burq API, you will first need to create an account. Request a demo here.

Getting to Know the Burq Dashboard

Once you have signed up for Burq, you will have access to our dashboard.

The Burq dashboard allows you to create and manage deliveries through a web-based UI in both test and production environments (you can switch between the two with a simple toggle at the top of the app). When operating in production mode, you can manage payment methods for production.

Although you will likely be integrating your apps through our REST API, it is helpful to have some familiarity with the dashboard.

In the dashboard, you can set delivery-related preferences and view data analytics about your delivery operations. You can also use it as a reference implementation.

The Orders page

The Orders page lists all orders that you have created, along with their statuses and other important details. You can use this screen to verify that your calls to the Burq API are successfully creating orders as you intended.

Creating Orders in the Dashboard

From any page click on "Create Order" in the sidebar to create a new order, just as you would through the API.