DocumentAPI ReferenceAdd-ons

Manage Marketing

add coupon

post

Add a coupon.

Header parameters
AuthorizationstringRequired
Body
couponNamestringOptional
couponCodestringOptional
couponTypeinteger · int32Optional
discountinteger · int32Optional
minimumPurchaseAmountinteger · int32Optional
maximumPurchaseAmountinteger · int32Optional
couponConjunctioninteger · int32Optional
couponAppliesSalesinteger · int32Optional
emailRestrictionsstringOptional
applicableForinteger · int32Optional
freeShippinginteger · int32Optional
startDatestringOptional
endDatestringOptional
maxUserPerCouponinteger · int32Optional
noOfTimeCouponValidPerUserinteger · int32Optional
allQualifyingItemsApplyinteger · int32Optional
appliedCartItemsCountinteger · int32Optional
statusinteger · int32Optional
Responses
200

success response

application/json
post
/admin-coupon/add-coupon
POST /admin-coupon/add-coupon HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 426

"couponName='text'&couponCode='text'&couponType=1&discount=1&minimumPurchaseAmount=1&maximumPurchaseAmount=1&couponConjunction=1&couponAppliesSales=1&emailRestrictions='text'&applicableFor=1&freeShipping=1&startDate='text'&endDate='text'&maxUserPerCoupon=1&noOfTimeCouponValidPerUser=1&allQualifyingItemsApply=1&appliedCartItemsCount=1&productType=[{'type':1,'referenceId':[1]}]&status=1"
{
  "createdDate": "2025-10-24T07:39:33.313Z",
  "vendorCouponId": 1,
  "vendorId": 1,
  "couponName": "text",
  "couponCode": "text",
  "couponType": 1,
  "discount": "text",
  "startDate": "2025-10-24T07:39:33.313Z",
  "endDate": "2025-10-24T07:39:33.313Z",
  "isActive": 1,
  "orders": 1,
  "leftDays": 1
}

admin coupon list

get

Get list of coupon.

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
statusstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
get
/admin-coupon/admin-coupon-list
GET /admin-coupon/admin-coupon-list?limit=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got vendor Coupon list"
}

coupon usage list

get

Get the list of coupon usage.

Query parameters
limitintegerRequired
offsetintegerOptional
couponIdintegerRequired
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
get
/admin-coupon/coupon-usage-list
GET /admin-coupon/coupon-usage-list?limit=1&couponId=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got Coupon Usage count \" or \" Successfully got coupon Usage list"
}

coupon detail

get

Geat detail of a coupon.

Query parameters
vendorCouponIdintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
get
/admin-coupon/coupon-detail
GET /admin-coupon/coupon-detail HTTP/1.1
Host: 
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "successfully got Vendor Coupon Detail."
}

update coupon

put

Update a coupon.

Path parameters
vendorCouponIdintegerRequired
Header parameters
AuthorizationstringRequired
Body
couponNamestringOptional
couponCodestringOptional
couponTypeinteger · int32Optional
discountinteger · int32Optional
minimumPurchaseAmountinteger · int32Optional
maximumPurchaseAmountinteger · int32Optional
couponConjunctioninteger · int32Optional
couponAppliesSalesinteger · int32Optional
emailRestrictionsstringOptional
applicableForinteger · int32Optional
freeShippinginteger · int32Optional
startDatestringOptional
endDatestringOptional
maxUserPerCouponinteger · int32Optional
noOfTimeCouponValidPerUserinteger · int32Optional
allQualifyingItemsApplyinteger · int32Optional
appliedCartItemsCountinteger · int32Optional
statusinteger · int32Optional
Responses
200

success response

application/json
put
/admin-coupon/update-coupon/{vendorCouponId}
PUT /admin-coupon/update-coupon/{vendorCouponId} HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 426

"couponName='text'&couponCode='text'&couponType=1&discount=1&minimumPurchaseAmount=1&maximumPurchaseAmount=1&couponConjunction=1&couponAppliesSales=1&emailRestrictions='text'&applicableFor=1&freeShipping=1&startDate='text'&endDate='text'&maxUserPerCoupon=1&noOfTimeCouponValidPerUser=1&allQualifyingItemsApply=1&appliedCartItemsCount=1&productType=[{'type':1,'referenceId':[1]}]&status=1"
{
  "status": 1,
  "message": "Coupon Updated Successfully."
}

delete coupon

delete

Delete a Coupon.

Path parameters
vendorCouponIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
delete
/admin-coupon/delete-coupon/{vendorCouponId}
DELETE /admin-coupon/delete-coupon/{vendorCouponId} HTTP/1.1
Host: 
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted Coupon"
}

delete bulk coupon

post

Delete the bulk of coupon.

Header parameters
AuthorizationstringRequired
Body
vendorCouponIdstringRequired
Responses
200

success response

application/json
post
/admin-coupon/delete-bulk-coupon
POST /admin-coupon/delete-bulk-coupon HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 25

"vendorCouponId='text'"
{
  "status": 1,
  "message": "Successfully deleted Coupon"
}

bulk export admin coupon list

get

Bulk export of coupon list.

Query parameters
limitintegerRequired
offsetintegerOptional
keywordstringOptional
statusstringOptional
countintegerOptional
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
get
/admin-coupon/bulk-export-admin-coupon-list
GET /admin-coupon/bulk-export-admin-coupon-list?limit=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Vendor Coupon List Successfully"
}

Last updated