---
title: "GET /public_api/orders/"
method: GET
path: "/public_api/orders/"
tags: ["orders"]
---

# GET /public_api/orders/

`GET /public_api/orders/`

Public API for managing orders, inherits from OrderRetrieveAPI and OrderListAPIView,
customizes the schema generation and authentication/permission settings.

## Query parameters

- `limit` integer
- `page` integer

## Response `200`

Corpo da resposta status 200

- PaginatedOrderSchemaList
  - `count` integer
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` OrderSchema[]
    - `id` string — Identificador único do pedido no sistema
    - `refId` string — Id curto de referência do pedido
    - `status` 'processing' | 'authorized' | 'paid' | 'refund_requested' | 'refunded' | 'waiting_payment' | 'refused' | 'blocked' | 'chargedback' | 'canceled' | 'in_protest' | 'partially_paid' | 'prechargeback' | 'scheduled' | 'retrying' | 'MED' — * `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
    - `type` 'unique' | 'subscription' — * `unique` - Pagamento único * `subscription` - Assinatura recorrente
    - `offer_type` 'main' | 'upsell' | 'downsell' | 'orderbump' — * `main` - Principal * `upsell` - Upsell * `downsell` - Downsell * `orderbump` - Order Bump
    - `baseAmount` string, decimal, required — Valor base do pedido antes de descontos e taxas
    - `discount` string, decimal, nullable — Valor do desconto aplicado no pedido
    - `amount` string, decimal, nullable — Valor total do pedido após descontos e taxas
    - `coupon` CouponPublic, required
      - `code` string, required — Código usado para obter o desconto
      - `discount` number, double, required — Desconto aplicado pelo cupom
      - `applyOnBumps` boolean — Define se o cupom pode ser aplicado em order bumps
      - `startTime` string, date-time, required — Data e hora em que o cupom começa a ser válido
      - `endTime` string, date-time, nullable — Data e hora em que o cupom deixa de ser válido. Se nulo, o cupom não expira.
    - `couponCode` string, nullable — Código do cupom de desconto aplicado no pedido
    - `reason` string, nullable — Motivo de recusa do pagamento
    - `refund_reason` string, nullable — Descrição do motivo do reembolso do pedido
    - `product` Product, required
      - `id` string — Identificador único do produto
      - `name` string, required — Nome do produto
      - `image` string, uri, nullable — Imagem do produto
      - `description` string, required — Descrição do produto
      - `price` number, double, required — Preço do produto
      - `type` 'unique' | 'subscription' — * `unique` - Pagamento único * `subscription` - Assinatura recorrente
      - `contentDeliveries` string[], required — Id dos métodos de entrega de conteúdo disponíveis
      - `emailAccessLink` string, uri, nullable — Link a ser enviado por e-mail para acesso ao conteúdo após a compra
      - `salesPage` string, uri, nullable — Link da página de vendas do produto
      - `status` 'active' | 'blocked' | 'deleted' — * `active` - Ativo * `blocked` - Bloqueado * `deleted` - Deletado
      - `paymentMethods` string[], required — Id dos métodos de pagamento disponíveis
      - `category` Category, required
        - `id` string
        - `name` string, required
    - `checkout` integer, nullable — Checkout onde a compra foi realizada
    - `subscription` string, nullable — Assinatura associada ao pedido
    - `subscription_period` integer, nullable — Período da assinatura que este pedido corresponde
    - `installments` integer — Número de parcelas que o valor foi dividido
    - `paymentMethod` string, required — Método de pagamento utilizado na compra
    - `createdAt` string, date-time, required — Data e hora de criação
    - `due_date` string, date-time, nullable — Data e hora em que o pagamento será processado
    - `paidAt` string, date-time, nullable — Data e hora em que o pedido foi pago
    - `releaseDate` string, date-time, nullable — Data e hora estimada de liberação das comissões
    - `refundedAt` string, date-time, nullable — Data e hora em que o pedido foi reembolsado
    - `chargedbackAt` string, date-time, nullable — Data e hora que o chargeback foi realizado
    - `canceledAt` string, date-time, nullable — Data e hora de cancelamento do pedido
    - `customer` union, required
      - CustomerOrder
        - `name` string, required — Nome completo do cliente
        - `email` string, email, required — Endereço de email do cliente
        - `birthDate` string, date, nullable — Data de nascimento do cliente
        - `phone` string, required — Número de telefone do cliente
        - `docType` 'cpf' | 'cnpj' — * `cpf` - CPF * `cnpj` - CNPJ
        - `docNumber` string, required — Número do documento do cliente
      - OrderCustomerMinimal
        - `name` string, required
    - `address` CustomerAddressFull, required
      - `id` integer, required
      - `customer` integer, required — Cliente proprietário do endereço
      - `country` string, required — Código do país no formato ISO 3166-1 Alpha-2 (ex: BR para Brasil)
      - `state` string, required — Código do estado no formato ISO 3166-2 Alpha-2 (ex: SP para São Paulo)
      - `city` string, required — Nome da cidade
      - `zipcode` string, required — Código Postal
      - `street` string, required — Nome da rua
      - `neighborhood` string, nullable — Nome do bairro
      - `complement` string, nullable — Complemento do endereço
      - `number` string, required — Número do endereço
      - `is_default` boolean — Define se este é o endereço principal do cliente
      - `createdAt` string, date-time, required — Data e hora de criação
      - `updatedAt` string, date-time, required — Data e hora da última atualização
    - `fees` string, decimal, nullable — Valor total das taxas aplicadas ao pedido
    - `commissionedUsers` UserReadOnly[], required — Usuários comissionados na compra
      - `id` integer, required
      - `email` string, email — Email. Obrigatório e único
    - `commissions` CommissionsSchema[], required — Detalhes das comissões associadas à compra
      - `userId` integer, required — ID do usuário comissionado
      - `type` 'affiliate' | 'coproducer' | 'producer', required — * `affiliate` - Afiliado * `coproducer` - Coprodutor * `producer` - Produtor
      - `commissionPercentage` number, double, required — Porcentagem de comissão
      - `commissionValue` number, double, required — Valor da comissão
    - `utm_source` string, nullable — Origem do tráfego (ex: google, instagram, newsletter)
    - `utm_medium` string, nullable — Meio do tráfego (ex: cpc, email, social)
    - `utm_campaign` string, nullable — Nome da campanha (ex: promocao_2023)
    - `utm_term` string, nullable — Termo da campanha (ex: sapato+vermelho)
    - `utm_content` string, nullable — Conteúdo da campanha (ex: banner_superior)
    - `sck` string, nullable — Parâmetro personalizado, geralmente usado internamente para rastrear algo específico (ex: ID de clique, sessão, ou código de origem próprio)
    - `checkoutUrl` string, nullable — URL do checkout onde o pedido foi realizado

## Other responses

- `401` — Request não autenticado devido à ausência ou invalidez do token.

---

[API](https://skmtc.dev/cakto/apis/cakto-api.md) · [All operations](https://skmtc.dev/cakto/apis/cakto-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cakto/cakto-api/revisions/cba77b0560b5/schema)