Skip to main content
GET
Product

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Path Parameters

productId
string<uuid>
required

The unique identifier for the product

Query Parameters

include
enum<string>

Comma-separated list of related resources to include in the response. Available options: linkedSubscriptions (includes full subscription details for products with linked subscriptions).

Available options:
linkedSubscriptions

Response

Product details

id
string<uuid>

Unique identifier for the product

name
string

Product name

slug
string

URL-friendly product identifier

url
string

Full URL to the product page

description
string

Product description

productType
enum<string>

Type of product

Available options:
physical,
event,
subscription,
bundle
subscriptionType
enum<string>

Type of subscription. Only present for subscription products

Available options:
picknmix,
variable
sku
string

Stock Keeping Unit

collections
object[]

Collections this product belongs to

status
enum<string>

Product status - automatically set to out_of_stock when quantity is 0

Available options:
active,
inactive,
out_of_stock
images
object

Product images organized by type

primaryImage
object

Primary product image

price
string

Formatted price (e.g., £10.00). For pick-and-mix subscriptions with per-item pricing, may show 'from £X.XX'

salePrice
string | null

Formatted sale price if on sale

subscriberPrice
string | null

Special price for subscribers. Not shown for subscription products

createdAt
string<date-time>

Creation timestamp

updatedAt
string<date-time>

Last update timestamp

storeSlug
string

Store URL slug

subscriptionsSlug
string

Subscriptions URL slug

availability
enum<string>

Product availability

Available options:
all,
subscribers
upsellProducts
object[]

Upsell products with simplified data

linkedSubscriptions
object[]

Full details of linked subscriptions. Only included when requested via the include query parameter.

billingFrequency
integer

Billing frequency in months. Only present for subscription products

billingFrequencies
integer[]

Available billing frequencies. Only present for subscription products

pricingType
enum<string>

Pricing type for subscriptions. Only present for subscription products

Available options:
fixed,
per_item
bundleItems
object[]

Items included in bundle. Only present for bundle products

attributes
object[]

Product attributes like color, size, etc.

options
object[]

Product options with their possible values

Related products

awards
object[]

Product awards

reviews
object[]

Product reviews

metaTitle
string

SEO meta title

metaDescription
string

SEO meta description

metaImage
string | null

SEO meta image URL (1200x630)

linkedSubscription
boolean

Whether product has linked subscriptions. Only present if product has linked subscriptions

storeName
string

Store name