GuidesAPI Reference
Log In
API Reference

Create Order

post
https://us2-api.bringg.com/v2/orders/

Send the details of a new order to Delivery Hub from your Order Management System (OMS).

Body Params
string
enum
required

The currency used for transactions in this order.

billing_address
object
required
int32
required

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.

customer
object
required
fulfillments
array of objects

The fulfillments that belong to this order, listed as an array. Delivery Hub displays each fulfillment only in the shipping location where a packer will fulfill that part of the order.

fulfillments
integration
object
string

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

string

Your source system's ID for this order.

notes
array of strings

Additional order details, such as contact or address instructions.

notes
int32

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

string

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

products
array of objects

The products included in this order.

products
custom
object

Custom data to save within an order.

Headers
string
required
Responses

Updated 10 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago