canonical: https://jentic.com/apis/burqup.com/burqup

# Burqup Burq Delivery API

The Burq Delivery API is a delivery-orchestration platform that aggregates multiple last-mile delivery providers behind a single integration. It supports generating delivery quotes, creating and cancelling deliveries, managing stores and orders, building multi-stop routes, and reporting delivery incidents. Burq is used by retailers, restaurants, and platforms that want on-demand or same-day local delivery without integrating each carrier directly. Authentication is a single x-api-key header tied to the Burq account.

## For AI agents

Quote and dispatch on-demand and same-day local deliveries through multiple carriers, manage stores and orders, and build multi-stop routes via a single Burq integration.

## Scope

Does not handle long-haul shipping, customer payments, or warehouse inventory - use for on-demand and same-day local delivery orchestration only.

## Capabilities

- Generate multi-provider delivery quotes via POST /quote
- Create, initiate, and cancel deliveries through the deliveries surface
- Track an existing delivery by ID and list recent deliveries
- Create and update stores that act as pickup origins
- Place, update, and cancel orders tied to a store
- Build and cancel multi-order delivery routes via the routes endpoints
- Log and read delivery incidents for a specific delivery

## Use cases

### On-demand local delivery for orders

Quote and dispatch a local delivery for each order placed in the merchant's storefront. POST /quote returns rates from multiple carriers; the merchant picks one and POST /delivery_information then POST /initiate_delivery hands the job to the chosen provider. Suitable for restaurants and retailers that need same-day delivery without contracting with each carrier separately.

Example prompt: POST /quote with the pickup and dropoff addresses, present the quote options, then POST /delivery_information and POST /initiate_delivery to dispatch the chosen provider.

### Order and store management

Maintain stores as pickup origins and the orders attached to each store. The /stores and /orders endpoints support create, update, retrieve, and cancel, and orders can be paired with `/orders/{id}/quotes` and `/quotes/{id}/accept` to compare and lock in a delivery rate. Useful for multi-location merchants who manage their dispatch operations from a central system.

Example prompt: Create a store via POST /stores, add an order via POST /orders, request rates with POST `/orders/{id}/quotes`, and accept the chosen quote with POST `/quotes/{id}/accept.`

### Multi-stop route delivery

Group several orders into a single multi-stop route to reduce per-order delivery cost. POST `/routes/quotes` returns route-level rates and POST /routes creates the route once a rate is accepted. Good for batch dispatch windows where multiple deliveries from the same store are headed to nearby destinations.

Example prompt: POST `/routes/quotes` with the list of pickups and dropoffs, present rates to the merchant, then POST /routes to lock in the route.

### AI agent delivery dispatch via Jentic

An AI assistant can quote, dispatch, and track local deliveries on behalf of a merchant - for example, watching the order queue and triggering a Burq delivery automatically when an order is ready. Jentic securely stores the Burq x-api-key and issues scoped, short-lived access for each call, so the raw account key never enters the agent's context.

Example prompt: Search Jentic for 'dispatch a Burq delivery', load the /initiate_delivery schema, and execute it once the merchant confirms the chosen quote.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/quote` | Create delivery quotes from multiple carriers |
| POST | `/delivery_information` | Create a delivery |
| POST | `/initiate_delivery` | Initiate the chosen delivery |
| POST | `/delivery/{id}/cancel` | Cancel a delivery |
| GET | `/delivery/{id}` | Get a delivery |
| POST | `/orders/{id}/quotes` | Create order-level delivery quotes |
| POST | `/quotes/{id}/accept` | Accept an order quote |
| POST | `/routes` | Create a multi-stop route |

## Key resources

- **Quotes** — Generate multi-carrier delivery quotes for a pickup-to-dropoff job.
- **Deliveries** — Create, initiate, cancel, retrieve, and list deliveries.
- **Stores** — Manage stores that act as pickup origins.
- **Orders** — Create, update, cancel, and quote orders attached to a store.
- **Routes** — Build and cancel multi-stop delivery routes.
- **Delivery Incidents** — Log and retrieve incidents on a specific delivery.
- **Connected Accounts** — Manage connected accounts that act under the parent Burq integration.

## Why Jentic

- **Setup:** Wiring Burq by hand means learning its x-api-key header auth, chaining the quote-then-dispatch sequence across POST /quote, /delivery_information, and /initiate_delivery, and handling 429 retries yourself since the spec declares no explicit limits. Through Jentic you install once, import the Burq Delivery API from the API Directory, store the x-api-key once, and your agent calls it.
- **Permission scoping:** Burq carries the resource id in the URL path (`/delivery/{id}`, `/orders/{id}`, `/stores/{id}`), so a rule can pin your agent to a specific delivery, order, or store and nothing else. You choose the operations it may call, so destructive ones like POST `/delivery/{id}/cancel` or POST `/routes/{id}/cancel` are not included unless you add them.
- **Credential handling:** Your Burq x-api-key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get a delivery quote' or 'dispatch a Burq delivery', and Jentic returns the matching operation like POST /quote or /initiate_delivery with its input schema, so the agent calls the right endpoint without reading the Burq reference docs.

## Related APIs

- **Shippo API** — Shippo focuses on parcel shipping with major carriers rather than on-demand local couriers.
- **Akamai API** — Akamai for edge security and CDN in front of merchant storefronts that integrate Burq.
- **Stripe API** — Stripe handles the customer payment that pairs with the Burq delivery dispatch.

## FAQ

### What authentication does the Burq Delivery API use?

Burq uses an x-api-key header containing the API key issued from the Burq account dashboard. Through Jentic, the key is encrypted in the vault and a scoped, short-lived token is issued per operation, so the raw account key never enters the agent's context.

### How do I get a delivery quote and dispatch the chosen carrier?

POST /quote with pickup and dropoff addresses to receive multi-carrier rates. After choosing one, POST /delivery_information to create the delivery and POST /initiate_delivery to dispatch the selected provider. Track progress with GET `/delivery/{id}.`

### Can I cancel a Burq delivery after it has been initiated?

Yes, POST `/delivery/{id}/cancel` cancels the delivery. Cancellation policies and any fees depend on the underlying carrier and the current status of the delivery.

### Does Burq support multi-stop routes?

Yes. POST `/routes/quotes` returns rates for a batch of pickups and dropoffs and POST /routes creates the route once accepted. POST `/routes/{id}/cancel` cancels an active route.

### What are the rate limits for the Burq Delivery API?

The OpenAPI spec does not declare explicit limits. Burq publishes throttle and pricing guidance in their docs - handle 429 responses with retry-with-backoff for high-volume quote requests.

### How do I dispatch a Burq delivery through Jentic?

Run `pip install jentic` and search for 'dispatch a Burq delivery'. Jentic returns the /initiate_delivery operation, you load its schema, and execute the call with the prepared delivery payload - credentials stay in your Jentic One instance.

### Can I limit what my agent is allowed to do with the Burq Delivery API?

Yes. Because your Jentic One instance is self-hosted, your own rules decide which Burq operations and credentials the agent may use, so you can allow read and dispatch calls like POST /quote, POST /delivery_information, and POST /initiate_delivery while withholding destructive ones such as POST `/delivery/{id}/cancel` or POST `/routes/{id}/cancel.` Since Burq carries the resource id in the URL path, a rule can also pin the agent to a specific delivery, order, or store and nothing else. The stored x-api-key is injected only for the operations you have approved and never enters the agent's context.