Create Delivery

post

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

Create a delivery, with option to initiate it immediately.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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 store_id is provided. Otherwise required.

pickup_unit

string

Unit number of pickup location. Do not provide if 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 store_id is provided. Otherwise required.

pickup_phone_number

string

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

pickup_notes

string

Instructions for drivers when picking up delivery items.

dropoff_address

string

required

Address of dropoff location. Include all components including street, city, zipcode, and country. Do not include unit number; use dropoff_unit property instead.

dropoff_unit

string

Unit number of dropoff location.

dropoff_name

string

required

Individual or company name receiving the delivery.

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

required

Phone number of dropoff location.

dropoff_notes

string

Instructions for drivers when dropping off delivery items.

items

array of objects

required

List of items to be delivered.

items*

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.

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.

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:

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.