List products
Required scope: products:read.
query Parameters
limitMaximum number of records. Defaults to 50 and cannot exceed 100.
pageZero-based page index. The API returns limit records starting at page × limit.
project_idOnly records in this project.
typesimple or bundle.
List products › Responses
Matching records. The body is a JSON array.
idProduct id.
nameProduct name.
typesimple or bundle.
skuSKU.
descriptionDescription.
imageImage URL.
show_full_productShow the full product block.
pricePrice.
compare_priceCompare-at price.
ratingRating label.
rating_countRating count label.
project_idProject id.
cta_textButton label.
cta_urlButton URL.
cta_targetOpen the button URL in a new tab.
use_single_cta_linkUse one call-to-action link.
bundle_discountBundle discount.
bundle_item_countNumber of bundle items.
tiers_enabledQuantity tiers are enabled.
subscription_enabledSubscription option is enabled.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
Create a product
name is required. type is simple or bundle. A bundle requires bundle_items_json.
Required scope: products:write.
Create a product › Request Body
nameProduct name.
typeDefaults to simple.
project_idProject id.
skuSKU.
descriptionDescription.
imageImage URL.
pricePrice.
compare_priceCompare-at price.
cta_textButton label.
cta_urlButton URL.
show_full_productShow the full product block.
cta_targetOpen the URL in a new tab.
use_single_cta_linkUse one call-to-action link.
ratingRating label. Defaults to 4.9 when sent empty.
rating_countRating count label.
trust_badges_jsonArray of badge labels, or a JSON string.
variants_jsonArray of { id, name, image }, or a JSON string.
tiers_enabledEnable quantity tiers.
tiers_jsonTier objects, or a JSON string.
bundle_items_jsonRequired when type is bundle.
bundle_discountBundle discount.
subscription_jsonObject with enabled, discountPercent, and benefits.
Create a product › Responses
The created product.
idProduct id.
nameProduct name.
typesimple or bundle.
skuSKU.
descriptionDescription.
imageImage URL.
show_full_productShow the full product block.
pricePrice.
compare_priceCompare-at price.
ratingRating label.
rating_countRating count label.
project_idProject id.
cta_textButton label.
cta_urlButton URL.
cta_targetOpen the button URL in a new tab.
use_single_cta_linkUse one call-to-action link.
bundle_discountBundle discount.
bundle_item_countNumber of bundle items.
tiers_enabledQuantity tiers are enabled.
subscription_enabledSubscription option is enabled.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
Update a product
product_id is required. Send only the fields you want to change.
Required scope: products:write.
Update a product › Request Body
product_idProduct id.
nameNew name.
typeskuSKU.
descriptionDescription.
imageImage URL.
pricePrice.
compare_priceCompare-at price.
project_idProject id.
cta_textButton label.
cta_urlButton URL.
show_full_productShow the full product block.
cta_targetOpen the URL in a new tab.
use_single_cta_linkUse one call-to-action link.
ratingRating label.
rating_countRating count label.
trust_badges_jsonBadge labels.
variants_jsonVariant objects.
tiers_enabledEnable quantity tiers.
tiers_jsonTier objects.
bundle_items_jsonBundle items.
bundle_discountBundle discount.
subscription_jsonSubscription settings.
Update a product › Responses
The updated product.
idProduct id.
nameProduct name.
typesimple or bundle.
skuSKU.
descriptionDescription.
imageImage URL.
show_full_productShow the full product block.
pricePrice.
compare_priceCompare-at price.
ratingRating label.
rating_countRating count label.
project_idProject id.
cta_textButton label.
cta_urlButton URL.
cta_targetOpen the button URL in a new tab.
use_single_cta_linkUse one call-to-action link.
bundle_discountBundle discount.
bundle_item_countNumber of bundle items.
tiers_enabledQuantity tiers are enabled.
subscription_enabledSubscription option is enabled.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
Search products
Required scope: products:read.
query Parameters
limitMaximum number of records. Defaults to 50 and cannot exceed 100.
queryCase-insensitive text matched against the record name and related fields.
project_idOnly records in this project.
typesimple or bundle.
product_idExact product id.
Search products › Responses
Matching records. The body is a JSON array.
idProduct id.
nameProduct name.
typesimple or bundle.
skuSKU.
descriptionDescription.
imageImage URL.
show_full_productShow the full product block.
pricePrice.
compare_priceCompare-at price.
ratingRating label.
rating_countRating count label.
project_idProject id.
cta_textButton label.
cta_urlButton URL.
cta_targetOpen the button URL in a new tab.
use_single_cta_linkUse one call-to-action link.
bundle_discountBundle discount.
bundle_item_countNumber of bundle items.
tiers_enabledQuantity tiers are enabled.
subscription_enabledSubscription option is enabled.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
Get a product
Required scope: products:read.
path Parameters
productIdProduct id.
Get a product › Responses
The product.
idProduct id.
nameProduct name.
typesimple or bundle.
skuSKU.
descriptionDescription.
imageImage URL.
show_full_productShow the full product block.
pricePrice.
compare_priceCompare-at price.
ratingRating label.
rating_countRating count label.
project_idProject id.
cta_textButton label.
cta_urlButton URL.
cta_targetOpen the button URL in a new tab.
use_single_cta_linkUse one call-to-action link.
bundle_discountBundle discount.
bundle_item_countNumber of bundle items.
tiers_enabledQuantity tiers are enabled.
subscription_enabledSubscription option is enabled.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.