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

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.

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

Response body

object

string

required

Unique identifier for the order.

object

string

required

Name of the API resource.

order

test_mode

boolean

required

Indicates the order was generated by the test-mode API Key.

account_id

string

required

Identifier for the merchant account of the order.

platform_account_id

string

Identifier for the platform account of the order.

pickup_notes

string

Pickup notes for the order.

pickup_address

string

Address for the pickup location.

pickup_unit

string

Unit number for the pickup location.

pickup_phone_number

string

Phone number for driver to contact at the pickup location.

pickup_name

string

Individual or company name of pickup location.

pickup_customer_email

string

Pickup customer email.

dropoff_notes

string

Instructions for drivers when dropping off order items.

dropoff_address

string

required

Address of dropoff location.

dropoff_customer_email

string

Dropoff customer email.

dropoff_name

string

required

Individual or company name receiving the order.

dropoff_unit

string

Apartment or unit number of dropoff location.

dropoff_phone_number

string

required

Phone number of dropoff location.

pickup_store_id

string

ID of the store associated to pickup location.

dropoff_store_id

string

ID of the store associated to dropoff location.

external_order_ref

string

order_value

integer

Total value of all items in the order.

tip_amount

integer

Total tip for the order.

pickup_at

date-time

Timestamp for when the items should be picked up. Must be in ISO8601 format.

dropoff_at

date-time

Timestamp for when the items should be delivered.

created_at

date-time

required

Timestamp for when the order was created.

updated_at

date-time

required

Timestamp for when the order was last updated.

items

array of objects

List of items to be delivered.

items

object

name

string

required

Description of the item.

quantity

integer

required

Quantity of the item.

size

string

required

Estimate of the size of an item being delivered that factors into the handling and pricing.

                * `small` - The order item can be easily carried with one hand, e.g. a shoe box.

                * `medium` - You need a bag to carry the order item, e.g. a retail bag.

                * `large` - Need two hands to carry the order item, e.g. a computer monitor.

                * `xlarge` - The order item fits in the trunk of a car or multiple trips are necessary to transport the order item from the vehicle to its destination.

small medium large xlarge

unit_price

integer

Price of the item.

contains_alcohol

string

required

Indicates whether items contain an alcoholic ingredient.

latest_delivery

object

The latest delivery for the order.

string

required

Unique identifier for the delivery.

object

string

required

Name of the API resource.

OrderDelivery

delivery_type

string

required

Describes whether delivery is scheuduled for a future time.

asap scheduled

provider

string

Name of the selected delivery provider.

provider_id

string

Service provider Id of the delivery.

status

string

required

Status of the delivery.

  * `request` - initial state of Delivery when it is first requested.

  * `delivery_created` - Status of the delivery after "initiate" delivery has been called.

  * `driver_not_assigned` - A driver has not been assigned to the delivery.

  * `driver_assigned` - A driver has been assigned to the delivery.

  * `enroute_pickup` - The driver is en route to the pick up location.

  * `arrived_at_pickup` - The driver has arrived at the pick up location.

  * `pickup_complete` - The items have been picked up from the pick up location.

  * `enroute_dropoff` - The delivery is en route to the drop off location.

  * `arrived_at_dropoff` - The delivery has arrived at the drop off location.

  * `dropoff_complete` - All drop offs are complete.

  * `delivered` - Courier has completed the drop offs.

  * `provider_canceled` - The delivery provider canceled the delivery.

  * `customer_canceled` - The delivery was canceled by the customer.

  * `burq_canceled` - The delivery was canceled by Burq for internal reasons.

  * `failed` - an error occurred during the process of delivery.

  * `disputed` - Indicates that the customer has disputed the delivery.

  * `enroute_to_return` - indicates that the items are enroute to their original pick up location for the purpose of being returned.

  * `returned` - Delivery was canceled and a new delivery created to return items to sender.

driver_assigned enroute_pickup arrived_at_pickup pickup_complete enroute_dropoff arrived_at_dropoff dropoff_complete request scheduled delivery_created driver_not_assigned delivered disputed provider_canceled customer_canceled burq_canceled failed enroute_to_return returned

tracking_url

string

URL of the tracking page. This page can be sent to the end user or used internally by the merchant.

currency

string

required

Currency of all monetary amounts related to this delivery, in ISO4217 format.

total_amount_due

integer

required

Total before tip for the delivery. This amount includes delivery provider fees and any applicable Burq fees.

tip

integer

Tips are 100% forwarded to the delivery provider.

fee

integer

required

For merchants that use the quote workflow feature, this property describes the "delivery cost" that should be displayed to the end user. This property is only relevant for quote workflow merchants. It is not the payment amount that Burq charges for the delivery.

created_at

date-time

required

Timestamp for when the delivery was created.

cancellation_reason

string

Cancelation reason as provided by the delivery provider. Only relevant for provider-canceled deliveries.

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.

order_value

integer

Total value of all items in the delivery.

proof_of_delivery_image_urls

array of strings

required

Image urls uploaded by drivers for proof of delivery. An empty array is returned when there is none. Burq automatically requests proof of delivery photoes with provider whenever possible.

proof_of_delivery_image_urls*

contactless_requested

string

required

Indicates whether contactless delivery was requested.

signature_requested

string

required

Indicates whether signature was requested.

undeliverable_action_requested

string

required

Indicates whether signature was requested.

return_to_store leave_at_door discard_package

quote_id

string

required

ID of the associated Quote object.

signature_image_url

string

URL of signature image uploaded by driver. Only applicable when signature is requested.

status_history

array of objects

Status history of the delivery.

status_history

object

status

string

required

A delivery status. Please see the top-level status property for possible values.

time

date-time

required

Time when the delivery transitioned out of this status.

store_id

string

ID of the associated Store.

test_mode

boolean

required

Indicates the delviery was generated by the test-mode API Key.

updated_at

date-time

required

Timestamp for when the Delivery was last updated.

vehicle_requested

string

Vehicle type requested by the merchant.

pickup

object

required

An object that contains the pickup information for this delivery.

dropoff

object

required

An object that contains the dropoff information for this delivery.

courier

object

An object that contains the courier information for this delivery.

items

array of objects

required

List of items to be delivered.

items*

object

name

string

required

Description of the item.

quantity

string

required

Quantity of the item.

size

string

required

Estimate of the size of an item being delivered that factors into the handling and pricing.

      * `small` - The order item can be easily carried with one hand, e.g. a shoe box.

      * `medium` - You need a bag to carry the order item, e.g. a retail bag.

      * `large` - Need two hands to carry the order item, e.g. a computer monitor.

      * `xlarge` - The order item fits in the trunk of a car or multiple trips are necessary to transport the order item from the vehicle to its destination.

small medium large xlarge

contains_alcohol

string

required

Indicates whether items contain an alcoholic ingredient.

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.