Skip to main content
GET
Retrieve a product

Authorizations

Authorization
string
header
required

A store API key, sent as Authorization: Bearer <key>. Live keys are prefixed tbrn_live_. Keys are minted per store in the dashboard with an explicit scope set.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

The product.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
title
string
required
body
string | null
required
price
string
required

Fiat amount as a decimal string, e.g. "9.99". Never a number.

currency
enum<string>
required
Available options:
usd,
eur
productType
enum<string>
required
Available options:
single-purchase
listed
boolean
required
image
string | null
required
deliveryType
enum<string> | null
required
Available options:
text_pool,
text_shared,
file_shared,
redirect
stock
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
minQuantity
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
maxQuantity
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
createdAt
string<date-time>
required

ISO-8601 timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt
string<date-time> | null
required

ISO-8601 timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$