Skip to main content
GET
Get an order

Authorizations

Authorization
string
header
required

An organization API key (bg_live_…), created in BrandGate under Settings → Developers.

Path Parameters

id
string<uuid>
required

Response

Success.

id
string<uuid>
required
object
any
required
number
string
required
Maximum string length: 100
status
enum<string>
required
Available options:
draft,
pending_payment,
processing,
shipped,
delivered,
cancelled
order_date
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
due_date
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
currency
string
required
Maximum string length: 3
total
string
required
Pattern: ^-?\d{1,15}(\.\d{1,6})?$
vat
string
required
Pattern: ^-?\d{1,15}(\.\d{1,6})?$
total_excl_vat
string
required
Pattern: ^-?\d{1,15}(\.\d{1,6})?$
discount_amount
string
required
Pattern: ^-?\d{1,15}(\.\d{1,6})?$
po_reference
string | null
required
Maximum string length: 200
notes
string | null
required
Maximum string length: 4000
customer
object | null
required
ship_to
object | null
required
lines
object[]
required
external_reference
object | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required