Editar Cupom

Descrição

Atualiza os dados de um cupom existente com base no ID informado. Permite modificar qualquer campo editável.

Verbo

PUT

URL Base

https://api.soargi.com

Endpoint

/coupons/{id}

Cabeçalhos

Parâmetro Valor
Content-Type application/json
Authorization Bearer Token

Campos Esperados

Campo Tipo Obrigatório Descrição
code string Sim Código único do cupom (ex: SOAR12).
discount integer Sim Valor do desconto (valor fixo e inteiro).
status string Não Status atual do cupom (ex: active, expired, canceled). Default: active
start_date date Sim Data de início de validade.
end_date date Sim Data de expiração do cupom.
start_time time Sim Hora inicial (formato HH:mm:ss).
end_time time Sim Hora final (formato HH:mm:ss).
timezone string Não Fuso horário do cupom (ex: GMT+03:00).

Corpo da Requisição

{
    "code": "SOAR12",
    "discount": 12,
    "status": "active",
    "start_date": "2024-12-01",
    "end_date": "2025-12-01",
    "start_time": "06:00:00",
    "end_time": "23:00:00",
    "timezone": "GMT+03:00"
}

Sucesso - 200

{
    "success": true,
    "message": "Coupon updated successfully.",
    "data": {
        "coupon_id": "5",
        "code": "SOAR12",
        "discount": "12",
        "status": "active",
        "start_date": "2024-12-01",
        "end_date": "2025-12-01",
        "start_time": "06:00:00",
        "end_time": "23:00:00",
        "timezone": "GMT+03:00",
        "usages": "3",
        "created_at": "2025-05-08 16:19:15",
        "updated_at": "2025-05-08 19:34:08",
        "list_users": [7, 8, 12]
    }
}

Erro - 400 (Dados inválidos ou campos obrigatórios ausentes)

{
  "status": 400,
  "error": 400,
  "messages": {
    "code": "The code field is required."
  }
}

Erro - 404 (Cupom não encontrado)

{
  "status": 404,
  "error": "Coupon not found."
}

Códigos de Resposta

  • 200 - Cupom atualizado com sucesso
  • 400 - Dados inválidos ou campos obrigatórios ausentes
  • 404 - Cupom não encontrado