Skip to main content
Endpoint:

Authorization

string
required
Example:Authorization | Bearer Paste-Your-API-Key-Here

Request Body

string | datetime
required
Discount coupon expiration date.
string
required
Discount name.
array of object
required
Details of discount conditions.

discount Structure (Array Of Object)

string
required
Discount type;
  • monetary
  • percentage
string
required
Target customers who can use discount coupons.
  • all
number | integer
required
Minimum purchase to be able to use the discount.
number | integer
required
Discount amount
number | integer
required
Available coupon quota.
array of object
Coupon code details.

coupon Structure (Array Of Object)

string
required
Discount coupon code.
string
required
Coupon type;
  • reusable
  • onetime
Array
List of eligible products.

Response

Successful Response

Main Structure (Root)

integer
Status code form API.
string
Status message that describes the status code.
array of object
The main data returned (request payment details).

data Structure (Array Of Object)

string<uuid>
Discount ID.
integer
Creation time (timestamp in ms).
integer
Expiration time (timestamp in ms).
string
Discount type.
string
Discount product scope.
string
Eligible customer scope.
string
Discount name.
integer
Minimum purchase amount to apply discount.
boolean | null
Indicates if discount is lifetime (true/false) or null.
integer
Total number of coupons available.
number
Discount value.
array of object
List of coupons associated with this discount.
array of objext
Product-specific discount rules (empty if not applied).

coupons Structure (Array Of Object)

string
Coupon code.
string
Coupon type.
string (ISO 8601 datetime)
Coupon expiration date.
boolean
Whether the coupon is active (true or false).