Get Order by ID

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

Get the details of an order using its ID number.

Responses

Response body

object

string

required

user_id

double

source_id

string

name

string

required

notes

array of strings

notes

customer

object

required

string

required

merchant_id

double

required

allow_sms

boolean

required

If allow_sms is true, send notifications to customer by SMS.

allow_email

boolean

required

If allow_email is true, send notifications to customer by email.

created_at

string

required

updated_at

string

required

delete_at

string

name

string

required

The customer's first and last name.

string

The customer's email address.

phone

string

required

The customer's phone number.

billing_address

object

required

string

required

user_id

double

merchant_id

double

required

created_at

string

required

updated_at

string

required

delete_at

string

street1

string

required

The first line of the street address, including the street name or PO Box number.

postal_code

string

required

Postal or ZIP code.

city

string

required

City, district, suburb, town, or village.

country

string

required

Two letter ISO country code. Learn more: https://www.iso.org/obp/ui/#search

AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW

street2

string

(Optional) The second line of the street address, including the apartment number.

street3

string

state

string

(Optional, based on country) State, province, or region.

address_type

string

The type of location. Example: business, residential.

commercial residential educational government medical industrial shipping_location

company

string

The company name, when shipping to a business address.

string

The customer's email address.

phone

string

The customer's phone number.

custom

object

Has additional fields

delete_at

string

created_at

string

required

updated_at

string

required

currency

string

required

AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYN BZD CAD CDF CHE CHF CHW CLF CLP CNY COP COU CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD SSP STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD USN UYI UYU UYW UZS VES VND VUV WST XAF XAG XAU XBA XBB XBC XBD XCD XDR XOF XPD XPF XPT XSU XTS XUA YER ZAR ZMW ZWL

tip

double

merchant_id

double

required

tag_name

string

total_price

double

required

integration

object

string

required

user_id

double

required

merchant_id

double

required

created_at

string

required

updated_at

string

required

delete_at

string

type

double

required

credentials

object

Has additional fields

shop

string

fulfillments

array of objects

fulfillments

object

string

required

source_id

string

order_id

string

customer_id

string

required

customer

object

merchant_id

double

required

user_id

double

delete_at

string

created_at

string

required

updated_at

string

required

shipping_account_id

double

service

string

sender_address_id

string

required

sender_address

object

recipient_address_id

string

required

recipient_address

object

quote_id

string

status

string

required

Quoted New PartiallyFulfilled ReadyToShip PickedUp InTransit OutForDelivery Delivered Exception CancelledByCarrier Cancelled

deliver_by

string

items_count

double

total_weight

double

name

string

status

string

required

Quoted New PartiallyFulfilled ReadyToShip PickedUp InTransit OutForDelivery Delivered Exception CancelledByCarrier Cancelled

total_weight

double

deliver_by

string

items_count

double

shipments_details

array of objects

shipments_details

object

source_id

string

shipments

array of objects

shipments

object

string

required

order_id

string

required

fulfillment_id

string

required

user_id

double

merchant_id

double

required

created_at

string

required

updated_at

string

required

delete_at

string

status

string

required

Quoted New PartiallyFulfilled ReadyToShip PickedUp InTransit OutForDelivery Delivered Exception CancelledByCarrier Cancelled

shipment_events

array of objects

shipment_events

object

string

required

type

string

required

status_update checkpoint carrier_assignment_failure

value

string

required

merchant_id

double

required

shipment_id

string

required

created_at

string

required

updated_at

string

required

delete_at

string

shipments_packages

array of objects

shipments_packages

object

string

required

order_id

string

required

package_id

string

required

fulfillment_id

string

required

shipment_id

string

tracking_number

string

label

string

return_label

string

created_at

string

required

updated_at

string

required

delete_at

string

delivery_cost

double

net_charge

double

taxes

double

type

string

required

Is not supported at the moment

delivery return

surcharges

double

discounts

double

tracking_number

string

deliver_by

string

carrier_reference_number

string

carrier

string

commercial_invoice

string

customer

object

label_type

string

required

The label file type.

PDF PNG ZPL JPG

tracking_url

string

required

packages_count

double

source_id

string

Your source system's ID for this shipment.

service

string

The service level for the quoted booking, such as same-day.

shipping_account_id

double

The shipping account used for the quoted booking.

sender_start

string

Is not supported at the moment. The start of the pickup time window.

sender_end

string

Is not supported at the moment. The end of the pickup time window.

recipient_start

string

Is not supported at the moment. The start of the dropoff time window.

recipient_end

string

Is not supported at the moment. The end of the dropoff time window.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us2-api.bringg.com/v2/orderso/order_id \
3
     --header 'accept: application/json'

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

application/json

200Success

400Bad Request

403Forbidden