Manage marketing

Add vendor coupon

Add a vendor coupon

POST/vendor-coupon/add-coupon

Header parameters

Body

application/x-www-form-urlencoded

couponName*string

couponCode*string

couponType*integer (int32)

discount*integer (int32)

minimumPurchaseAmount*integer (int32)

maximumPurchaseAmount*integer (int32)

couponConjunctioninteger (int32)

couponAppliesSalesinteger (int32)

emailRestrictionsstring

applicableForinteger (int32)

freeShippinginteger (int32)

startDatestring

endDatestring

maxUserPerCoupon*integer (int32)

noOfTimeCouponValidPerUser*integer (int32)

allQualifyingItemsApplyinteger (int32)

appliedCartItemsCountinteger (int32)

productTypearray of integer

status*integer (int32)

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Coupon Saved successfully."
}

Vendor coupon list

Get list of vendor coupon

GET/vendor-coupon/vendor-coupon-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

Vendor usage coupon list

Get list of coupon usage list.

GET/vendor-coupon/coupon-usage-list

Query parameters

Header parameters

Response

200

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully got Coupon Usage count"
}

Vendor coupon detail

Get detail of vendor coupon

GET/vendor-coupon/vendor-coupon-detail

Query parameters

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

Update vendor coupon

Update a vendor coupon

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

Path parameters

vendorCouponId*integer

Header parameters

Body

application/x-www-form-urlencoded

couponName*string

couponCode*string

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 integer

status*integer (int32)

Response

200400

success response

Body

application/json

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

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

Delete vendor coupon

Delete a vendor coupon

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

Path parameters

vendorCouponId*integer

Header parameters

Response

200400

success response

Body

*/*

statusinteger

messagestring

Request

JavaScriptCurl

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

Response

{
  "message": "Successfully deleted the Vendor Coupon."
}