Coupon | API Reference | Spurtcommerce

Get vendor coupon list

get

/admin-coupon/admin-coupon-list

Retrieves a list of vendor coupons based on the provided filters.

Query parameters

limitintegerOptional

The maximum number of coupons to return.

Default: 10

offsetintegerOptional

The number of coupons to skip before starting to collect the result set.

Default: 0

countintegerOptional

A flag to indicate whether to return the count of coupons.

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the vendor coupon list.

400

Bad request due to invalid parameters.

500

Internal server error.

get

/admin-coupon/admin-coupon-list

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

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

Get complete product list

get

/product

Retrieves the complete list of products based on the provided filters.

Query parameters

offsetintegerOptional

The number of products to skip before starting to collect the result set.

Default: 0

limitintegerOptional

The maximum number of products to return.

Default: 0

keywordstringOptional

Search keyword for filtering products.

skustringOptional

SKU for filtering products.

statusstringOptional

Status of the products to filter.

priceintegerOptional

Price filter for products.

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the complete product list.

400

Bad request due to invalid parameters.

500

Internal server error.

get

/product

GET /backend/api/product HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete product list.</message>
</object>

Add a new coupon

post

/admin-coupon/add-coupon

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

couponCodestringRequired

couponNamestringRequired

couponTypestringRequired

discountstringRequired

minimumPurchaseAmountstringRequired

maximumPurchaseAmountstringRequired

emailRestrictionsstringRequired

maxUserPerCouponstringRequired

noOfTimeCouponValidPerUserstringRequired

statusstringRequired

appliedCartItemsCountintegerRequired

startDatestring · dateRequired

endDatestring · dateRequired

allQualifyingItemsApplyintegerRequired

Responses

200

Coupon Created Successfully.

post

/admin-coupon/add-coupon

POST /backend/api/admin-coupon/add-coupon HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 393

"couponCode='text'&couponName='text'&couponType='text'&discount='text'&minimumPurchaseAmount='text'&maximumPurchaseAmount='text'&emailRestrictions='text'&productType=[{'type':1,'referenceId':[1]}]&maxUserPerCoupon='text'&noOfTimeCouponValidPerUser='text'&status='text'&appliedCartItemsCount=1&startDate='2025-12-08'&endDate='2025-12-08'&allQualifyingItemsApply=1"

200

Coupon Created Successfully.

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>text</message>
</object>

Get Vendor Coupon Detail

get

/admin-coupon/coupon-detail

Query parameters

vendorCouponIdintegerRequired

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully got Vendor Coupon Detail.

get

/admin-coupon/coupon-detail

GET /backend/api/admin-coupon/coupon-detail?vendorCouponId=1 HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

200

Successfully got Vendor Coupon Detail.

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>successfully got Vendor Coupon Detail.</message>
</object>

Update an existing coupon

put

/admin-coupon/update-coupon/{couponId}

Path parameters

couponIdintegerRequired

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

couponCodestringRequired

couponNamestringRequired

couponTypestringRequired

discountstringRequired

minimumPurchaseAmountintegerRequired

maximumPurchaseAmountintegerRequired

emailRestrictionsstringRequired

maxUserPerCouponintegerRequired

noOfTimeCouponValidPerUserintegerRequired

statusstringRequired

appliedCartItemsCountintegerRequired

startDatestring · dateRequired

endDatestring · dateRequired

allQualifyingItemsApplyintegerRequired

couponIdstringRequired

Responses

200

Coupon Updated Successfully.

put

/admin-coupon/update-coupon/{couponId}

PUT /backend/api/admin-coupon/update-coupon/{couponId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 391

"couponCode='text'&couponName='text'&couponType='text'&discount='text'&minimumPurchaseAmount=1&maximumPurchaseAmount=1&emailRestrictions='text'&productType=[{'type':1,'referenceId':[1]}]&maxUserPerCoupon=1&noOfTimeCouponValidPerUser=1&status='text'&appliedCartItemsCount=1&startDate='2025-12-08'&endDate='2025-12-08'&allQualifyingItemsApply=1&couponId='text'"

200

Coupon Updated Successfully.

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Coupon Updated Successfully.</message>
</object>

Delete a coupon

delete

/delete-coupon/{couponId}

Deletes the specified coupon by ID

Path parameters

couponIdintegerRequired

ID of the coupon to delete

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted the coupon

400

Invalid ID supplied

404

Coupon not found

delete

/delete-coupon/{couponId}

DELETE /backend/api/delete-coupon/{couponId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted Coupon</message>
</object>