cURL
curl --request GET \
--url https://api.cakto.com.br/public_api/orders/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/orders/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cakto.com.br/public_api/orders/', 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/orders/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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/orders/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.cakto.com.br/public_api/orders/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/orders/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"refId": "CATDiPp",
"status": "refunded",
"type": "unique",
"offer_type": "main",
"baseAmount": "33.00",
"discount": "0.00",
"amount": "34.35",
"coupon": null,
"couponCode": null,
"reason": null,
"refund_reason": null,
"product": {
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"name": "Product Name",
"image": "https://api.cakto.com.br/images/products/product_logo.png",
"description": "Product description",
"price": 33,
"type": "unique",
"contentDeliveries": [
"cakto_v2",
"emailAccess"
],
"emailAccessLink": "https://example-email-to-send-to-customers.com.br",
"salesPage": "https://api.cakto.com.br/dashboard/products",
"status": "active",
"paymentMethods": [
"boleto",
"credit_card",
"pix"
],
"category": {
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"name": "Cat2"
}
},
"checkout": 52,
"subscription": null,
"subscription_period": null,
"installments": 1,
"paymentMethod": "credit_card",
"createdAt": "2025-10-03T11:19:35.019507-03:00",
"due_date": null,
"paidAt": "2025-10-03T11:19:37.064939-03:00",
"releaseDate": null,
"refundedAt": "2025-10-29T18:35:40.729119-03:00",
"chargedbackAt": null,
"canceledAt": null,
"customer": {
"name": "Customer Name Example",
"email": "teste74727@gmail.com",
"birthDate": null,
"phone": "16999997777",
"docType": "cpf",
"docNumber": "11199933377"
},
"address": {
"country": "BR",
"state": "MG",
"city": "Monte Carmelo",
"zipcode": "38500000",
"street": "Rua Teste",
"neighborhood": "Centro",
"complement": "Point of reference",
"number": "177"
},
"shipping": null,
"fees": "1.52",
"commissionedUsers": [
{
"id": 1,
"email": "teste@teste.com"
},
{
"id": 2,
"email": "testeando@teste.com"
}
],
"commissions": [
{
"userId": "1",
"type": "producer",
"commissionPercentage": 50,
"commissionValue": 15.41
},
{
"userId": "2",
"type": "coproducer",
"commissionPercentage": 50,
"commissionValue": 15.42
}
],
"utm_source": "",
"utm_medium": "",
"utm_campaign": "",
"utm_term": "",
"utm_content": "",
"sck": null,
"checkoutUrl": "https://pay.cakto.com.br/EXAMPLE"
}
]
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}Pedidos
Listar Pedidos
Lista pedidos da sua conta com suporte a filtros, busca e paginação
GET
/
public_api
/
orders
/
cURL
curl --request GET \
--url https://api.cakto.com.br/public_api/orders/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/orders/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cakto.com.br/public_api/orders/', 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/orders/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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/orders/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.cakto.com.br/public_api/orders/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/orders/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"refId": "CATDiPp",
"status": "refunded",
"type": "unique",
"offer_type": "main",
"baseAmount": "33.00",
"discount": "0.00",
"amount": "34.35",
"coupon": null,
"couponCode": null,
"reason": null,
"refund_reason": null,
"product": {
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"name": "Product Name",
"image": "https://api.cakto.com.br/images/products/product_logo.png",
"description": "Product description",
"price": 33,
"type": "unique",
"contentDeliveries": [
"cakto_v2",
"emailAccess"
],
"emailAccessLink": "https://example-email-to-send-to-customers.com.br",
"salesPage": "https://api.cakto.com.br/dashboard/products",
"status": "active",
"paymentMethods": [
"boleto",
"credit_card",
"pix"
],
"category": {
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"name": "Cat2"
}
},
"checkout": 52,
"subscription": null,
"subscription_period": null,
"installments": 1,
"paymentMethod": "credit_card",
"createdAt": "2025-10-03T11:19:35.019507-03:00",
"due_date": null,
"paidAt": "2025-10-03T11:19:37.064939-03:00",
"releaseDate": null,
"refundedAt": "2025-10-29T18:35:40.729119-03:00",
"chargedbackAt": null,
"canceledAt": null,
"customer": {
"name": "Customer Name Example",
"email": "teste74727@gmail.com",
"birthDate": null,
"phone": "16999997777",
"docType": "cpf",
"docNumber": "11199933377"
},
"address": {
"country": "BR",
"state": "MG",
"city": "Monte Carmelo",
"zipcode": "38500000",
"street": "Rua Teste",
"neighborhood": "Centro",
"complement": "Point of reference",
"number": "177"
},
"shipping": null,
"fees": "1.52",
"commissionedUsers": [
{
"id": 1,
"email": "teste@teste.com"
},
{
"id": 2,
"email": "testeando@teste.com"
}
],
"commissions": [
{
"userId": "1",
"type": "producer",
"commissionPercentage": 50,
"commissionValue": 15.41
},
{
"userId": "2",
"type": "coproducer",
"commissionPercentage": 50,
"commissionValue": 15.42
}
],
"utm_source": "",
"utm_medium": "",
"utm_campaign": "",
"utm_term": "",
"utm_content": "",
"sck": null,
"checkoutUrl": "https://pay.cakto.com.br/EXAMPLE"
}
]
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}Escopo
read orders
Filtros Disponíveis
Filtros podem ser combinados para refinar ainda mais os resultados.Exemplo:
?customer=123&status=paid,waiting_payment - Filtra pedidos do cliente com Id 123 que estão com status pago ou aguardando pagamento.Filtros por Identificação
Filtros por Identificação
id- Id do pedido (múltiplos valores separados por vírgula)refId- Id de referência do pedido (múltiplos valores separados por vírgula)
?refId=ORDER123 - Filtra pedidos com Id de referência “ORDER123”Filtros por Valor
Filtros por Valor
amount- Valor total do pedidobaseAmount- Valor base do pedido (sem taxa de parcelamento)discount- Valor do desconto aplicado (cupom, se houver)
Suporte a operadores de comparação (
__gt, __gte, __lt, __lte)?amount__gte=1040 - Filtra pedidos com valor maior ou igual a R$ 10,40Filtros por Datas
Filtros por Datas
createdAt- Data de criação do pedidoupdatedAt- Data de atualização do pedidopaidAt- Data de confirmação do pagamentorefundedAt- Data do reembolsochargedbackAt- Data do chargebackcanceledAt- Data do cancelamento (normalmente para assinaturas)due_date- Data de agendamento do pagamento (normalmente para assinaturas)
Suporte a operadores de comparação (
__gt, __gte, __lt, __lte)Formato de data:
YYYY-MM-DD ou ISO 8601 YYYY-MM-DDTHH:MM:SS±hh:mm?paidAt__gte=2024-01-01&paidAt__lt=2024-02-01 - Filtra pedidos pagos em janeiro de 2024Filtros por Status
Filtros por Status
status- Status do pedido
Suporte a múltiplos valores separados por vírgula.
?status=paid,refunded - Filtra pedidos pagos ou reembolsadosFiltros por Tipo
Filtros por Tipo
offer_type- Tipo da oferta (main, upsell, downsell, orderbump)type- Tipo do produto (unique, subscription)
Suporte a múltiplos valores separados por vírgula.
?offer_type=main,upsell&type=subscription - Filtra pedidos de ofertas principais e upsell de produtos recorrentesFiltros por Relacionamentos
Filtros por Relacionamentos
customer- Id, nome, email ou documento do clienteaffiliate- Id ou email do afiliadoproduct- Id ou nome do produtoproducts- Id dos produtos (múltiplos valores suportados)offer- Id da oferta (múltiplos valores suportados)checkout- Id do checkout (múltiplos valores suportados)
?product=123&affiliate=456 - Filtra pedidos de um produto específico vendidos por um afiliadoOutros Filtros
Outros Filtros
paymentMethod- Método de pagamento (múltiplos valores suportados)coproductionType- Tipo de coprodução (production, coproduction, affiliate)installments- Número de parcelas (múltiplos valores suportados)couponCode- Código do cupom utilizadoutm_source- Fonte da campanhautm_medium- Meio da campanhautm_campaign- Nome da campanhautm_term- Termo da campanhautm_content- Conteúdo da campanhacheckoutURL- URL do checkout (busca parcial case-insensitive)referererURL- URL de referência (busca parcial case-insensitive)reason- Motivo de recusa do pagamento (busca parcial case-insensitive)
?paymentMethod=credit_card&installments=12 - Filtra pedidos pagos em 12x no cartão de créditoDados do Cliente e Endereço
Importante: Os dados do cliente retornados dependem do nível de acesso do usuário:
- Com acesso total: Retorna todos os dados do cliente (nome, email, telefone, documento, etc.)
- Sem acesso: Retorna apenas o nome do cliente
null quando o usuário não tem acesso.
Ordenação
Você pode ordenar os resultados usando o parâmetroordering.
Campos suportados: paidAt, createdAt, amount, refId
Use o prefixo
- para ordenação decrescente.?ordering=-paidAt - Ordena por data de pagamento (mais recentes primeiro)Authorizations
Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.
Query Parameters
Número de resultados a serem retornados por página.
Número da página a ser retornada.
Was this page helpful?