Skip to main content
GET
cURL

Escopo

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 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 (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)

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[]