Skip to main content
GET
Get a product

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
sku
string
required
Maximum string length: 200
name
string
required
Maximum string length: 500
description
string | null
required
Maximum string length: 20000
category
string | null
required
Maximum string length: 200
status
enum<string>
required
Available options:
active,
low_stock,
out_of_stock
unit_price
string
required
Pattern: ^-?\d{1,15}(\.\d{1,6})?$
currency
string
required
Maximum string length: 3
vat_rate
string | null
required
Pattern: ^-?\d{1,15}(\.\d{1,6})?$
stock
integer
required
min_order
integer
required
order_increment
integer | null
required
max_order
integer | null
required
image_url
string | null
required
Maximum string length: 2000
created_at
string<date-time>
required
updated_at
string<date-time>
required