Entities
The Burq V2 API is composed of the following entities:
Order
An Order represents a single pickup-to-dropoff delivery request. It contains all the details needed to fulfill a delivery: pickup location, dropoff location, and the manifest of items to be delivered.
A Route can contain one or more Orders. Orders can be created individually or in batches and associated with a Route for dispatch to a delivery provider.
See: Create Order
Route
A Route groups one or more Orders for dispatch. When a Route is dispatched, Burq assigns a Delivery Service Provider (DSP) to fulfill all orders in the route.
Routes support multi-stop sequencing, allowing you to control the order in which stops are served via external_stop_seq.
See: Create Route, Dispatch Route
RouteQuote
Before dispatching a Route, you can request RouteQuotes to compare pricing and reliability across available delivery providers. A RouteQuote can be selected at dispatch time to lock in a specific provider and price.
See: Get Route Quote
Delivery
Once a Route is dispatched, Burq initiates a Delivery with the selected Delivery Service Provider (DSP). The Delivery tracks real-time fulfillment status, DSP and driver information, and tracking URLs. It is returned as latest_delivery on the Order object.
See: Get Order
Addresses
Order creation requires addresses for the pickup/origin and dropoff/destination. Two formats are supported:
Formatted address string:
Street Address, City, State, Zip
Must follow the format used by the national postal service of the relevant country (US and Canada are currently supported). Burq validates and geocodes addresses provided in this format.
Structured address object (address_details):
Provide individual fields — street, city, state, country, postal_code, latitude, longitude. When using this format, Burq performs no address validation and sends the data to providers as-is. Merchants are responsible for data accuracy.
In both cases, unit or suite numbers should be provided in the separate unit field rather than embedded in the address string, as that may cause geocoding issues.
