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

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

pickup_unit

string

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

dropoff_unit

string

Unit number of dropoff location. Do not provide if dropoff_store_id is provided.

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.

pickup_store_id

string

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

dropoff_store_id

string

ID of a store created through Burq dashboard or API. Quotes created with a dropoff_store_id can only be used to create delivery with the same dropoff_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.

pickup_name

string

Individual or company name of pickup location. Do not provide if pickup_store_id is provided.

connected_account_id

string

Only relevant for Burq Connect merchants. Specify the connected account that you want to create the delivery under. If you are already setting store_id, you don't need to set this field, as the owner account will be inferred from the store.

contains_alcohol

boolean

Indicates whether items contain an alcoholic ingredient.

required_provider_settings

object

Required provider settings exclude providers that don't support the selected settings from quote generation. If you set required_provider_settings when creating quotes, you probably also want to set required_provider_settings or preferred_provider_settings when creating deliveries to ensure the settings are passed to the provider. Each provider supports different settings, and excessive requirements may reduce quote availability.

pickup_address_details

object

This object is optional. If provided, all nested fields must be provided. Burq will perform no address validation when this object is provided. The provided address will be sent to providers as is. Merchants are responsible for data validity and accuracy. Note, when this object is provided, you still need to provide a formatted address under pickup_address or pickup_store_id. Additionally, pickup_unit (when applicable) needs to be provided in the top-level field.

dropoff_address_details

object

This object is optional. If provided, all nested fields must be provided. Burq will perform no address validation when this object is provided. The provided address will be sent to providers as is. Merchants are responsible for data validity and accuracy. Note, when this object is provided, you still need to provide a formatted address under dropoff_address or dropoff_store_id. Additionally, dropoff_unit (when applicable) needs to be provided in the top-level field.

pickup_phone_number

string

Phone number of pickup location. Do not provide if pickup_store_id is provided.

dropoff_phone_number

string

Phone number of dropoff location. Do not provide if dropoff_store_id is provided.

dropoff_name

string

Individual or company name receiving the delivery. Do not provide if dropoff_store_id is provided.

items

array of objects

List of items to be delivered.

items

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.