Marketing

Get vendor coupon list

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/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.

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got vendor Coupon list.

400

Bad request due to invalid parameters.

*/*

500

Internal server error.

*/*

get

/admin-coupon/admin-coupon-list

HTTPcURLJavaScriptPython

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

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

Get complete product list

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/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.

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the complete product list.

400

Bad request due to invalid parameters.

*/*

500

Internal server error.

*/*

get

/product

HTTPcURLJavaScriptPython

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

{
  "status": 1,
  "message": "Successfully got the complete product list."
}

Add a new coupon

post

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/admin-coupon/add-coupon

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

application/json

couponCodestringRequired

couponNamestringRequired

couponTypestringRequired

discountstringRequired

minimumPurchaseAmountstringRequired

maximumPurchaseAmountstringRequired

emailRestrictionsstringRequired

maxUserPerCouponstringRequired

noOfTimeCouponValidPerUserstringRequired

statusstringRequired

appliedCartItemsCountintegerRequired

startDatestring · dateRequired

endDatestring · dateRequired

allQualifyingItemsApplyintegerRequired

Responses

200

Coupon Created Successfully.

application/json

statusintegerOptional

messagestringOptional

post

/admin-coupon/add-coupon

HTTPcURLJavaScriptPython

POST /backend/api/admin-coupon/add-coupon HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
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": "2026-05-14",
  "endDate": "2026-05-14",
  "allQualifyingItemsApply": 1
}

200

Coupon Created Successfully.

{
  "status": 1,
  "message": "text"
}

Get Vendor Coupon Detail

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/admin-coupon/coupon-detail

Query parameters

vendorCouponIdintegerRequired

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully got Vendor Coupon Detail.

application/json

statusintegerOptional

messagestringOptional

get

/admin-coupon/coupon-detail

HTTPcURLJavaScriptPython

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.

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

Update an existing coupon

put

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

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

Path parameters

couponIdintegerRequired

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

application/json

couponCodestringRequired

couponNamestringRequired

couponTypestringRequired

discountstringRequired

minimumPurchaseAmountintegerRequired

maximumPurchaseAmountintegerRequired

emailRestrictionsstringRequired

maxUserPerCouponintegerRequired

noOfTimeCouponValidPerUserintegerRequired

statusstringRequired

appliedCartItemsCountintegerRequired

startDatestring · dateRequired

endDatestring · dateRequired

allQualifyingItemsApplyintegerRequired

couponIdstringRequired

Responses

200

Coupon Updated Successfully.

application/json

statusintegerOptional

messagestringOptional

put

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

HTTPcURLJavaScriptPython

PUT /backend/api/admin-coupon/update-coupon/{couponId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
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": "2026-05-14",
  "endDate": "2026-05-14",
  "allQualifyingItemsApply": 1,
  "couponId": "text"
}

200

Coupon Updated Successfully.

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

Delete a coupon

delete

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/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

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully deleted Coupon

400

Invalid ID supplied

404

Coupon not found

delete

/delete-coupon/{couponId}

HTTPcURLJavaScriptPython

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

{
  "status": 1,
  "message": "Successfully deleted Coupon"
}

Get product list

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/product-list

Retrieves a list of products with optional limit and offset parameters.

Query parameters

limitintegerOptional

The number of products to retrieve

offsetintegerOptional

The number of products to skip before starting to collect results

countintegerOptional

If set to 1, returns the total count of products

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the product list

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: Successfully got the complete product list

400

Invalid query parameters

get

/product-list

HTTPcURLJavaScriptPython

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

{
  "status": 1,
  "message": "Successfully got the complete product list"
}

Get details of a product

get

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/product-related-detail/{productId}

Retrieves the details of a specific product by its ID.

Path parameters

productIdintegerRequired

ID of the product to retrieve details for

Query parameters

productIdintegerOptional

Product ID in query parameter

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the product details

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: successfully got the details of given product id

400

Invalid product ID

404

Product not found

get

/product-related-detail/{productId}

HTTPcURLJavaScriptPython

GET /backend/api/product-related-detail/{productId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "successfully got the details of given product id"
}

Update related products

post

http://139.59.67.17/backend/apihttps://139.59.67.17/backend/api

/update-product-related

Updates the related products for a given product.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

*/*

productIdintegerRequired

ID of the product to update related products for

relatedProductIdinteger[]Required

Array of related product IDs to associate with the given product

Responses

200

Successfully updated the related products

*/*

statusintegerOptionalExample: 1

messagestringOptionalExample: successfully updated the related products

400

Invalid request body

404

Product not found

post

/update-product-related

HTTPcURLJavaScriptPython

POST /backend/api/update-product-related HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: */*
Accept: */*
Content-Length: 38

{
  "productId": 1,
  "relatedProductId": [
    1
  ]
}

{
  "status": 1,
  "message": "successfully updated the related products"
}