Product Variants

All endpoints related to Product Variants

Because we are dealing with 2 IDs, we will be using id for the product ID and vid for the variant ID

Supported Endpoints

• getAllVariants(): Returns a list of all products created.

• getVariant(id, vid): Gets listing by the entered ID.

• createProductVariant(id, fields): Create Listing.

• updateProductVariant(id, vid, fields): Updates a listing by the entered ID.

• deleteProductVariant(id, vid): Deletes a listing by the entered ID.

---

getAllVariants()

Parameters	Type	Required	Description
id	string	✔️	ID of a Product
limit	integer	❌	Limit the number of products returned
page	integer	❌	The page number you are attempting to access.
with_trashed	boolean	❌	Include deleted products in the results
only_trash	boolean	❌	Limit the results to only deleted products

Usage

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

API.variants.getAllVariants().then((res) => {
    console.log(res)
});

---

getVariant()

Parameters	Type	Required	Description
id	string	✔️	ID of a Product
vid	string	✔️	ID of the Variant

Usage

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

API.variants.getProduct("6666", "565").then((res) => {
    console.log(res)
})

---

createProductVariant()

Parameters

Parameters	Type	Required	Description
id	string	✔️	ID of the product
fields	object	✔️	Product's field

Fields' Value

Fields' Values	Type	Required	Description
title	string	✔️	The product's title.
description	string	✔️	The product's description.
image	object/null	❌	An image binary which will be visible when someone views your product.
order	int/null	❌	The product's order in which it is sorted on your storefront.
visibility	string	✔️	Either "PUBLIC", "HIDDEN", or "PRIVATE" - depending on whether you want this product to be visible.
deliverable	object	✔️	The product's deliverable which will be sent to the customer. Consists of three pieces of nested data, being "delivery_text", "type", and "data"
price	object	✔️	The product's price in nested format. Consists of two variables "PRICE" (in cents) and "CURRENCY".
humble	boolean	❌	Whether you want to allow the customer to pay more than the product's price. ( ͡° ͜ʖ ͡°)
payment_methods	array of string	✔️	Items Enum: "COINBASE" "PAYDASH" "PAYPAL" "STRIPE". The product's payment methods in array format.
additional_information	array	❌	Additional info that can be requested from the customer during the checkout process.
bulk_discount	array	❌	An array of discounts when a customer purchases more than a specified quantity.
minimum_purchase_quantity	int	✔️	The minimum amount a customer is able to purchase.
maximum_purchase_quantity	int/null	❌	The maximum amount a customer is able to purchase.
webhook	string/null	❌	A webhook URL that will receive updates when orders are placed.
warranty	object/null	❌	The warranty time in which a customer is able to request a refund.
locked	boolean	❌	Whether this product is locked by the admins or moderators.
section	int/null	❌	The ID of a section to associate with this product. Use null to disassociate a section.
label	object/null	❌	The name of the additional information input. Examples: TEXT,NUMBER,HIDDEN ,TEXTAREA ,

Usage

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

API.variants.createProductVariant({
	"title": "Millions of gold pieces",
	"description": "Get rich, buy this.",
	"deliverable": {
		"delivery_text": "Meet me in world 5",
		"type": "MANUAL",
		"data": {
			"stock": 666,
			"comment": "Thanks"
		}
	},
	"price": {
		"price": 50,
		"currency": "USD"
	},
	"payment_methods": ["PAYPAL"],
	"minimum_purchase_quantity": 1,
	"visibility": "HIDDEN"
}).then((res) => {
    console.log(res);
}).catch((err) => {
    console.log(err);
});

---

updateProductVariant()

Parameters

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

Fields' Value

Fields' Values	Type	Required	Description
title	string	✔️	The product's title.
description	string	✔️	The product's description.
image	object/null	❌	An image binary which will be visible when someone views your product.
order	int/null	❌	The product's order in which it is sorted on your storefront.
visibility	string	✔️	Either "PUBLIC", "HIDDEN", or "PRIVATE" - depending on whether you want this product to be visible.
deliverable	object	✔️	The product's deliverable which will be sent to the customer. Consists of three pieces of nested data, being "delivery_text", "type", and "data"
price	object	✔️	The product's price in nested format. Consists of two variables "PRICE" (in cents) and "CURRENCY".
humble	boolean	❌	Whether you want to allow the customer to pay more than the product's price. ( ͡° ͜ʖ ͡°)
payment_methods	array of string	✔️	Items Enum: "COINBASE" "PAYDASH" "PAYPAL" "STRIPE". The product's payment methods in array format.
additional_information	array	❌	Additional info that can be requested from the customer during the checkout process.
bulk_discount	array	❌	An array of discounts when a customer purchases more than a specified quantity.
minimum_purchase_quantity	int	✔️	The minimum amount a customer is able to purchase.
maximum_purchase_quantity	int/null	❌	The maximum amount a customer is able to purchase.
webhook	string/null	❌	A webhook URL that will receive updates when orders are placed.
warranty	object/null	❌	The warranty time in which a customer is able to request a refund.
locked	boolean	❌	Whether this product is locked by the admins or moderators.
section	int/null	❌	The ID of a section to associate with this product. Use null to disassociate a section.

Usage

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

API.variants.updateProductVariant("6666, {
	"title": "Millions of gold pieces EXTRA",
	"slug": "millions-of-gold-pieces",
	"description": "Get rich, buy this.",
	"visibility": "PUBLIC",
	"deliverable": {
		"delivery_text": "Meet me in world 1000!!",
		"type": "MANUAL",
		"data": {
			"stock": 666,
			"comment": "Thanks broski (scammed, real)"
		}
	},
	"price": {
		"price": 1000, // ( ͡° ͜ʖ ͡°)
		"currency": "USD"
	},
	"humble": true,
	"payment_methods": ["PAYPAL"],
	"minimum_purchase_quantity": 1,
	"maximum_purchase_quantity": 20
}).then((res) => {
    console.log(res); 
}).catch((err) => {
    console.log(err);
});

---

deleteProductVariant()

Parameters	Type	Required	Description
vid	string	✔️	ID of a Variant

Usage

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

API.variants.deleteProductVariant("6666").then((res) => {
    console.log(res)
})