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

​
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.

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.

Path Parameters

​
id
string<uuid>
required

Id do Pedido

Response

Corpo da resposta status 200

​
baseAmount
string<decimal>
required

Valor base do pedido antes de descontos e taxas

​
coupon
object
required

Cupom aplicado na compra

​
product
object
required

Produto adquirido na compra

​
paymentMethod
string
required

Método de pagamento utilizado na compra

​
createdAt
string<date-time>
required

Data e hora de criação

​
customer
object
required

Cliente que realizou a compra

​
address
object
required

Endereço do cliente

​
commissionedUsers
object[]
required

Usuários comissionados na compra

​
commissions
object[]
required

Detalhes das comissões associadas à compra

​
id
string

Identificador único do pedido no sistema

Maximum string length: 255
​
refId
string

Id curto de referência do pedido

Maximum string length: 255
​
status
enum<string>

Status atual do pedido

  • processing - Processando
  • authorized - Autorizado
  • paid - Pago
  • refund_requested - Reembolso solicitado
  • refunded - Reembolsado
  • waiting_payment - Aguardando pagamento
  • refused - Recusado
  • blocked - Recusado
  • chargedback - Chargeback
  • canceled - Cancelado
  • in_protest - Em protesto
  • partially_paid - Parcialmente pago
  • prechargeback - Prechargeback
  • scheduled - Scheduled
  • retrying - Retrying
  • MED - Med
Available options:
processing,
authorized,
paid,
refund_requested,
refunded,
waiting_payment,
refused,
blocked,
chargedback,
canceled,
in_protest,
partially_paid,
prechargeback,
scheduled,
retrying,
MED
​
type
enum<string>

Tipo do produto comprado no pedido

  • unique - Pagamento único
  • subscription - Assinatura recorrente
Available options:
unique,
subscription
​
offer_type
enum<string>

Tipo da oferta comprada no pedido

  • main - Principal
  • upsell - Upsell
  • downsell - Downsell
  • orderbump - Order Bump
Available options:
main,
upsell,
downsell,
orderbump
​
discount
string<decimal> | null

Valor do desconto aplicado no pedido

​
amount
string<decimal> | null

Valor total do pedido após descontos e taxas

​
couponCode
string | null

Código do cupom de desconto aplicado no pedido

Maximum string length: 255
​
reason
string | null

Motivo de recusa do pagamento

Maximum string length: 255
​
refund_reason
string | null

Descrição do motivo do reembolso do pedido

​
checkout
integer | null

Checkout onde a compra foi realizada

​
subscription
string | null

Assinatura associada ao pedido

​
subscription_period
integer | null

Período da assinatura que este pedido corresponde

​
installments
integer

Número de parcelas que o valor foi dividido

​
due_date
string<date-time> | null

Data e hora em que o pagamento será processado

​
paidAt
string<date-time> | null

Data e hora em que o pedido foi pago

​
releaseDate
string<date-time> | null

Data e hora estimada de liberação das comissões

​
refundedAt
string<date-time> | null

Data e hora em que o pedido foi reembolsado

​
chargedbackAt
string<date-time> | null

Data e hora que o chargeback foi realizado

​
canceledAt
string<date-time> | null

Data e hora de cancelamento do pedido

​
fees
string<decimal> | null

Valor total das taxas aplicadas ao pedido

​
utm_source
string | null

Origem do tráfego (ex: google, instagram, newsletter)

Maximum string length: 255
​
utm_medium
string | null

Meio do tráfego (ex: cpc, email, social)

Maximum string length: 255
​
utm_campaign
string | null

Nome da campanha (ex: promocao_2023)

Maximum string length: 255
​
utm_term
string | null

Termo da campanha (ex: sapato+vermelho)

Maximum string length: 255
​
utm_content
string | null

Conteúdo da campanha (ex: banner_superior)

Maximum string length: 255
​
sck
string | null

Parâmetro personalizado, geralmente usado internamente para rastrear algo específico (ex: ID de clique, sessão, ou código de origem próprio)

Maximum string length: 255
​
checkoutUrl
string | null

URL do checkout onde o pedido foi realizado