Manage marketing

Add vendor coupon

post

Add a vendor coupon

Header parameters

AuthorizationstringRequired

Body

couponNamestringRequired

couponCodestringRequired

couponTypeinteger · int32Required

discountinteger · int32Required

minimumPurchaseAmountinteger · int32Required

maximumPurchaseAmountinteger · int32Required

couponConjunctioninteger · int32Optional

couponAppliesSalesinteger · int32Optional

emailRestrictionsstringOptional

applicableForinteger · int32Optional

freeShippinginteger · int32Optional

startDatestringOptional

endDatestringOptional

maxUserPerCouponinteger · int32Required

noOfTimeCouponValidPerUserinteger · int32Required

allQualifyingItemsApplyinteger · int32Optional

appliedCartItemsCountinteger · int32Optional

productTypeinteger[]Optional

statusinteger · int32Required

Responses

200

success response

application/json

400

error response

application/json

post

HTTPcURLJavaScriptPython

POST /vendor-coupon/add-coupon HTTP/1.1
Host: 
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 399

"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=[1]&status=1"

{
  "status": 1,
  "message": "Coupon Saved successfully."
}

Vendor coupon list

get

Get list of vendor coupon

Query parameters

limitintegerOptional

offsetintegerOptional

keywordstringOptional

statusstringOptional

countintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

get

HTTPcURLJavaScriptPython

GET /vendor-coupon/vendor-coupon-list HTTP/1.1
Host: 
Authorization: text
Accept: */*

200

success response

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

Vendor usage coupon list

get

Get list of coupon usage list.

Query parameters

limitintegerOptional

offsetintegerOptional

couponIdintegerOptional

countintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

get

HTTPcURLJavaScriptPython

GET /vendor-coupon/coupon-usage-list HTTP/1.1
Host: 
Authorization: text
Accept: */*

200

success response

{
  "status": 1,
  "message": "Successfully got Coupon Usage count"
}

Vendor coupon detail

get

Get detail of vendor coupon

Query parameters

vendorCouponIdintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

400

error response

*/*

get

HTTPcURLJavaScriptPython

GET /vendor-coupon/vendor-coupon-detail?vendorCouponId=1 HTTP/1.1
Host: 
Authorization: text
Accept: */*

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

Update vendor coupon

put

Update a vendor coupon

Path parameters

vendorCouponIdintegerRequired

Header parameters

AuthorizationstringRequired

Body

couponNamestringRequired

couponCodestringRequired

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

productTypeinteger[]Optional

statusinteger · int32Required

Responses

200

success response

application/json

400

error response

application/json

put

HTTPcURLJavaScriptPython

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

"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=[1]&status=1"

{
  "status": 1,
  "message": "Coupon Updated Successfully."
}

Delete vendor coupon

delete

Delete a vendor coupon

Path parameters

vendorCouponIdintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

400

error response

*/*

delete

HTTPcURLJavaScriptPython

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

{
  "status": 1,
  "message": "Successfully deleted the Vendor Coupon."
}