Skip to main content
GET
/
public_api
/
products
/
{id}
cURL
curl --request GET \
  --url https://api.cakto.com.br/public_api/products/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "cd287b31-d4b7-4e94-858a-66e05ce2f4a2",
  "short_id": "19bruPi",
  "name": "Product Name Example",
  "status": "active",
  "type": "unique",
  "description": "Description example",
  "category": "0673d296-1802-45e0-bc93-112f7514dddb",
  "price": "5.00",
  "installments": 12,
  "image": null,
  "guarantee": 7,
  "salesPage": "https://example-sales-page.com.br/product-page",
  "supportEmail": "[email protected]",
  "supportWhatsapp": null,
  "contentDeliveries": [
    "cakto",
    "telegram",
    "discord"
  ],
  "emailAccessLink": null,
  "confirmEmail": false,
  "affiliate": true,
  "affiliateRequest": false,
  "affiliateCommission": "10.00",
  "affiliateContact": false,
  "affiliateDescription": "teste",
  "affiliateSupportEmail": "",
  "affiliateMarketplace": false,
  "affiliateClick": "last",
  "cookieTime": -1,
  "affiliateShareBump": false,
  "affiliateShareUpsell": false,
  "affiliateCloneQuiz": false,
  "affiliateCloneQuizUrl": "",
  "affiliateSalesPage": "",
  "upsell": false,
  "upsellPage": "",
  "redirectUpsellWithBumpFail": true,
  "defaultPaymentMethod": "credit_card",
  "showCouponField": true,
  "showAddressFields": false,
  "threeDsRetryEnabled": true,
  "offers": [
    {
      "id": "77BcHrY",
      "name": "Product Name Example",
      "image": null,
      "price": 5,
      "units": 1,
      "default": true,
      "status": "active",
      "cost_per_item": "0.00",
      "profit_per_item": "0.00",
      "type": "unique",
      "intervalType": "year",
      "interval": 1,
      "recurrence_period": 30,
      "quantity_recurrences": -1,
      "trial_days": 0,
      "max_retries": 3,
      "retry_interval": 1,
      "checkout": 200300400,
      "height": null,
      "width": null,
      "length": null,
      "weight": null
    }
  ],
  "invoiceDescription": "CardDesc",
  "paymentMethods": [
    "boleto",
    "credit_card",
    "picpay",
    "pix"
  ],
  "paymentsOrder": [
    "openfinance_nubank",
    "credit_card",
    "boleto",
    "pix",
    "picpay",
    "applepay",
    "googlepay"
  ],
  "ticketExpiration": 7,
  "pixExpiresIn": 3600,
  "twoCardPayment": false,
  "bumps": [],
  "tracking_pixels": {
    "id": 200300400,
    "fbPixPurchaseTrigger": true,
    "fbPixConversionValue": 50,
    "fbBoletoPurchaseTrigger": true,
    "fbBoletoConversionValue": 100,
    "fbPicpayPurchaseTrigger": true,
    "fbPicpayConversionValue": 100,
    "fbNubankPurchaseTrigger": true,
    "fbNubankConversionValue": 100,
    "googleAnalyticsTrackingId": null,
    "tiktokPixPurchaseTrigger": true,
    "tiktokPixConversionValue": 100,
    "tiktokBoletoPurchaseTrigger": true,
    "tiktokBoletoConversionValue": 100,
    "tiktokPicpayPurchaseTrigger": true,
    "tiktokPicpayConversionValue": 100,
    "tiktokNubankPurchaseTrigger": true,
    "tiktokNubankConversionValue": 100,
    "kwaiPixPurchaseTrigger": true,
    "kwaiPixConversionValue": 100,
    "kwaiBoletoPurchaseTrigger": true,
    "kwaiBoletoConversionValue": 100,
    "kwaiPicpayPurchaseTrigger": true,
    "kwaiPicpayConversionValue": 100,
    "kwaiNubankPurchaseTrigger": true,
    "kwaiNubankConversionValue": 100,
    "facebook_pixels": [
      {
        "id": 200300400,
        "name": null,
        "description": null,
        "status": "active",
        "pixelId": "123456789010102030",
        "error": null,
        "domain": "",
        "apiToken": "TokenExample123",
        "fbPixPurchaseTrigger": null,
        "fbPixConversionValue": null,
        "fbBoletoPurchaseTrigger": null,
        "fbBoletoConversionValue": null,
        "fbPicpayPurchaseTrigger": null,
        "fbPicpayConversionValue": null,
        "fbNubankPurchaseTrigger": null,
        "fbNubankConversionValue": null,
        "createdAt": "2022-09-01T17:43:12.795070-03:00"
      }
    ],
    "google_ads_pixels": [],
    "taboola_pixels": [],
    "outbrain_pixels": [],
    "tiktok_pixels": [],
    "kwai_pixels": [],
    "pixel_domains": []
  },
  "disable_orderbump_pixel_events": true,
  "producerName": "Testeando",
  "createdAt": "2022-03-28T13:04:26.191272-03:00",
  "updatedAt": "2027-11-26T22:16:34.095632-03:00"
}

​
Escopo

    read products

Authorizations

​
Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

​
id
string<uuid>
required

Id do Produto

Response

Corpo da resposta status 200

​
name
string
required

Nome do produto

Maximum string length: 255
​
description
string
required

Descrição do produto

​
contentDeliveries
enum<string>[]
required

