Skip to main content
GET
List products

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

country_id
integer

Country ID to list products for. Defaults to the company's default country.

Response

Success

id
integer

Product ID.

title
string | null

Product title in the request language.

description
any

Product description as stored (rich text), or null.

stripped
string | null

Plain-text version of the description.

sku
string | null

Product SKU.

product_type
string | null

Product type, for example product.

external_id
string | null

Identifier from an external system, if any.

vendor
string | null

Vendor name.

active
boolean

Whether the product is active.

public
boolean | null

Whether the product is public.

in_stock
boolean | null

Stored in-stock flag.

out_of_stock
boolean | null

Whether the default variant cannot currently be bought.

low_in_stock
boolean | null

Whether the default variant has limited stock.

unlimited_inventory
boolean | null

Whether inventory is not tracked.

subscription_only
boolean | null

Whether the default variant can only be bought on subscription.

publish_to_portal_shop
boolean | null
publish_to_retail_store
boolean | null
publish_to_mobile_store
boolean | null
publish_to_share_tab
boolean | null
prompts_enabled
boolean | null
hide_rating?
boolean | null

Whether ratings are hidden for this product.

hide_reviews?
boolean | null

Whether reviews are hidden for this product.

commission
string | null

Commission rate as a decimal string.

shipping
string | null

Flat shipping amount as a decimal string.

price
string | null

Retail one-time price for the resolved country, or null when the product has no price there.

subscription_price
string | null

Retail subscription price, or null.

wholesale_price
string | null

Price for the caller's pricing tier (retail when the caller buys at retail), or null.

wholesale_subscription_price
string | null

Subscription price for the caller's pricing tier, or null.

display_price
string | null

Formatted retail price, or an empty string.

display_subscription_price
string | null

Formatted retail subscription price.

display_wholesale_price
string | null

Formatted tier price, or an empty string.

display_wholesale_subscription_price
string | null

Formatted tier subscription price.

price_range
(string | null)[] | null

Formatted lowest and highest variant prices.

price_range_formatted
string | null

Formatted price, or a "low - high" range.

currency_code
string | null

ISO 4217 currency code.

currency_symbol
string | null
country_code
string | null

Lowercase ISO code of the product's first available country.

wholesale_cv
any

Commission volume for the caller's tier, as a decimal string.

wholesale_qv
any

Qualifying volume for the caller's tier, as a decimal string.

views
integer | null

Views of the caller's shares of this product.

leads
integer | null

Leads from the caller's shares of this product.

The caller's share link, if one exists.

image_url
string | null

Thumbnail image URL.

image
object | null

Image URLs in mini, detail, and full sizes.

images
object[] | null

Ordered product images.

average_rating
number | null

Average review rating.

total_reviews
integer | null

Number of reviews.

label
object | null

Label shown on the product card, or null.

display_tag
string | null

Lowercase system label title, or null.

countries
object[] | null

Countries the product is available in.

variants
object[] | null

Variants with their per-country prices.

default_variant
object | null

The first purchasable variant, or null.

options
array | null

Product options, such as size or color.

option_values
any

Available option values for the resolved country, or null.

prompts
array | null

Share prompts for the product.

enroll_products
array | null

Enrollment pack entries that include this product.

enrollment_packs
array | null

Enrollment packs that include this product.