Skip to main content
GET
/
public_api
/
orders
cURL
curl --request GET \
  --url https://api.cakto.com.br/public_api/orders/ \
  --header 'Authorization: Bearer <token>'
{
  "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": "[email protected]",
        "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": "[email protected]"
        },
        {
          "id": 2,
          "email": "[email protected]"
        }
      ],
      "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"
    }
  ]
}

​
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.
  • 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)
Exemplo: ?refId=ORDER123 - Filtra pedidos com Id de referência “ORDER123”
  • amount - Valor total do pedido
  • baseAmount - 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)
Exemplo: ?amount__gte=1040 - Filtra pedidos com valor maior ou igual a R$ 10,40
  • createdAt - Data de criação do pedido
  • updatedAt - Data de atualização do pedido
  • paidAt - Data de confirmação do pagamento
  • refundedAt - Data do reembolso
  • chargedbackAt - Data do chargeback
  • canceledAt - 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
Exemplo: ?paidAt__gte=2024-01-01&paidAt__lt=2024-02-01 - Filtra pedidos pagos em janeiro de 2024
Suporte a múltiplos valores separados por vírgula.
Exemplo: ?status=paid,refunded - Filtra pedidos pagos ou reembolsados
  • offer_type - Tipo da oferta (main, upsell, downsell, orderbump)
  • type - Tipo do produto (unique, subscription)
Suporte a múltiplos valores separados por vírgula.
Exemplo: ?offer_type=main,upsell&type=subscription - Filtra pedidos de ofertas principais e upsell de produtos recorrentes
  • customer - Id, nome, email ou documento do cliente
  • affiliate - Id ou email do afiliado
  • product - Id ou nome do produto
  • products - Id dos produtos (múltiplos valores suportados)
  • offer - Id da oferta (múltiplos valores suportados)
  • checkout - Id do checkout (múltiplos valores suportados)
Exemplo: ?product=123&affiliate=456 - Filtra pedidos de um produto específico vendidos por um afiliado
  • 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 utilizado
  • utm_source - Fonte da campanha
  • utm_medium - Meio da campanha
  • utm_campaign - Nome da campanha
  • utm_term - Termo da campanha
  • utm_content - Conteúdo da campanha
  • checkoutURL - 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)
Exemplo: ?paymentMethod=credit_card&installments=12 - Filtra pedidos pagos em 12x no cartão de crédito

​
Dados do Cliente e Endereço

Importante: Os dados do cliente retornados dependem do nível de acesso do usuário:
O nível de acesso é determinado pelas configurações do produto vendido que pode ou não compartilhar as informações de contato do cliente com afiliados e coprodutores.
  • Com acesso total: Retorna todos os dados do cliente (nome, email, telefone, documento, etc.)
  • Sem acesso: Retorna apenas o nome do cliente
O mesmo se aplica aos dados de endereço do pedido, retornando null quando o usuário não tem acesso.

​
Ordenação

Você pode ordenar os resultados usando o parâmetro ordering. Campos suportados: paidAt, createdAt, amount, refId
Use o prefixo - para ordenação decrescente.
Exemplo: ?ordering=-paidAt - Ordena por data de pagamento (mais recentes primeiro)

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.

Query Parameters

​
limit
integer

Número de resultados a serem retornados por página.

​
page
integer

Número da página a ser retornada.

Response

Corpo da resposta status 200

​
count
integer
Example:

123

​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

​
results
object[]