Get Quotes

post

https://api.burqup.com/v1/quote

Generate quotes to view pricing from different providers for your delivery.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

pickup_address

string

Address of pickup location. Include all components including street, city, zipcode, and country. Do not provide if store_id is provided. Otherwise required.

dropoff_address

string

required

Address of dropoff location. Include all components including street, city, zipcode, and country.

pickup_unit

string

Unit number of pickup location. Do not provide if store_id is provided.

dropoff_unit

string

Unit number of dropoff location.

pickup_at

date-time

Timestamp for when the items should be picked up. Must be in ISO8601 format. Cannot be both provided with dropoff_at.

dropoff_at

date-time

Timestamp for when the items should be delivered. Must be in ISO8601 format. Cannot be both provided with pickup_at.

vehicle

string

enum

This is an experimental setting. When set, Burq tries to inform providers about your preferred vehicle type. However, not all providers support vehicle type specification, and setting this property has no effect on those providers.

Allowed:

store_id

string

ID of a store created through Burq dashboard or API. Quotes created with a store_id can only be used to create delivery with the same store_id.

order_value

integer

Total value of all items in the delivery.

industry

string

enum

Name of the industry that best describes your order.

Headers

x-api-key

string

required

Burq API key for your account.

Responses

200The request was successful.

400Errors under status code 400. See error examples under the "Response" tab on right. Note examples are for reference only. Field values are neither exhaustive nor api-version-controlled.