Manage Marketing

add coupon

Add a coupon.

POST/admin-coupon/add-coupon

Header parameters

Body

application/x-www-form-urlencoded

couponNamestring

couponCodestring

couponTypeinteger (int32)

discountinteger (int32)

minimumPurchaseAmountinteger (int32)

maximumPurchaseAmountinteger (int32)

couponConjunctioninteger (int32)

couponAppliesSalesinteger (int32)

emailRestrictionsstring

applicableForinteger (int32)

freeShippinginteger (int32)

startDatestring

endDatestring

maxUserPerCouponinteger (int32)

noOfTimeCouponValidPerUserinteger (int32)

allQualifyingItemsApplyinteger (int32)

appliedCartItemsCountinteger (int32)

productTypearray of product (object)

statusinteger (int32)

Response

200400

success response

Body

application/json

createdDatestring (date-time)

vendorCouponIdinteger (int32)

vendorIdinteger (int32)

couponNamestring

couponCodestring

couponTypeinteger (int32)

discountstring

startDatestring (date-time)

endDatestring (date-time)

isActiveinteger (int32)

ordersinteger (int32)

leftDaysinteger (int32)

Request

JavaScriptCurl

const response = await fetch('/admin-coupon/add-coupon', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "createdDate": "2024-04-29T06:48:03.227Z",
  "couponName": "text",
  "couponCode": "text",
  "discount": "text",
  "startDate": "2024-04-29T06:48:03.227Z",
  "endDate": "2024-04-29T06:48:03.227Z"
}

admin coupon list

Get list of coupon.

GET/admin-coupon/admin-coupon-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-coupon/admin-coupon-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully got vendor Coupon list"
}

coupon usage list

Get the list of coupon usage.

GET/admin-coupon/coupon-usage-list

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-coupon/coupon-usage-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

coupon detail

Geat detail of a coupon.

GET/admin-coupon/coupon-detail

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-coupon/coupon-detail', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "successfully got Vendor Coupon Detail."
}

update coupon

Update a coupon.

PUT/admin-coupon/update-coupon/{vendorCouponId}

Path parameters

vendorCouponId*integer

Header parameters

Body

application/x-www-form-urlencoded

couponNamestring

couponCodestring

couponTypeinteger (int32)

discountinteger (int32)

minimumPurchaseAmountinteger (int32)

maximumPurchaseAmountinteger (int32)

couponConjunctioninteger (int32)

couponAppliesSalesinteger (int32)

emailRestrictionsstring

applicableForinteger (int32)

freeShippinginteger (int32)

startDatestring

endDatestring

maxUserPerCouponinteger (int32)

noOfTimeCouponValidPerUserinteger (int32)

allQualifyingItemsApplyinteger (int32)

appliedCartItemsCountinteger (int32)

productTypearray of product (object)

statusinteger (int32)

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-coupon/update-coupon/{vendorCouponId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "message": "Coupon Updated Successfully."
}

delete coupon

Delete a Coupon.

DELETE/admin-coupon/delete-coupon/{vendorCouponId}

Path parameters

vendorCouponId*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-coupon/delete-coupon/{vendorCouponId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted Coupon"
}

delete bulk coupon

Delete the bulk of coupon.

POST/admin-coupon/delete-bulk-coupon

Header parameters

Body

application/x-www-form-urlencoded

vendorCouponId*string

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-coupon/delete-bulk-coupon', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "vendorCouponId": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully deleted Coupon"
}

bulk export admin coupon list

Bulk export of coupon list.

GET/admin-coupon/bulk-export-admin-coupon-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('/admin-coupon/bulk-export-admin-coupon-list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Vendor Coupon List Successfully"
}