Listar produtos
Escopo exigido: products:read.
query Parameters
limitQuantidade máxima de registros. O padrão é 50 e o máximo é 100.
pageÍndice de página começando em zero. A API devolve limit registros a partir de page × limit.
project_idApenas registros deste projeto.
typesimple ou bundle.
Listar produtos › Responses
Registros correspondentes. O corpo é um array JSON.
idId do produto.
nameNome.
typesimple ou bundle.
skuSKU.
descriptionDescrição.
imageURL da imagem.
show_full_productMostrar o bloco completo do produto.
pricePreço.
compare_pricePreço de comparação.
ratingRótulo de avaliação.
rating_countRótulo da quantidade de avaliações.
project_idId do projeto.
cta_textTexto do botão.
cta_urlURL do botão.
cta_targetAbrir a URL em uma nova aba.
use_single_cta_linkUsar um único link de chamada.
bundle_discountDesconto do bundle.
bundle_item_countQuantidade de itens do bundle.
tiers_enabledOs níveis de quantidade estão ativos.
subscription_enabledA opção de assinatura está ativa.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
Criar um produto
name é obrigatório. type é simple ou bundle. Um bundle exige bundle_items_json.
Escopo exigido: products:write.
Criar um produto › Request Body
nameNome.
typePadrão simple.
project_idId do projeto.
skuSKU.
descriptionDescrição.
imageURL da imagem.
pricePreço.
compare_pricePreço de comparação.
cta_textTexto do botão.
cta_urlURL do botão.
show_full_productMostrar o bloco completo.
cta_targetAbrir a URL em uma nova aba.
use_single_cta_linkUsar um único link.
ratingRótulo de avaliação. Padrão 4.9 se enviado vazio.
rating_countRótulo da quantidade.
trust_badges_jsonArray de rótulos, ou um string JSON.
variants_jsonArray de { id, name, image }, ou um string JSON.
tiers_enabledAtivar níveis de quantidade.
tiers_jsonObjetos de nível, ou um string JSON.
bundle_items_jsonObrigatório quando type é bundle.
bundle_discountDesconto do bundle.
subscription_jsonObjeto com enabled, discountPercent e benefits.
Criar um produto › Responses
O produto criado.
idId do produto.
nameNome.
typesimple ou bundle.
skuSKU.
descriptionDescrição.
imageURL da imagem.
show_full_productMostrar o bloco completo do produto.
pricePreço.
compare_pricePreço de comparação.
ratingRótulo de avaliação.
rating_countRótulo da quantidade de avaliações.
project_idId do projeto.
cta_textTexto do botão.
cta_urlURL do botão.
cta_targetAbrir a URL em uma nova aba.
use_single_cta_linkUsar um único link de chamada.
bundle_discountDesconto do bundle.
bundle_item_countQuantidade de itens do bundle.
tiers_enabledOs níveis de quantidade estão ativos.
subscription_enabledA opção de assinatura está ativa.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
Atualizar um produto
product_id é obrigatório. Envie apenas os campos que deseja alterar.
Escopo exigido: products:write.
Atualizar um produto › Request Body
product_idId do produto.
nameNovo nome.
typeskuSKU.
descriptionDescrição.
imageURL da imagem.
pricePreço.
compare_pricePreço de comparação.
project_idId do projeto.
cta_textTexto do botão.
cta_urlURL do botão.
show_full_productMostrar o bloco completo.
cta_targetAbrir em uma nova aba.
use_single_cta_linkUsar um único link.
ratingRótulo de avaliação.
rating_countRótulo da quantidade.
trust_badges_jsonRótulos.
variants_jsonObjetos de variante.
tiers_enabledAtivar níveis.
tiers_jsonObjetos de nível.
bundle_items_jsonItens do bundle.
bundle_discountDesconto.
subscription_jsonConfigurações de assinatura.
Atualizar um produto › Responses
O produto atualizado.
idId do produto.
nameNome.
typesimple ou bundle.
skuSKU.
descriptionDescrição.
imageURL da imagem.
show_full_productMostrar o bloco completo do produto.
pricePreço.
compare_pricePreço de comparação.
ratingRótulo de avaliação.
rating_countRótulo da quantidade de avaliações.
project_idId do projeto.
cta_textTexto do botão.
cta_urlURL do botão.
cta_targetAbrir a URL em uma nova aba.
use_single_cta_linkUsar um único link de chamada.
bundle_discountDesconto do bundle.
bundle_item_countQuantidade de itens do bundle.
tiers_enabledOs níveis de quantidade estão ativos.
subscription_enabledA opção de assinatura está ativa.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
Buscar produtos
Escopo exigido: products:read.
query Parameters
limitQuantidade máxima de registros. O padrão é 50 e o máximo é 100.
queryTexto sem distinção de maiúsculas comparado com o nome e os campos relacionados.
project_idApenas registros deste projeto.
typesimple ou bundle.
product_idId exato.
Buscar produtos › Responses
Registros correspondentes. O corpo é um array JSON.
idId do produto.
nameNome.
typesimple ou bundle.
skuSKU.
descriptionDescrição.
imageURL da imagem.
show_full_productMostrar o bloco completo do produto.
pricePreço.
compare_pricePreço de comparação.
ratingRótulo de avaliação.
rating_countRótulo da quantidade de avaliações.
project_idId do projeto.
cta_textTexto do botão.
cta_urlURL do botão.
cta_targetAbrir a URL em uma nova aba.
use_single_cta_linkUsar um único link de chamada.
bundle_discountDesconto do bundle.
bundle_item_countQuantidade de itens do bundle.
tiers_enabledOs níveis de quantidade estão ativos.
subscription_enabledA opção de assinatura está ativa.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
Obter um produto
Escopo exigido: products:read.
path Parameters
productIdId do produto.
Obter um produto › Responses
O produto.
idId do produto.
nameNome.
typesimple ou bundle.
skuSKU.
descriptionDescrição.
imageURL da imagem.
show_full_productMostrar o bloco completo do produto.
pricePreço.
compare_pricePreço de comparação.
ratingRótulo de avaliação.
rating_countRótulo da quantidade de avaliações.
project_idId do projeto.
cta_textTexto do botão.
cta_urlURL do botão.
cta_targetAbrir a URL em uma nova aba.
use_single_cta_linkUsar um único link de chamada.
bundle_discountDesconto do bundle.
bundle_item_countQuantidade de itens do bundle.
tiers_enabledOs níveis de quantidade estão ativos.
subscription_enabledA opção de assinatura está ativa.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.