Skip to main content
GET
Get Product

Path Parameters

entity_id
string<uuid>
required

Response

Successful Response

GET /v1/products item shape — adds a typed custom_fields map.

Inherits every ProductResponse field. custom_fields is keyed by field_key and resolved from the optional parent product; a value may be None when the underlying value_text is null but a definition exists.

id
string<uuid>
required
item_id
string
required
sku
string
required
product_id
string | null
product_name
string | null
product_group
string | null
manufacturer
string | null
brand
string | null
status
string | null
product_type
string | null
barcode
string | null
stock_on_hand
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
category_1
string | null
category_2
string | null
category_3
string | null
category_4
string | null
category_5
string | null
image_url
string | null
product_url
string | null
rrp
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
regular_price
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
product_created_date
string<date> | null
price_effective_date
string<date> | null
cost_effective_date
string<date> | null
size
string | null
color
string | null
uom
string | null
tax_rate
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
currency
string | null
custom_fields
Custom Fields · object | null
sku_name
string | null
current_price
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
unit_cost
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$