Request Quote

Burq API V2 (Alpha)
Base URL: https://api.burqup.com/v2

Overview

Request pricing quotes from available delivery providers for your route. This is an asynchronous operation that returns a job ID immediately. Quote generation happens in the background, and you'll need to retrieve quotes in the next step.

This is Step 3 of 5 in the complete delivery flow:

Create Orders - Create one or more delivery orders
Create Route - Group orders into a multi-stop delivery route
Request Quote ← You are here
Pick Provider - Retrieve and select a provider quote
Dispatch - Dispatch the route with the selected provider

Prerequisites

Before requesting quotes, ensure you have:

Completed Step 2: Create Route
The route ID from Step 2
The route must be in draft status

Endpoint Details

Endpoint: POST /v2/routes/{route_id}/quotes
Operation ID: GetRouteQuotes
API Reference: Generate Route Quotes

Request

Headers

Header	Value	Required
`Content-Type`	`application/json`	Yes
`x-api-key`	Your API key	Yes

Path Parameters

Parameter	Type	Required	Description
`route_id`	string	Yes	The route ID from Step 2

Request Body

No request body is required for this endpoint.

Example Request

curl -X POST "https://api.burqup.com/v2/routes/route_xyz789/quotes" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY"

Response

Success Response (200 OK)

{
  "job_id": "job_quote_123",
  "object": "job"
}

Important:

This endpoint returns immediately with a job_id
Quote generation happens asynchronously
You'll receive a webhook notification when quotes are ready (if webhooks are configured)
Proceed to Step 4: Pick Provider to retrieve quotes

Response Fields

Field	Type	Description
`job_id`	string	Unique identifier for the asynchronous quote generation job
`object`	string	Always "job"

How Quote Generation Works

Immediate Response - The API returns immediately with a job_id
Background Processing - Quote generation happens asynchronously
Webhook Notification - If configured, you'll receive a webhook when quotes are ready
Polling - Alternatively, poll the quote endpoint in Step 4 until quotes are available

Note: Quote generation typically takes a few seconds to a minute, depending on route complexity and provider availability.

Error Handling

Common errors when requesting quotes:

route_api_key_test_mode_mismatch - The test mode of the API key used to create the route does not match the test mode of the API key used in the current request
unauthorized - You do not have permission to perform this action
record_not_found - The route does not exist

See Error Handling for detailed error information.

Best Practices

Wait for quotes - Don't immediately try to retrieve quotes; wait a few seconds
Use webhooks - Configure webhooks to be notified when quotes are ready
Implement polling - If not using webhooks, poll the quote endpoint with exponential backoff
Handle timeouts - Quotes may take time; implement appropriate timeout handling
Save job_id - Keep the job_id for tracking (optional, route_id is sufficient)

Next Step

After requesting quotes, proceed to:

Step 4: Pick Provider - Retrieve the available quotes and select a provider

Note: You may need to wait a few seconds or receive a webhook notification before quotes are available.