Put public_apiproductsid — cakto-api

v1

latestOpenAPI 3.0.32026-07-2647114182.1 KB

products

Public API for managing products, inherits from ProductRetrieveAPI and ProductAPI, customizes the schema generation and authentication/permission settings.

put/public_api/products/{id}/

Path parameters

idstring uuid required

Id do Produto

Request body

namestring required

Nome do produto

status'active' | 'blocked' | 'deleted'

active - Ativo
blocked - Bloqueado
deleted - Deletado

type'unique' | 'subscription'

unique - Pagamento único
subscription - Assinatura recorrente

descriptionstring required

Descrição do produto

categorystring nullable

Categoria do produto

pricestring decimal

Preço do produto

installmentsinteger

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

imagestring uri nullable

Imagem do produto

guaranteeinteger

Número de dias que o produto aceita reembolso

salesPagestring uri nullable

Link da página de vendas do produto

supportEmailstring email nullable

E-mail para suporte ao cliente final do produto

supportWhatsappstring nullable

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

contentDeliveriesContentDeliveriesEnum[] required

Métodos de entrega de conteúdo do produto

emailAccessLinkstring uri nullable

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

confirmEmailboolean

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

affiliateboolean

Define se o produto é aberto para afiliações

affiliateRequestboolean

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

affiliateCommissionstring decimal nullable

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

affiliateContactboolean

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

affiliateDescriptionstring nullable

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

affiliateSupportEmailstring email nullable

E-mail para suporte aos afiliados do produto

affiliateMarketplaceboolean

Define se o produto será exibido no marketplace de afiliados

affiliateClick'first' | 'last'

first - Primeiro clique
last - Último clique

cookieTimeinteger

Quantidade de dias que o cookie de afiliado permanecerá ativo

affiliateShareBumpboolean

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

affiliateShareUpsellboolean

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

affiliateCloneQuizboolean

Habilitar clonagem do quiz

affiliateCloneQuizUrlstring uri nullable

Link para clonagem do quiz

affiliateSalesPagestring uri nullable

Página de vendas do afiliado

upsellboolean

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

upsellPagestring uri nullable

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

redirectUpsellWithBumpFailboolean

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

defaultPaymentMethodstring nullable

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

showCouponFieldboolean

showAddressFieldsboolean

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

threeDsRetryEnabledboolean

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

invoiceDescriptionstring nullable

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

paymentMethodsPaymentMethodsEnum[] required

Métodos de pagamento que o produto aceita

{"stackTrail":"components:schemas:ProductUpdateSchema:properties:paymentsOrder","oasType":"schema","type":"unknown","title":"Ordem dos métodos de pagamento","description":"Ordem na qual os métodos de pagamento são exibidos no checkout"}

ticketExpirationinteger

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

pixExpiresIninteger

Vencimento do pix em segundos

twoCardPaymentboolean

disable_orderbump_pixel_eventsboolean

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

producerNamestring nullable

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

createdAtstring date-time required

Data e hora de criação

updatedAtstring date-time required

Data e hora da última atualização

Response

Corpo da resposta status 200

idstring

Identificador único do produto

short_idstring

Identificador curto do produto