Update Order V2

put

https://api.burqup.com/v2/orders/{id}

Update an order. Supports nested pickup/dropoff structure and route management for optimizing multi-stop deliveries.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

ID of 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

List of items to be delivered.

items

tip

integer

Total tip for the order.

required_provider_settings

object

Required provider settings for barcode scanning at pickup and dropoff. Use this to specify barcode scanning requirements that must be supported by the delivery provider.

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.

pickup

object

Pickup location details.

dropoff

object

Dropoff location details.

external_route_ref

string

External route reference to group multiple orders that belong to the same route for optimization.

external_stop_seq

integer

The sequence number of this order within the route. Must be a positive integer.

contains_alcohol

boolean

Indicates whether items contain an alcoholic ingredient.

length

float

Length of the order package.

width

float

Width of the order package.

height

float

Height of the order package.

weight

float

Weight of the order package.

dimension_unit

string

enum

unit for order dimension. Defaults to inches (in) if not provided.

Allowed:

weight_unit

string

enum

unit for order weight. Defaults to pounds (lb) if not provided.

Allowed:

expand

array of strings

An array of valid string values to request additional information as an expanded response by using the expand request parameter.

  * `latest_delivery` - If included in the expand array returns latest delivery associated with the order.

expand

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.

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.

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.