Criar Novo Cupom

Descrição

Cria um novo cupom no sistema com código, desconto, validade, uso e status.

Verbo

POST

URL Base

https://api.soargi.com

Endpoint

/coupons

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 (em porcentagem ou valor fixo).
status string Não Status atual do cupom (ex: active, expired, canceled). O status pode ser omitido, pois o valor padrão será '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). O timezone pode ser omitido se desejar.

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 - 201

{
    "success": true,
    "message": "Coupon created successfully.",
    "data": {
        "coupon_id": "26",
        "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": "0",
        "created_at": "2025-05-13 19:00:31",
        "updated_at": "2025-05-13 19:00:31",
        "list_users": []
    }
}

Erro - 400 (Campos obrigatórios/Vazios)

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

Erro - 401 (Token Inválido)

{
    "success": false,
    "code": 401,
    "message": "Invalid token: incorrect issuer or audience"
}

Erro - 500 (Falha ao salvar cupom)

{
    "status": 500,
    "error": 500,
    "messages": {
        "error": "Failed to create coupon."
    }
}

Códigos de Resposta

  • 201 - Cupom criado com sucesso
  • 400 - Dados inválidos ou campos obrigatórios ausentes
  • 401 - Token Inválido
  • 500 - Falha ao salvar cupom