Skip to main content
GET
TypeScript

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

access_pass:basic:read

Başlıklar

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Sorgu Parametreleri

account_id
string

Account to list products for, prefixed biz_. Without the access_pass:basic:read permission on it, only the products its store page lists are returned. Omit to search the public marketplace.

query
string

Filters products by text. The public marketplace list searches product title, account name, headline and description, ranking products that match every word first and the closest partial matches after them; an account's own list is a plain substring match over title, headline and description. Omit to browse by recency.

marketplace_category_route
string

Only return marketplace products assigned to this category route, such as trading.

billing_types
enum<string>[]

Filter to products with a buyable variant of these billing models, such as one_time or renewal. On an account list, needs the access_pass:basic:read permission.

Mevcut seçenekler:
renewal,
one_time
price_minimum
number

Only return products whose advertised buyable variant has a displayed price of at least this amount. Recurring variants use renewal price. On an account list, needs the access_pass:basic:read permission.

price_maximum
number

Only return products whose advertised buyable variant has a displayed price of at most this amount. Recurring variants use renewal price. On an account list, needs the access_pass:basic:read permission.

visibilities
string[]

Filter to only products matching these visibility states. Ignored on the public marketplace list, which only returns visible products. Without the access_pass:basic:read permission on the account, only visible matches anything.

access_pass_types
string[]

Filter to only products matching these types.

labels
string[]

Filter to only products carrying all of these labels. Labels are matched lowercased.

direction
enum<string>

The sort direction for results. Defaults to descending.

Mevcut seçenekler:
asc,
desc
order
enum<string>

Field to sort results by. Account lists default to created_at, and position with direction asc matches the order the store page shows. Without the access_pass:basic:read permission, an account list sorts only by created_at or position. Marketplace lists default to discoverable_at, accept only created_at or discoverable_at, and can't be combined with query.

Mevcut seçenekler:
created_at,
active_memberships_count,
usd_gmv,
usd_gmv_30_days,
position,
discoverable_at
first
integer
varsayılan:20

Number of results to return from the start of the range.

Gerekli aralık: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Gerekli aralık: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

include_total_count
boolean

Set to true to return the number of matching results in page_info.total_count. Send first=0 as well to return the count without any results.

created_after
string

Only return products created after this ISO 8601 timestamp.

created_before
string

Only return products created before this ISO 8601 timestamp.

Yanıt

store-listed products for a caller without access

data
object[]
gerekli
page_info
object
gerekli