Skip to main content
POST
/
api
/
v1
/
coupons
Criar cupom
curl --request POST \
  --url https://upay-sistema-api.onrender.com/api/v1/coupons \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "code": "<string>",
  "discountType": "PERCENTAGE",
  "discountValue": 1,
  "description": "<string>",
  "minPurchaseCents": 1,
  "maxDiscountCents": 1,
  "usageLimit": 2,
  "perUserLimit": 2,
  "validFrom": "2023-11-07T05:31:56Z",
  "validUntil": "2023-11-07T05:31:56Z",
  "productIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "status": "ACTIVE"
}
'
{
  "message": "<string>",
  "coupon": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "code": "<string>",
    "discountType": "PERCENTAGE",
    "discountValue": 123,
    "description": "<string>",
    "minPurchaseCents": 123,
    "maxDiscountCents": 123,
    "usageLimit": 123,
    "perUserLimit": 123,
    "validFrom": "2023-11-07T05:31:56Z",
    "validUntil": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Body

application/json
​
code
string
required
Required string length: 3 - 50
​
discountType
enum<string>
required
Available options:
PERCENTAGE,
FIXED
​
discountValue
number
required
Required range: x >= 0
​
description
string
Maximum string length: 500
​
minPurchaseCents
integer
Required range: x >= 0
​
maxDiscountCents
integer
Required range: x >= 0
​
usageLimit
integer
Required range: x >= 1
​
perUserLimit
integer
Required range: x >= 1
​
validFrom
string<date-time>
​
validUntil
string<date-time>
​
productIds
string<uuid>[]
​
status
enum<string>
default:ACTIVE
Available options:
ACTIVE,
INACTIVE

Response

Cupom criado com sucesso

​
message
string
​
coupon
object