# Burq Documentation

> Documentation for Burq

## Guides: GETTING started
- [Welcome](https://burq.readme.io/docs/welcome-1.md)
- [Sign Up and the Dashboard](https://burq.readme.io/docs/sign-up-and-the-dashboard.md)
- [Introduction to Order Management](https://burq.readme.io/docs/introduction-to-order-management.md): Welcome to Burq’s Order Management guide! This feature simplifies your workflow, helping you manage everything from single orders to bulk orders with ease. Let’s get started!
  - [Creating Orders](https://burq.readme.io/docs/creating-orders.md): Learn how to create orders on Burq.
    - [Order/Item Weights & Dimensions](https://burq.readme.io/docs/orderitem-weights-dimensions.md)
    - [Item Size Defaults](https://burq.readme.io/docs/item-size-defaults.md): If you do not have actual item weight and dimensions, you may use these default weight and dimensions when inputting items into Burq.
  - [Viewing and Managing Orders](https://burq.readme.io/docs/viewing-and-managing-orders.md): Learn how to view and manage orders on Burq.
- [Introduction to Order Workflows](https://burq.readme.io/docs/introduction-to-order-workflows.md): Welcome to Burq’s Order Workflow guide! This feature automates your delivery provider selection, helping you manage large volume of orders from different sources with ease. Let’s get started!
- [Alcohol Deliveries](https://burq.readme.io/docs/alcohol-guide.md): Configure your integration to send alcohol deliveries on the Burq platform.
- [Support and Refund Requests](https://burq.readme.io/docs/delivery-incidents.md): Learn how to report delivery incidents when deliveries don't go as planned.
- [Introduction to Driver Management & Dispatch](https://burq.readme.io/docs/introduction-to-driver-management-dispatch.md): Easily manage your in-house drivers, streamline assignments, and boost delivery efficiency. Scale with your own fleet or tap into Burq’s network for extra support—ensuring fast, reliable, and…
  - [Setting up In-House Drivers](https://burq.readme.io/docs/setting-up-in-house-drivers.md): Learn how to setup & manage your in-house drivers in burq
  - [Dispatch Dashboard for Route Planning and Assignment](https://burq.readme.io/docs/dispatch-dashboard-for-route-planning-and-assignment.md): Learn how to use the Dispatch Dashboard to plan and create optimized routes for your drivers, ensuring smooth and efficient order deliveries.
    - [Managing cancelled routes](https://burq.readme.io/docs/managing-cancelled-routes.md)
  - [Route CSV Upload](https://burq.readme.io/docs/route-csv-upload.md): If you have a batch of orders that need to be dispatched to drivers as pre-planned routes, you can upload them all at once using a CSV file. This guide walks you through preparing your file,…
- [Change Your Login Email Address](https://burq.readme.io/docs/change-your-login-email-address.md): This section will guide you on how to change the email address that you use to log into your Burq dashboard

## Guides: Product Features
- [Provider Settings](https://burq.readme.io/docs/provider-settings.md): Configure required and preferred delivery settings to enable unique provider features for your deliveries.
- [Bring Your Own Provider Keys (BYOPK)](https://burq.readme.io/docs/bring-your-own-provider-keys-byopk.md): Use your previously negotiated contract with delivery providers in Burq.
- [Multi-Location Setup](https://burq.readme.io/docs/burq-connect.md): How to use Burq when your business has more than one location.
  - [Burq Connect](https://burq.readme.io/docs/burq-connect-1.md): Burq Connect is for merchants with platform, franchise, or marketplace structures where each location (or group of locations) is its own business entity.
- [SMS Notifications](https://burq.readme.io/docs/sms-workflow-1.md): Send SMS notifications about various delivery statuses
- [Burq Invoices](https://burq.readme.io/docs/burq-invoices.md): How to view your invoices and order value refund.
- [Reroute](https://burq.readme.io/docs/delivery-rerouting.md): Rerouting when there's an unexpected delay or cancellation can help ensure timely deliveries and customer satisfaction.
- [Shopify](https://burq.readme.io/docs/shopify.md)
- [Delivery Tracking - Privacy Mode](https://burq.readme.io/docs/privacy-mode.md): Privacy mode for delivery tracking protects end customer privacy by preventing the customer on each end of a delivery from seeing the other’s personally-identifiable information.
- [ Automated Delivery Creation via email](https://burq.readme.io/docs/setting-up-parsio-for-automated-delivery-creation-via-email.md): This guide explains how to configure automated delivery creation by extracts order information from your emails so deliveries can be created without manual entry.
- [Branding](https://burq.readme.io/docs/branding.md): Control how your business appears on the customer-facing delivery tracking page.
- [Better Side Navigation](https://burq.readme.io/docs/a-better-navigation.md): A better Burq dashboard — introducing the redesigned navigation

## API Reference: Burq
- [API Orientation](https://burq.readme.io/reference/api-orientation-1.md)
  - [Terminology and Concepts](https://burq.readme.io/reference/terminology-and-concepts-1.md)
  - [API Conventions](https://burq.readme.io/reference/api-conventions-1.md)
  - [Rate Limits](https://burq.readme.io/reference/rate-limits-1.md)
  - [Authentication](https://burq.readme.io/reference/api-authentication-1.md)
  - [Idempotency](https://burq.readme.io/reference/idempotency-key.md)
  - [Pagination](https://burq.readme.io/reference/pagination.md)
- [Walk Through](https://burq.readme.io/reference/walk-through-1.md): Go from an API key to a driver on the road. This section covers the full lifecycle of a Burq delivery, in both of the ways you can run it.
  - [Manual Dispatch](https://burq.readme.io/reference/manual-dispatch.md): Create a delivery, compare real quotes from providers, and choose which one to dispatch. You stay in control of price and provider at every step.
    - [Create Order](https://burq.readme.io/reference/create-order.md): Create a single order synchronously, or submit a batch of 1-300 orders for asynchronous processing.
    - [Create Route](https://burq.readme.io/reference/create-route.md)
    - [Request Quote](https://burq.readme.io/reference/request-quote.md)
    - [Pick Provider](https://burq.readme.io/reference/pick-provider.md)
    - [Dispatch](https://burq.readme.io/reference/dispatch.md)
  - [Auto Dispatch](https://burq.readme.io/reference/auto-dispatch.md): Submit orders in a single request and let Burq handle the rest — routing, quoting, provider selection, and dispatch. You are notified by webhook as deliveries progress.
    - [Create and dispatch orders](https://burq.readme.io/reference/create-and-dispatch-orders.md): Use this to create and dispatch 1-300 orders as part of a batch.
- [Webhooks](https://burq.readme.io/reference/webhooks.md)

## API Reference: Burq APIs V2
- Order V2 APIs
  - [Create Batch Orders V2](https://burq.readme.io/reference/createbatchordersv2.md): Create multiple orders in a single batch request. Accepts 1-1500 orders that will be processed asynchronously. Each order follows the same schema as POST /v2/orders. Returns immediately with a…
  - [Create Order V2](https://burq.readme.io/reference/createorderv2.md): Create an order with enhanced route management capabilities. This v2 endpoint supports external route references and stop sequencing for multi-stop route optimization.
  - [Get Order](https://burq.readme.io/reference/getorderv2.md): Returns latest information about the requested order.
  - [Update Order V2](https://burq.readme.io/reference/updateorderv2.md): Update an order. Supports nested pickup/dropoff structure and route management for optimizing multi-stop deliveries.
  - [Delete Order](https://burq.readme.io/reference/deleteorder.md): Delete an order from the list if it has not been initiated.
  - [Cancel Order](https://burq.readme.io/reference/cancelorder.md): Cancels latest delivery in order. An error will be returned if order cannot be canceled (usually due to driver already enroute).
- Route V2 APIs
  - [List Routes](https://burq.readme.io/reference/listroutes.md): Returns paginated list of route summaries with filtering and sorting support.
  - [Create Route](https://burq.readme.io/reference/createroutev2.md): Create a multi-stop delivery route by specifying one or more existing orders. The route will be created in the Driver Management system, and orders will be updated with route and stop identifiers.
  - [Get Route](https://burq.readme.io/reference/getroute.md): Returns route details including all associated orders.
  - [Append Orders to Route](https://burq.readme.io/reference/appendorderstoroute.md): Append multiple orders to an existing route. Orders will be added to the route in the Driver Management system and updated with route identifiers.
  - [Remove Order from Route](https://burq.readme.io/reference/removeorderfromroute.md): Remove an order from a route. The order will be removed from the route in the Driver Management system and the route reference will be cleared. DM automatically resequences remaining stops and…
  - [Delete Route](https://burq.readme.io/reference/deleteroute.md): Delete a route from the list if it has not been initiated.
  - [Cancel Route](https://burq.readme.io/reference/cancelroute.md): The cancellation is processed asynchronously: the request is accepted and the cancellation is completed in the background.. The final outcome (success or failure) is delivered via the…
- Route Quotes APIs
  - [Generate Route Quotes](https://burq.readme.io/reference/createroutequotes.md): Generates quotes for the given route asynchronously. Returns a job id; poll GET /v2/routes/{route_id}/quotes for results. Webhook notifications are also sent to the merchant.
  - [Get Route Quote](https://burq.readme.io/reference/getroutequote.md): Returns the route quote details.
  - [Dispatch Route](https://burq.readme.io/reference/dispatchroute.md): Dispatch a multi-stop delivery route based on the selected route quote. If a route.dispatched webhook subscription exists, webhooks are still sent when dispatch finishes.
  - [Get Estimates](https://burq.readme.io/reference/getestimates.md): Returns a delivery fee estimate (P90 of historical deliveries) for the given origin/destination zipcodes and item dimensions.
  - [List Route Quotes](https://burq.readme.io/reference/listroutequotes.md): Returns quotes for a route from the latest quote generation. While quoting is in progress, status is PENDING and data is null. When complete, status is COMPLETE and data is the latest snapshot (empty…