cURL
Ofertas
Listar Ofertas
Lista ofertas dos seus produtos com suporte a filtros, busca e paginação
GET
cURL
Escopo
Filtros Disponíveis
Filtros por Identificação
Filtros por Identificação
id- Id da oferta (múltiplos valores separados por vírgula)name- Nome da oferta (busca parcial, case-insensitive)
?id=OFF123,OFF456&name=meu-produto - Filtra ofertas com Id OFF123 ou OFF456 e nome contendo “meu-produto”Filtros por Valor
Filtros por Valor
price- Valor da oferta
?price__gte=5000 - Filtra ofertas com valor maior ou igual a R$ 50,00Filtros por Datas
Filtros por Datas
createdAt- Data de criaçãoupdatedAt- Data de última atualização
Formato de data:
YYYY-MM-DD ou ISO 8601 YYYY-MM-DDTHH:MM:SS±hh:mm?createdAt__gte=2024-01-01&createdAt__lt=2024-02-01T23:59:59Z - Filtra produtos criados em janeiro de 2024Filtros por Status
Filtros por Status
status- Status da oferta (active, disabled)
?status=active&type=subscription - Filtra ofertas ativas de assinaturaFiltros por Tipo
Filtros por Tipo
type- Tipo da oferta (unique, subscription)
?type=subscription - Filtra ofertas de assinaturaFiltros para Ofertas de Pagamento Único
Filtros para Ofertas de Pagamento Único
intervalType- Tipo de intervalo da oferta (day, week, month, year) (múltiplos valores suportados)interval- Quantidade de intervalos (número inteiro)
?intervalType=month&interval=6 - Filtra ofertas com intervalo de 6 mesesFiltros para Ofertas de Pagamento Recorrente
Filtros para Ofertas de Pagamento Recorrente
recurrence_period- Período de recorrência em dias (número inteiro)quantity_recurrences- Quantidade de recorrências (número inteiro)trial_days- Quantidade de dias de período de teste (número inteiro)max_retries- Quantidade máxima de tentativas de cobrança (número inteiro)retry_interval- Quantidade de dias entre tentativas de cobrança (número inteiro)
?recurrence_period=30&quantity_recurrences=12 - Filtra ofertas com renovação mensal e duração de 1 anoFiltros por Relacionamentos
Filtros por Relacionamentos
product- Id do produto ao qual a oferta pertence
?product=AB123,BC456 - Filtra ofertas dos produtos com Id AB123 e BC456Outros Filtros
Outros Filtros
default- Se é a oferta padrão do produto (true/false)
?default=true - Filtra apenas ofertas padrão dos produtosBusca
O endpoint suporta busca textual pelo parâmetrosearch nos seguintes campos:
name- Nome da ofertaid- Id da ofertaproduct.name- Nome do produto associado à ofertaproduct.short_id- Id curto do produto associado à ofertaproduct.id- Id completo do produto associado à oferta
?search=meu-produto - Busca pelo texto “meu-produto” nos campos de busca.
Qualquer oferta onde um dos campos contenha o texto será retornada, (“meu-produto 2.0” e “Oferta B meu-produto” seriam retornadas).
Ordenação
Você pode ordenar os resultados usando o parâmetroordering:
Campos suportados: id, name, price, product, status, default, createdAt, updatedAt
Exemplo: ?ordering=-createdAt - Ordena por data de criação (mais recentes primeiro)Authorizations
Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.
Query Parameters
Número de resultados a serem retornados por página.
Número da página a ser retornada.
