Listar Todos os Cupons
Descrição
Retorna todos os cupons cadastrados no sistema, ordenados pela data de criação. Este endpoint pode ser utilizado para exibição ou administração de campanhas promocionais.
Verbo
GET
URL Base
https://api.soargi.com
Endpoint
/coupons
Cabeçalhos
Parâmetro | Valor |
---|---|
Authorization | Bearer Token |
Sucesso - 200
{
"success": true,
"data": [
{
"coupon_id": "3",
"code": "SOAR20",
"discount": "20",
"status": "active",
"start_date": "2024-11-15",
"end_date": "2025-11-15",
"start_time": "07:30:00",
"end_time": "19:30:00",
"timezone": "GMT+00:00",
"usages": "5",
"enable_users": "0",
"created_at": "2025-05-08 16:18:47",
"updated_at": "2025-05-08 16:18:47",
"list_users": [4,7,8]
},
{
"coupon_id": "2",
"code": "SOAR15",
"discount": "15",
"status": "expired",
"start_date": "2023-01-01",
"end_date": "2024-01-01",
"start_time": "09:00:00",
"end_time": "20:00:00",
"timezone": "GMT-05:00",
"usages": "10",
"enable_users": "1",
"created_at": "2025-05-08 16:18:37",
"updated_at": "2025-05-08 16:18:37",
"list_users": [2,7]
},
{
"coupon_id": "1",
"code": "SOAR10",
"discount": "10",
"status": "active",
"start_date": "2024-10-01",
"end_date": "2025-10-01",
"start_time": "08:00:00",
"end_time": "18:00:00",
"timezone": "GMT-03:00",
"usages": "0",
"enable_users": "0",
"created_at": "2025-05-08 16:18:24",
"updated_at": "2025-05-08 16:18:24",
"list_users": [4,7,8,9,15]
}
]
}
Erro - 404 (Nenhum cupom encontrado)
{
"success": false,
"message": "No coupons found."
}
Códigos de Resposta
- 200 - Lista de cupons retornada com sucesso
- 404 - Nenhum cupom encontrado