cURL
curl --request PUT \
--url https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"config": "<unknown>",
"default": true,
"visits": -1
}
'import requests
url = "https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/"
payload = {
"name": "<string>",
"config": "<unknown>",
"default": True,
"visits": -1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', config: '<unknown>', default: true, visits: -1})
};
fetch('https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'config' => '<unknown>',
'default' => true,
'visits' => -1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"config\": \"<unknown>\",\n \"default\": true,\n \"visits\": -1\n}"
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.put("https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": \"<unknown>\",\n \"default\": true,\n \"visits\": -1\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"<string>\",\n \"config\": \"<unknown>\",\n \"default\": true,\n \"visits\": -1\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
{
"id": 123,
"name": "<string>",
"offers": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"config": "<unknown>",
"default": true,
"visits": -1
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}Checkouts
Personalizar Checkout
Personalize a aparência e comportamento da página de checkout. Atualize a experiência de compra do cliente com configurações visuais e componentes customizados.
PUT
/
public_api
/
products
/
{product_pk}
/
checkouts
/
{id}
/
cURL
curl --request PUT \
--url https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"config": "<unknown>",
"default": true,
"visits": -1
}
'import requests
url = "https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/"
payload = {
"name": "<string>",
"config": "<unknown>",
"default": True,
"visits": -1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', config: '<unknown>', default: true, visits: -1})
};
fetch('https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'config' => '<unknown>',
'default' => true,
'visits' => -1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"config\": \"<unknown>\",\n \"default\": true,\n \"visits\": -1\n}"
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.put("https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": \"<unknown>\",\n \"default\": true,\n \"visits\": -1\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/products/{product_pk}/checkouts/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"<string>\",\n \"config\": \"<unknown>\",\n \"default\": true,\n \"visits\": -1\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
{
"id": 123,
"name": "<string>",
"offers": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"config": "<unknown>",
"default": true,
"visits": -1
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}Escopo
write products
O checkout é construído a partir de uma estrutura declarativa compatível com o Checkout Builder, permitindo experiências diferentes para desktop e mobile. Para o formato completo — tipos de bloco, atributos válidos e como imagens funcionam — veja Estrutura do Checkout.
Sempre deve existir um checkout padrão ativo para o produto. Para alterar o checkout principal, defina outro checkout com
"default": true.Casos de uso
- Criar checkouts com branding personalizado — adapte cores, logo e identidade visual da página de compra.
- Exibir layouts diferentes por dispositivo — ofereça experiências otimizadas para desktop e mobile.
- Destacar ofertas específicas — construa páginas focadas em upsells, downsells ou ofertas principais.
- Construir experiências otimizadas para conversão — teste elementos, copy e estrutura que convertem mais.
- Testar variações de checkout — crie e compare diferentes versões da página de compra.
Exemplo de configuração
Expandir exemplo completo de config
Expandir exemplo completo de config
{
"mobile": {
"rows": [
{
"id": "369db380-d652-4b4f-bf0e-31710f1cfc03",
"type": "row",
"layout": [12],
"columns": [
{
"id": "e0253c14-37ea-47f7-b77a-e260cb814a6f",
"type": "column",
"components": []
}
]
},
{
"id": "7e8b3918-b6a8-4d10-b66a-024f5812d7e1",
"type": "row",
"layout": [12],
"columns": [
{
"id": "fb131cd7-57e8-4981-931a-9d71a3fe6ca9",
"type": "column",
"components": [
{
"id": "cff7c565-5957-4330-be70-b804878827dd",
"type": "checkout",
"attributes": {}
}
]
}
]
}
],
"extra": {
"chat": {
"id": "8f5c57d5-1548-4474-a5fd-fa91d408cdd1",
"type": "chat",
"attributes": {
"enabled": false,
"provider": "whatsapp",
"accountId": ""
}
},
"exitPopup": {
"id": "9f8d9444-d0f5-429d-9c06-fd2fa22d8adc",
"type": "exitPopup",
"attributes": {
"enabled": false,
"title": "Temos uma oferta especial para você!",
"actionLabel": "Sim, eu quero!",
"description": "Escreva algo aqui para convencer o cliente a não sair da página",
"actionOnClick": "offer",
"textButtonColor": "#ffffff",
"backgroundButtonColor": "#0f7865"
}
},
"notification": {
"id": "26c584c9-6006-4d46-b7a6-e69197f1db8f",
"type": "notification",
"attributes": {
"enabled": false
}
}
},
"settings": {
"box": {
"default": {
"text": { "color": { "primary": "#000000", "secondary": "#000000" } },
"header": { "text": { "color": { "primary": "#000000", "secondary": "#000000" } }, "background": { "color": "#D1D1D1" } },
"background": { "color": "#EDEDED" }
},
"selected": {
"text": { "color": { "primary": "#4B5563", "secondary": "#4B5563" } },
"header": { "text": { "color": { "primary": "#ffffff", "secondary": "#ffffff" } }, "background": { "color": "#0B6856" } },
"background": { "color": "#ffffff" }
},
"unselected": {
"text": { "color": { "primary": "#4B5563", "secondary": "#4B5563" } },
"header": { "text": { "color": { "primary": "#000000", "secondary": "#000000" } }, "background": { "color": "#D1D1D1" } },
"background": { "color": "#EDEDED" }
}
},
"font": { "family": "Roboto" },
"form": { "background": { "color": "#ffffff" } },
"icon": { "color": "#000000" },
"text": { "color": { "active": "#0B6856", "primary": "#000000", "secondary": "#4B5563" } },
"payButton": {
"text": { "text": "PAGAR AGORA", "color": "#ffffff" },
"color": "#0B6856"
},
"background": { "color": "#f1f1f1", "cover": false, "fixed": false, "image": null, "repeat": false },
"paymentOptions": {
"button": {
"selected": { "icon": { "color": "#ffffff" }, "text": { "color": "#ffffff" }, "background": { "color": "#0B6856" } },
"unselected": { "icon": { "color": "#000000" }, "text": { "color": "#4B5563" }, "background": { "color": "#ffffff" } }
}
}
}
},
"offers": ["zyb57dg"],
"default": true
}
Authorizations
Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
Nome do checkout
Maximum string length:
255Data e hora da última atualização
Data e hora de criação
Configuração personalizada do checkout em formato JSON
Define se este é o checkout padrão do produto
Quantidade de visitas ao checkout
Required range:
-2147483648 <= x <= 2147483647Was this page helpful?