Descrição

Retorna até 10 cupons cujo código contenha o termo informado. O parâmetro code deve ter no mínimo 2 caracteres.

Cabeçalhos

Parâmetros de Consulta (Query String)

Sucesso - 200

{
    "success": true,
    "message": "Coupons filtered successfully.",
    "data": [        
        {
            "coupon_id": "2",
            "code": "SOAR12",
            "discount": "12",
            "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": [1,5]
        },
        {
            "coupon_id": "1",
            "code": "SOAR123",
            "discount": "123",
            "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]
        }
    ]
}

Erro - 400 (Código inválido ou vazio)

{
  "status": 400,
  "error": 400,
  "messages": {
    "error": "Please provide at least 2 characters to search."
  }
}

Erro - 404 (Nenhum cupom encontrado)

{
    "status": 404,
    "error": 404,
    "messages": {
        "error": "No coupons found with the provided code."
    }
}

Códigos de Resposta

• 200 - Cupons encontrados com sucesso
• 400 - Código ausente ou inválido
• 404 - Nenhum cupom encontrado