> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cakto.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Listar Produtos
> Lista produtos da sua conta com suporte a filtros, busca e paginação
#### Escopo
```bash theme={null}
read products
```
## Filtros Disponíveis
Filtros podem ser combinados para refinar ainda mais os resultados.
Exemplo: `?status=active&type=subscription&price__gte=99` - Filtra produtos ativos de assinatura com preço maior ou igual a R\$ 99,00
* `id` - Id do produto (múltiplos valores separados por vírgula)
* `name` - Nome do produto (busca parcial)
**Exemplo:** `?name=curso` - Filtra produtos que contenham "curso" no nome
* `price` - Preço do produto
Suporte a operadores de comparação (`__gt`, `__gte`, `__lt`, `__lte`)
**Exemplo:** `?price__gte=99&price__lte=299` - Filtra produtos com preço entre R\$ 99,00 e R\$ 299,00
* `createdAt` - Data de criação
* `updatedAt` - Data de última atualização
Suporte a operadores de comparação (`__gt`, `__gte`, `__lt`, `__lte`)
Formato de data: `YYYY-MM-DD` ou [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) `YYYY-MM-DDTHH:MM:SS±hh:mm`
**Exemplo:** `?createdAt__gte=2024-01-01&createdAt__lt=2024-02-01T23:59:59Z` - Filtra produtos criados em janeiro de 2024
* `status` - Status do produto (active, blocked, deleted)
Suporte a múltiplos valores separados por vírgula.
**Exemplo:** `?status=active,blocked` - Filtra produtos ativos ou bloqueados
* `type` - Tipo do produto (unique, subscription)
Suporte a múltiplos valores separados por vírgula.
**Exemplo:** `?type=subscription` - Filtra apenas produtos de assinatura
* `threeDsRetryEnabled` - Habilita/desabilita retentativas de pagamento 3DS (true/false)
* `displayedInShowcase` - Produto exibido na [vitrine de afiliados](https://app.cakto.com.br/dashboard/showcase) (true/false)
**Exemplo:** `?threeDsRetryEnabled=true` - Filtra produtos com retentativas 3DS habilitadas
## Busca
O endpoint suporta busca textual pelo parâmetro `search` nos seguintes campos:
* `name` - Nome do produto
* `id` - Id completo do produto
* `short_id` - Id curto do produto
**Exemplo:** `?search=meu-produto` - Busca pelo texto "meu-produto" nos campos de busca.
Qualquer produto onde um dos campos contenha o texto será retornado, ("meu-produto 2.0" e "Oferta B meu-produto" seriam retornados).
## Ordenação
Você pode ordenar os resultados usando o parâmetro `ordering`.
Campos suportados: `name`, `price`, `type`, `status`, `createdAt`, `updatedAt`
Use o prefixo `-` para ordenação decrescente.
**Exemplo:** `?ordering=-createdAt` - Ordena por data de criação (mais recentes primeiro)
## OpenAPI
````yaml GET /public_api/products/
openapi: 3.0.3
info:
title: Cakto API
version: 1.0.0
description: Documentação da API pública do Cakto.
servers:
- url: https://api.cakto.com.br
description: Cakto API
security: []
paths:
/public_api/products/:
get:
tags:
- products
description: >-
Public API for managing products, inherits from ProductRetrieveAPI and
ProductAPI,
customizes the schema generation and authentication/permission settings.
operationId: products_list
parameters:
- name: limit
required: false
in: query
description: Número de resultados a serem retornados por página.
schema:
type: integer
- name: page
required: false
in: query
description: Número da página a ser retornada.
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedProductList'
examples:
Successo:
value:
count: 123
next: http://api.example.org/accounts/?page=4
previous: http://api.example.org/accounts/?page=2
results:
- id: cd287b31-d4b7-4e94-858a-66e05ce2f4a2
name: Product Name Example
image: https://example-image-url.com/image.png
description: Description example
price: 15
type: unique
contentDeliveries:
- cakto
- telegram
- discord
emailAccessLink: null
salesPage: https://example-sales-page.com.br/product-page
status: active
paymentMethods:
- applepay
- boleto
- credit_card
- googlepay
- pix
category:
id: 0673d296-1802-45e0-bc93-112f7514dddb
name: Animais e Plantas
description: Corpo da resposta status 200
'401':
description: Request não autenticado devido à ausência ou invalidez do token.
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedError'
examples:
Token ausente ou inválido:
$ref: '#/components/examples/UnauthenticatedErrorExample'
security:
- OAuth Token: []
components:
schemas:
PaginatedProductList:
type: object
properties:
count:
type: integer
example: 123
next:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
nullable: true
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Product'
UnauthenticatedError:
type: object
properties:
detail:
type: string
Product:
type: object
properties:
id:
type: string
description: Identificador único do produto
maxLength: 255
name:
type: string
title: Nome
description: Nome do produto
maxLength: 255
image:
type: string
format: uri
readOnly: true
nullable: true
title: Imagem
description: Imagem do produto
description:
type: string
title: Descrição
description: Descrição do produto
price:
type: number
format: double
description: Preço do produto
currency:
allOf:
- $ref: '#/components/schemas/CurrencyEnum'
title: Moeda
description: |-
Moeda do produto
* `BRL` - Real
* `EUR` - Euro
* `MXN` - Peso Mexicano
* `PEN` - Sol Peruano
* `USD` - Dólar
* `CLP` - Peso Chileno
* `COP` - Peso Colombiano
* `ARS` - Peso Argentino
* `BOB` - Boliviano
* `UYU` - Peso Uruguayo
type:
allOf:
- $ref: '#/components/schemas/ProductType'
title: Tipo
description: |-
Tipo de venda do produto, ex.: venda única, assinatura...
* `unique` - Pagamento único
* `subscription` - Assinatura recorrente
contentDeliveries:
type: array
items:
type: string
readOnly: true
description: Id dos métodos de entrega de conteúdo disponíveis
emailAccessLink:
type: string
format: uri
nullable: true
title: Link de acesso
description: Link a ser enviado por e-mail para acesso ao conteúdo após a compra
maxLength: 2048
salesPage:
type: string
format: uri
nullable: true
title: Página de vendas
description: Link da página de vendas do produto
maxLength: 2048
status:
allOf:
- $ref: '#/components/schemas/ProductStatus'
description: |-
Status atual do produto
* `active` - Ativo
* `waiting_config` - Aguardando Configuração
* `blocked` - Bloqueado
* `deleted` - Deletado
paymentMethods:
type: array
items:
type: string
readOnly: true
description: Id dos métodos de pagamento disponíveis
category:
allOf:
- $ref: '#/components/schemas/Category'
readOnly: true
description: Categoria do produto
required:
- category
- contentDeliveries
- description
- image
- name
- paymentMethods
- price
CurrencyEnum:
enum:
- BRL
- EUR
- MXN
- PEN
- USD
- CLP
- COP
- ARS
- BOB
- UYU
type: string
description: |-
* `BRL` - Real
* `EUR` - Euro
* `MXN` - Peso Mexicano
* `PEN` - Sol Peruano
* `USD` - Dólar
* `CLP` - Peso Chileno
* `COP` - Peso Colombiano
* `ARS` - Peso Argentino
* `BOB` - Boliviano
* `UYU` - Peso Uruguayo
ProductType:
enum:
- unique
- subscription
type: string
description: |-
* `unique` - Pagamento único
* `subscription` - Assinatura recorrente
ProductStatus:
enum:
- active
- waiting_config
- blocked
- deleted
type: string
description: |-
* `active` - Ativo
* `waiting_config` - Aguardando Configuração
* `blocked` - Bloqueado
* `deleted` - Deletado
Category:
type: object
properties:
id:
type: string
maxLength: 255
name:
type: string
maxLength: 255
required:
- name
examples:
UnauthenticatedErrorExample:
summary: Token ausente ou inválido
description: Token ausente ou inválido
value:
detail: As credenciais de autenticação não foram fornecidas.
securitySchemes:
OAuth Token:
type: http
scheme: bearer
in: header
name: Authorization
description: >-
Token de autenticação do tipo `Bearer {access_token}`, onde
`{access_token}` é o token obtido no fluxo de
[autenticação](/authentication).
````