Update Order by ID

put

https://us2-api.bringg.com/v2/orders/{order_id}

Update the details of an order using its ID number.

Path Params

order_id

double

required

Body Params

name

string

The order name, often formatted as a combination of OMS name, ID number, timestamp, or carrier.

source_id

string

Your source system's ID for this order.

notes

array of strings

Additional order details, such as contact or address instructions.

notes

customer

object

billing_address

object

currency

string

enum

The currency used for transactions in this order.

tip

int32

The tip (gratuity) paid to the driver by the customer.

tag_name

string

Custom tags that inform Bringg which customer-facing branding to use (Own Fleet only).

total_price

int32

The total price of this order, used for shipping rules and display in customer-facing documentation. Formatted to include cents. For example, a value of 25000 using USD as currency would appear as $250.00 in the Delivery Hub UI.

products

array of objects

The products included in this order.

products

custom

object

Custom data to save within an order.

Headers

Authorization

string

required

Responses

Language

Response

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

application/json

200Success

400Bad Request

403Forbidden