v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Coupons

Create а coupon collection

post/couponCollections

Request body

namestring required

Name of the coupons collection

defaultCouponstring required

Default coupons collection name

expirationDatestring date-time

Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.

remainingDaysAlertinteger

Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.

remainingCouponsAlertinteger

Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.

Example request

{
  "name": "10%OFF",
  "defaultCoupon": "Winter",
  "expirationDate": "2022-01-02T00:00:00Z",
  "remainingDaysAlert": 5,
  "remainingCouponsAlert": 5
}

Response

Coupon collection created

idstring uuidv4 required

The id of the created collection

Example response

{
  "id": "23befbae-1505-47a8-bd27-e30ef739f32c"
}