Skip to main content
GET
Get a product

Authorizations

Authorization
string
header
required

Workspace API key. The workspace is derived from the key.

Path Parameters

id
string<uuid>
required

Resource UUID.

Response

The product

id
string<uuid>
required
name
string
required
status
string
required
type
string
required
description
string
category
string

The primary category's name (the first of categories). Kept for backwards compatibility — prefer categories.

categories
object[]

The product's categories, ordered (first = primary). Each entry carries its parent/parent_slug, so a headless storefront can build /shop/{parent_slug}/{slug} links with no extra calls.

requires_shipping
boolean
can_preorder
boolean
total_stock
integer
price_range
object
options
object[]

The product's resolved options. Each variant's attributes is keyed by the option id here, so use this to map a variant back to option names/values.

media
object[]
variants
object[]

Created variants. Each variant's attributes maps an option id (see options) to the chosen value key.

created_at
string<date-time>
updated_at
string<date-time>