Marketing

get
Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200

Successfully retrieved vendor coupon list

get
GET /backend/api/vendor-coupon/vendor-coupon-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
200

Successfully retrieved vendor coupon list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got vendor Coupon list</message>
</object>

Update Coupon Status

put

Updates the status of one or more coupons.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
idinteger[]RequiredExample: [86]
statusintegerRequiredExample: 1
Responses
200

Coupon status updated successfully

put
PUT /backend/api/vendor-coupon/status-update HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22

"id=[86]&status=1"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Coupon Status Updated Successfully.</message>
</object>

Get Vendor Coupon Details

get

Retrieves detailed information for a specific vendor coupon.

Query parameters
vendorCouponIdintegerRequired

The ID of the vendor coupon to retrieve details for.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200

Successfully retrieved vendor coupon details.

get
GET /backend/api/vendor-coupon/vendor-coupon-detail HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got Vendor Coupon Detail.</message>
</object>

Get Vendor Product List

get
Query parameters
limitintegerOptional
offsetintegerOptional
countintegerOptional
keywordstringOptional
sortOrderstring · enumOptionalPossible values:
Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200

Successfully retrieved the product list

get
GET /backend/api/vendor-product HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got your product list.</message>
</object>

Update Vendor Coupon

put

Updates the details of an existing vendor coupon based on the coupon ID.

Path parameters
vendorCouponIdintegerRequired

The ID of the vendor coupon to update.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Body
couponNamestringRequired

The name of the coupon.

couponCodestringRequired

The coupon code.

statusinteger · int32Required

The status of the coupon (e.g., active/inactive).

couponTypeinteger · int32Required

The type of coupon.

discountstringRequired

The discount amount or percentage.

minimumPurchaseAmountinteger · int32Required

The minimum purchase amount for the coupon.

maximumPurchaseAmountinteger · int32Required

The maximum purchase amount for the coupon.

emailRestrictionsstringOptional

Restrictions for coupon usage by email.

applicableForstringOptional

Specifies who the coupon applies to.

allQualifyingItemsApplyinteger · int32Required

Whether all qualifying items apply for the coupon.

startDatestring · dateRequired

The start date for the coupon's validity.

endDatestring · dateRequired

The end date for the coupon's validity.

maxUserPerCouponinteger · int32Required

The maximum number of users who can use the coupon.

noOfTimeCouponValidPerUserinteger · int32Required

The maximum number of times the coupon can be used by each user.

appliedCartItemsCountinteger · int32Required

The number of items in the cart that are eligible for the coupon.

productType[0][type]integer · int32Required

The type of product the coupon applies to.

productType[0][referenceId][]integer[]Required

The reference IDs of products for which the coupon is valid.

Responses
200

Successfully updated the vendor coupon.

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

"couponName='text'&couponCode='text'&status=1&couponType=1&discount='text'&minimumPurchaseAmount=1&maximumPurchaseAmount=1&emailRestrictions='text'&applicableFor='text'&allQualifyingItemsApply=1&startDate='2025-08-29'&endDate='2025-08-29'&maxUserPerCoupon=1&noOfTimeCouponValidPerUser=1&appliedCartItemsCount=1&productType[0][type]=1&productType[0][referenceId][]=[1]"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Coupon Updated Successfully.</message>
</object>

Delete Vendor Coupon

delete

Deletes a vendor coupon based on the coupon ID.

Path parameters
vendorCouponIdintegerRequired

The ID of the vendor coupon to delete.

Header parameters
AuthorizationstringRequired

Bearer token for vendor authentication

Responses
200

Successfully deleted the vendor coupon.

delete
DELETE /backend/api/vendor-coupon/delete-vendor-coupon/{vendorCouponId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted the Vendor Coupon.</message>
</object>

Last updated