Create Delivery

post

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

Create a delivery, with option to initiate it immediately.

Body Params

initiate

boolean

When set to true, delivery is initiated immediately - the cheapest delivery option will be auto-selected, and delivery info is sent to delivery provider for fulfillment. No further call to the /initiate_delivery is needed. If manual selection of quote is needed, set to false and review the returned quotes. Then call /initiate_delivery API with the desired quote ID. Defaults to false if not provided.

pickup_address

string

Address of pickup location. Include all components including street, city, zipcode, and country. Do not include unit number; use pickup_unit property instead. Do not provide if pickup_store_id is provided. Otherwise required.

pickup_unit

string

Unit number of pickup location. Do not provide if pickup_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.

pickup_name

string

Individual or company name of pickup location. Optional if pickup_store_id is provided. Otherwise required.

pickup_phone_number

string

Phone number of pickup location. Optional if pickup_store_id is provided. Otherwise required.

pickup_notes

string

Instructions for drivers when picking up delivery items.

dropoff_address

string

Address of dropoff location. Include all components including street, city, zipcode, and country. Do not include unit number; use dropoff_unit property instead. Do not provide if dropoff_store_id is provided. Otherwise required.

dropoff_unit

string

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

dropoff_name

string

Individual or company name receiving the delivery. Optional if dropoff_store_id is provided. Otherwise required.

dropoff_at

date-time

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

dropoff_phone_number

string

Phone number of dropoff location. Optional if dropoff_store_id is provided. Otherwise required.

dropoff_notes

string

Instructions for drivers when dropping off delivery items.

items

array of objects

required

List of items to be delivered.

items*

pickup_store_id

string

ID of a store created through Burq dashboard or API. When provided, store information will be used for any pickup setting not explicitly provided in the request, including address, phone number, name, and notes.

dropoff_store_id

string

ID of a store created through Burq dashboard or API. When provided, store information will be used for any dropoff setting not explicitly provided in the request, including address, phone number, name, and notes.

quote_id

string

ID of a previously generated quote. If not provided, the cheapest quote will be selected automatically.

external_order_ref

string

Merchant-provided delivery identifier. Commonly used for merchants to cross-reference deliveries from Burq API with their own system. When provided, this is also used as "order number" and used by drivers to find the right order at pickup location.

tip

integer

Tips for the driver. Burq forwards all tips to the delivery providers.

order_value

integer

Total value of all items in the delivery.

contactless_delivery

boolean

Whether delivery should be contactless. Cannot be true if signature is set to true.

signature

boolean

Whether signature should be collected at dropoff. Cannot be true if contactless_delivery is set to true.

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 pickup_store_id or dropoff_store_id, you don't need to set this field, as the owner account will be inferred from the store.

required_provider_settings

object

Required provider settings. When quote_id is not provided, providers that don't support the selected settings will be excluded from quote selection. If quote_id is provided, and the provider of the quote does not support the selected provider settings, an error will be returned. Required provider settings are evaluated during reroute. Each provider supports different settings, and excessive requirements may reduce quote availability.

preferred_provider_settings

object

Preferred provider settings do not affect quote availability nor quote selection. When a quote is selected, either explicitly via quote_id, or automatically based on pricing, any supported settings from this configuration will be passed to the provider. Unsupported settings are ignored. Preferred provider settings are evaluated during reroute.

contains_alcohol

boolean

Indicates whether items contain an alcoholic ingredient.

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.

Headers

x-api-key

string

required

Burq API key for your account.

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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.

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