Skip to main content
PUT
Atualizar checkout
Requer o escopo checkouts:write e o header HTTP Idempotency-Key.
Este PUT é um merge, e não uma substituição. Todos os campos são opcionais e o que você não envia fica como está: os meios de pagamento, os descontos, o parcelamento, o backredirect, a prova social e os scripts customizados do checkout continuam intactos depois de uma edição que só troca o nome.
O que a edição alcança é a apresentação: nome, template, tema, status, modo escuro, as três cores e os cinco slots de imagem. Tudo o mais é configuração do painel.
secondary_color não é aceito e derruba a requisição com 422. Os campos de cor são primary_color, header_bg_color e header_text_color.
Cada slot de imagem (logo, top_banner, top_2_banner, sidebar_banner, footer_banner) aceita um data URI base64 ou o valor já gravado, devolvido como veio. Uma URL externa não é baixada. Um checkout de outra conta retorna 404 sem escrever nada. Veja a receita Criar produto e checkout.

Authorizations

Authorization
string
header
required

A chave de API da conta, no formato sk_{modo}_{prefixo}.{segredo}.

Headers

Idempotency-Key
string
required

Chave única da operação. Obrigatória em toda requisição que altera dados; sem ela a resposta é 422 idempotency_key_required. Um reenvio com a mesma chave e o mesmo corpo repete a resposta guardada.

Maximum string length: 255

Path Parameters

id
integer
required

Body

application/json

Body of PUT /v2/public/checkouts/{id}: the allowlisted presentation columns of a checkout, every one of them optional. Ported from the source UpdateCheckoutRequest (SHA 70cd772) minus secondary_color, which the core's checkout has no column for.

Everything else about the checkout (payment methods, countdown, thank-you pages, custom scripts, which checkout is the product's default) stays out on purpose: those are the panel's, and the patch leaves them exactly as stored.

name
string
Maximum string length: 255
template
string
Maximum string length: 100
checkout_theme_id
integer | null

Not checked against checkout_themes: that table is Checkout's and this module may not query it. An unknown id is refused by the foreign key rather than by a probe of another context's table.

Required range: x >= 1
status
string
Maximum string length: 50
dark_mode
boolean
primary_color
string | null
Maximum string length: 30
header_bg_color
string | null
Maximum string length: 30
header_text_color
string | null
Maximum string length: 30
logo
string | null

Each image is either a base64 data URI (a new one) or the stored value echoed back; Checkout decides which and uploads accordingly.

top_banner
string | null
top_2_banner
string | null
sidebar_banner
string | null

Response

ApiCheckoutResource

data
ApiCheckoutResource · object
required