Métodos de entrega de conteúdo do produto

  • external - Área de membros Externa
  • cakto - Área de membros Cakto V1
  • cakto_v2 - Cakto Members
  • telegram - Telegram
  • discord - Discord
  • emailAccess - Link de acesso via E-mail
  • files - E-book/Arquivos via E-mail
  • disabled - Desabilitado
Available options:
external,
cakto,
cakto_v2,
telegram,
discord,
emailAccess,
files,
disabled
​
offers
object[]
required
​
paymentMethods
enum<string>[]
required

Métodos de pagamento que o produto aceita

  • pix - Pix
  • pix_auto - Pix Automático
  • boleto - Boleto
  • credit_card - Cartão de Crédito
  • threeDs - Cartão de Crédito 3DS
  • picpay - Pic Pay
  • googlepay - Google Pay
  • applepay - Apple Pay
  • openfinance_nubank - Nubank
Available options:
pix,
pix_auto,
boleto,
credit_card,
threeDs,
picpay,
googlepay,
applepay,
openfinance_nubank
​
bumps
object[]
required

Orderbumps do produto

​
tracking_pixels
object
required
​
createdAt
string<date-time>
required

Data e hora de criação

​
updatedAt
string<date-time>
required

Data e hora da última atualização

​
id
string

Identificador único do produto

Maximum string length: 255
​
short_id
string

Identificador curto do produto

Maximum string length: 40
​
status
enum<string>

Status atual do produto

  • active - Ativo
  • blocked - Bloqueado
  • deleted - Deletado
Available options:
active,
blocked,
deleted
​
type
enum<string>

Tipo de venda do produto, ex.: venda única, assinatura...

  • unique - Pagamento único
  • subscription - Assinatura recorrente
Available options:
unique,
subscription
​
category
string | null

Categoria do produto

​
price
string<decimal>

Preço do produto

​
installments
integer

Número máximo de parcelas que o produto pode ser dividido

​
image
string<uri> | null

Imagem do produto

​
guarantee
integer

Número de dias que o produto aceita reembolso

​
salesPage
string<uri> | null

Link da página de vendas do produto

Maximum string length: 2048
​
supportEmail
string<email> | null

E-mail para suporte ao cliente final do produto

Maximum string length: 254
​
supportWhatsapp
string | null

Número de WhatsApp para suporte ao cliente, em formato ITU E.164, ex.: +5511999993333

Maximum string length: 128
​
emailAccessLink
string<uri> | null

Link a ser enviado por e-mail para acesso ao conteúdo após a compra

Maximum string length: 2048
​
confirmEmail
boolean

Define se o cliente deve repetir o e-mail digitado no checkout antes de finalizar a compra

​
affiliate
boolean

Define se o produto é aberto para afiliações

​
affiliateRequest
boolean

Define se o produtor deve aprovar manualmente cada afiliação

​
affiliateCommission
string<decimal> | null

Porcentagem de comissão padrão para afiliados do produto

​
affiliateContact
boolean

Define se informações do cliente serão compartilhadas com os afiliados após a venda

​
affiliateDescription
string | null

Descrição do produto que será exibida para os afiliados no marketplace e/ou páginas dedicadas a afiliação

​
affiliateSupportEmail
string<email> | null

E-mail para suporte aos afiliados do produto

Maximum string length: 254
​
affiliateMarketplace
boolean

Define se o produto será exibido no marketplace de afiliados

​
affiliateClick
enum<string>

Define como a comissão da venda será atribuída caso haja múltiplos cookies de afiliados rastreados na venda

  • first - Primeiro clique
  • last - Último clique
Available options:
first,
last
​
cookieTime
integer

Quantidade de dias que o cookie de afiliado permanecerá ativo

​
affiliateShareBump
boolean

Define se a comissão do orderbump será dividida com o afiliado

​
affiliateShareUpsell
boolean

Define se a comissão do upsell será dividida com o afiliado

​
affiliateCloneQuiz
boolean

Habilitar clonagem do quiz

​
affiliateCloneQuizUrl
string<uri> | null

Link para clonagem do quiz

Maximum string length: 2048
​
affiliateSalesPage
string<uri> | null

Página de vendas do afiliado

Maximum string length: 2048
​
upsell
boolean

Define se o produto terá uma oferta de upsell após a compra

​
upsellPage
string<uri> | null

URL da página de upsell para onde o cliente será redirecionado após a compra

Maximum string length: 2048
​
redirectUpsellWithBumpFail
boolean

Define se o cliente deve ser redirecionado para a página de upsell mesmo que um dos pagamentos de orderbump falhe

​
defaultPaymentMethod
string | null

Método de pagamento selecionado por padrão no checkout

​
showCouponField
boolean
​
showAddressFields
boolean

Exibe campos de endereço no checkout, como CEP, rua, número, etc

​
threeDsRetryEnabled
boolean

Caso o pagamento falhe no cartão de crédito, será tentado novamente via 3DS

​
invoiceDescription
string | null

Descrição que aparecerá na fatura do cartão de crédito do cliente

Maximum string length: 255
​
paymentsOrder
any

Ordem na qual os métodos de pagamento são exibidos no checkout

​
ticketExpiration
integer

Quantidade de dias que o boleto será válido para pagamento

​
pixExpiresIn
integer

Vencimento do pix em segundos

​
twoCardPayment
boolean
​
disable_orderbump_pixel_events
boolean

Define se eventos de orderbump não serão enviados no Pixel

​
producerName
string | null

Nome público do produtor ou empresa responsável pelo produto

Maximum string length: 255