Skip to navigation
EcommerceCoupons

Create а coupon collection

View as Markdown

Create a new coupon collection with a name and a default coupon value. You can optionally set an expiration date in RFC3339 format and configure alert thresholds to receive email notifications when remaining coupons or remaining days before expiration fall below a specified number. The collection ID is auto-generated as a UUID and returned in the response.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Request

Values to create a coupon collection
defaultCouponstringRequired
Default coupons collection name
namestringRequired
Name of the coupons collection
expirationDatedatetimeOptional
Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.
remainingCouponsAlertintegerOptional

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

remainingDaysAlertintegerOptional

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.

Response

Coupon collection created
idstringformat: "uuidv4"
The id of the created collection

Errors

400
Bad Request Error
401
Unauthorized Error