Create Order

post

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

Create an order.

Body Params

order_value

integer

Total value of all items in the order.

external_order_ref

string

Merchant-provided delivery identifier. Commonly used for merchants to cross-reference orders 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.

items

array of objects

required

List of items to be delivered.

items*

tip

integer

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

request_contactless

boolean

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

request_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:

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_phone_number

string

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

pickup_name

string

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

pickup_contact_email

string

Pickup contact email.

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_notes

string

Instructions for drivers when picking up order items.

dropoff_phone_number

string

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

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.

dropoff_name

string

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

dropoff_contact_email

string

Dropoff contact email.

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_notes

string

Instructions for drivers when dropping off order items.

contains_alcohol

boolean

Indicates whether items contain an alcoholic ingredient.

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.

Headers

x-api-key

string

required

Burq API key for your account.

Responses

201The 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.

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