Skip to main content
GET
Get a product

Authorizations

Authorization
string
header
required

Send your workspace API key as a bearer token:

Keys are scoped to a single workspace. See Authentication.

Path Parameters

product_id
string
required

The Unif ID of the product.

Query Parameters

period
enum<string>
default:last_30d

A named period. Mutually exclusive with period_start and period_end.

Available options:
last_7d,
last_30d,
last_90d,
last_180d,
month_to_date,
previous_month
period_start
string<date>

First day of a custom period, inclusive.

period_end
string<date>

Last day of a custom period, inclusive.

currency
string
default:USD

Convert every monetary field to this ISO 4217 currency.

Examples:

"USD"

"GBP"

"IDR"

Response

The product.

A listing sold through a shop on a channel.

id
string
Example:

"prd_01k3m9x7v2q8r4t6y0b1n5d7fa"

object
string
Allowed value: "product"
channel
enum<string>

A sales channel — the commerce surface a request is about. Behind each channel is a cascade of data sources, tried in cost order until one verifies; the roster is published, but which source answered a given row is not carried in the response, so the cascade can be re-tuned without breaking your code.

Available options:
tiktok_shop
Example:

"tiktok_shop"

market
enum<string>

An ISO 3166-1 alpha-2 country code identifying a channel storefront.

Available options:
US,
GB,
IE,
ES,
FR,
DE,
IT,
ID,
TH,
VN,
MY,
PH,
SG,
JP,
BR,
MX
Example:

"US"

title
string
Example:

"Ceramide Barrier Repair Serum 30ml"

url
string<uri>
image_url
string<uri>
brand
string | null
shop
object
category
object
price
object
commission_rate
number | null

Affiliate commission offered to creators, as a ratio.

rating
number | null
Required range: 0 <= x <= 5
reviews_count
integer | null
listed_at
string<date> | null
metrics
object
period
object

The concrete window a request was measured over, after any preset was expanded and any channel-specific snapping was applied. Always read this rather than assuming you got back exactly the dates you asked for.

currency
string
meta
object

How current and how complete this record is.