Coupons

All endpoints related to Coupons

Supported Endpoints

• getAllCoupons(): Returns a list of all the coupons created.

• getCoupon(id): Retrieves a coupon by the entered ID.

• createCoupon(fields): Creates a coupon and returns the created coupon.

• updateCoupon(id, fields): Updates a coupon by the entered ID.

• deleteCoupon(id): Deletes a coupon by the entered ID.

---

getAllCoupons()

Usage

const Sellapp = require("sellapp-node");
const API = new Sellapp.API("YOUR_API_KEY");

API.coupons.getAllCoupons().then((res) => {
    console.log(res) //returns a list of all Coupons
});

---

getCoupon()

	Type	Required	Description
id	string	✔️	ID of a Coupon

Usage

const Sellapp = require("sellapp-node");
const API = new Sellapp.API("YOUR_API_KEY");

API.coupons.getCoupon("666").then((res) => {
    console.log(res)
})

---

createCoupon()

Parameters

Parameters	Type	Required	Description
fields	object	✔️	Coupon's field

Fields' Value

Fields' Values	Type	Required	Description
code	string	✔️	The coupon code the customer enters during checkout.
type	string	✔️	This can be either "PERCENTAGE" or "AMOUNT".
discount	string	✔️	The discount value in percentage or cents.
limit	int/null	❌	The maximum amount of times a coupon code can be used, across all customers.
store_wide	boolean	✔️	Whether the coupon applies to all products within your store or not.
expires_at	string/null	❌	The coupon's expiry date. (format: YY-MM-DD HH-MM-SS)

Usage

const Sellapp = require("sellapp-node");
const API = new Sellapp.API("YOUR_API_KEY");

API.coupons.createCoupon({
    "code": "25off",
    "type": "PERCENTAGE",
    "discount": "25",
    "store_wide": false
}).then((res) => {
    console.log(res);
});

---

updateCoupon()

Parameters

Parameters	Type	Required	Description
id	string	✔️	ID of the coupon you want to update
fields	object	✔️	Coupon's field

Fields' Value

Fields' Values	Type	Required	Description
code	string	✔️	The coupon code the customer enters during checkout.
type	string	✔️	This can be either "PERCENTAGE" or "AMOUNT".
discount	string	✔️	The discount value in percentage or cents.
limit	int/null	❌	The maximum amount of times a coupon code can be used, across all customers.
store_wide	boolean	✔️	Whether the coupon applies to all products within your store or not.
expires_at	string/null	❌	The coupon's expiry date. (format: YY-MM-DD HH-MM-SS)

Usage

const Sellapp = require("sellapp-node");
const API = new Sellapp.API("YOUR_API_KEY");

API.coupons.updateCoupon("468", {
	"code": "free20",
	"type": "AMOUNT",
	"discount": "20", // price reduces by 20 dollars
	"limit": 2, // can only be used twice then expires
	"store_wide": true, // the code now can be used across all of your products
	"expires_at": "2023-01-01 12:00:00"
}).then((res) => {
    console.log(res); 
});

---

deleteCoupon()

Parameters	Type	Required	Description
id	string	✔️	ID of a Coupon

Usage

const Sellapp = require("sellapp-node");
const API = new Sellapp.API("YOUR_API_KEY");

API.coupons.deleteCoupon("666").then((res) => {
    console.log(res)
})