Listar cupons
list_couponsRead-only
Lista os cupons cadastrados no bot (código, descrição, link, validade e os campos detalhados do desconto: discountType, discountValue, minPurchase, maxDiscount, isCashback e isSoldOut). Por padrão retorna só os vigentes (status="active"); use status="expired" para os vencidos (reativáveis com activate_coupon) ou status="all" para todos. Filtre com "q" (código/descrição/URL) e a loja com "site" (nome, slug ou domínio, sem precisar de ID) ou "site_id" (ID de list_coupon_categories). A resposta traz "total", "has_more" e "next_offset": com has_more true, repita a chamada com offset = next_offset.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Filtro por código, descrição ou URL (opcional). | |
| site | No | Opcional. Nome, slug ou domínio da loja (sem caixa), alternativa ao site_id. Ex.: "shopee". | |
| limit | No | Máximo de cupons (1 a 200; padrão 50). | |
| offset | No | Deslocamento para paginação (0 = início). Para a próxima página, use o next_offset da resposta. | |
| status | No | Filtro de status: "active" (padrão, só vigentes), "expired" (expirados por data — úteis para reativar com activate_coupon) ou "all" (todos). | active |
| site_id | No | Opcional. ID da loja (de list_coupon_categories). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | No | Cupons: id, code, description, url, validade e desconto. | |
| total | No | Quantos casaram com o filtro (todas as páginas). | |
| success | No | ||
| has_more | No | true quando há mais itens depois desta página. | |
| next_offset | No | offset da próxima página; null na última. |