sell-app-fixed

v1.1.1

Published

a year ago

Fixed version of https://www.npmjs.com/package/sell-app

Downloads

0High
0Medium
0Low

lecookie

wrapper api sell.app sellapp

Sell.app API Wrapper

A simple Node.js API Wrapper made for Sell.app. CONTRIBUTING

This is a fork from fsalinas26's Sellix API Wrapper made to access the Sell.app's API

TO-DO List

[ ] Hi uh ik there has been lack of updates since i was too busy w uni and stuffs, i'll try to get back to update when i can (also published new changes to npm btw, forgot to update it when i merged a few pull requests from an awesome contributor).
[ ] Add full support for Product API V2
[ ] Make a wiki to replace this long listed examples.

Requirements

Sell.app API Key (Get it here)
npm >=8.3.0
node >=16.0.0

Installation

npm install sell-app

Usage

const Sellapp = require("sell-app");
const API = new Sellapp.API("YOUR_API_KEY");

API.getAllProducts().then((res) => {
	console.log(res); // returns a list of all products
});

API.createBlacklist("email", "[email protected]", "evil user").then((res) => {
	console.log(res); // blacklisting the said user with the string "evil user" as description
});

Multi-Store Support

Say you are part of multiple stores and want to access bob.sell.app, you would pass the slug bob as your store.

Supported Endpoints

Click on an endpoint to see its example.

Blacklists Endpoint

getAllBlacklists(): Returns a list of all the blacklists created.
getBlacklist(id): Retrieves a blacklist by the entered ID.
createBlacklist(type, data, description): Creates a blacklist and returns the created blacklist.
updateBlacklist(id, type, data, description): Updates a blacklist by the entered ID.
deleteBlacklist(id): Deletes a blacklist by the entered ID.

Coupons Endpoint

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.

Listings/Products Endpoint

getAllProducts(): Returns a list of all the listings created.
getProduct(id): Retrieves a listing by the entered ID.
createProduct(fields): Creates a listing and returns the created listing.
updateProduct(id, fields): Updates a listing by the entered ID.
deleteProduct(id): Deletes a listing by the entered ID.

Listings/Products v2 Endpoint

getAllProductsv2(): Returns a list of all products created.
createListing(fields): Create Listing.
getListing(id): Gets listing by the entered ID.
updateListing(id, fields): Updates a listing by the entered ID.
deleteListing(id): Deletes a listing by the entered ID.
searchVariants(id): Search for product variants by the entered ID.
getAllVariants(id): Returns a list of all product variants created by the entered ID.

Sections Endpoint

getAllSections(): Returns a list of all the listings created.
getSection(id): Retrieves a section by the entered ID.
createSection(fields): Creates a section and returns the created section.
updateSection(id, fields): Updates a section by the entered ID.
deleteSections(id): Deletes a section by the entered ID.

Feedback Endpoint

getAllFeedback(): Returns a list of all the feedback received.
getFeedback(id): Retrieves a feedback by the entered ID.
replyFeedback(id, replyMessage): Responds to a given feedback by the entered ID.

Invoices Endpoint

getAllOrders(): Returns a list of all the orders that have been placed.
getOrder(id): Retrieve a specific order by the entered ID.
getOrderDeliverables(id): Retrieve deliverables from a specific order by the entered ID.
createInvoice(fields): Generates an invoice, and returns the invoice that is generated.
issueReplacement(id, fields): Issue a replacement for an order by the entered ID.
createPayment(id): Generates a payment session for the given order.

Tickets Endpoint

getAllTickets(): Retrieves a list of all the tickets received.
getTicket(id): Retrieves a ticket by the entered ID.

Ticket Messages Endpoint

getAllTicketMessages(id): Retrieves a list of all the messages within a ticket by its entered ID.
getTicketMessage(id, messageId): Retrieves a specific message within a ticket by their respective entered IDs.
respondTicket(id, fields): Creates a message to a ticket by its entered ID and returns the created message.

Endpoints' examples of usage

Blacklist Endpoint

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

API.getBlacklist("164").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of a blacklist rule |

API.createBlacklist("ip", "1.3.3.7", "Block hackers").then((res) => {
    console.log(res);
});

API.updateBlacklist(
	"164",
	"country",
	"MX",
	"sorry my fellow Mexican friends :sob:"
).then((res) => {
	console.log(res);
});

API.deleteBlacklist("164").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of the blacklist rule you want to delete |

Coupon Endpoint

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

API.getCoupon("468").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of the coupon |

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

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

API.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);
});

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

API.deleteCoupon("468").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of the coupon you want to delete |

Product Endpoint

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

API.getProduct("4982").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of the product |

API.createProduct({
	"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);
	});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :-------------: | | fields | object | ✔️ | Product's field |

API.updateProduct("4982", {
	"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);
	});

API.deleteProduct("4982").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of the product you want to delete |

Section Endpoint

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

API.getSection("694").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of a section |

API.createSection({
	"title": "Gaming Goods",
	"hidden": false
})
	.then((res) => {
		console.log(res);
	})
	.catch((err) => {
		console.log(err);
	});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :-------------: | | fields | object | ✔️ | Section's field |

API.updateSection("694", {
	"title": "Gaming Goods",
	"hidden": false,
	"order": 1,
	"slug": "gaming-goods"
}).then((res) => {
	console.log(res);
});

API.deleteSection("694").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of the section you want to delete |

Feedback Endpoint

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

API.getFeedback("666").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of a feedback |

API.replyFeedback("666", "Thanks for the positive feedback!").then((res) => {
	console.log(res);
});

| Parameters | Type | Required | Description | | :------------: | :----: | :------: | :-----------------------------------------------------------------------: | | id | string | ✔️ | ID of the coupon you want to update | | replyMessage | string | ✔️ | A reply message that was left by the store owner who received this rating |

Invoice Endpoint

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

API.getOrder("666").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of an order |

API.getOrderDeliverables("666").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | ID of an order |

API.createInvoice({
	"customer_email": "[email protected]",
	"total": "4.99",
	"payment_method": "PAYPAL",
	"products": {
		"1210": {
			"quantity": 5,
			"additional_information": [
				{
					"accept_terms_and_conditions": true,
					"read_terms_and_conditions_before_accepting": true
				}
			],
			"fill_once": true
		}
	}
})
	.then((res) => {
		console.log(res);
	})
	.catch((err) => {
		console.log(err);
	});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :-------------: | | fields | object | ✔️ | Invoice's field |

API.issueReplacement("666", {
  "listings": [
    1,
    2,
    3
  ]
}).then((res) => {
	console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :-----------------------------------------------------------------------------------------------: | | id | string | ✔️ | ID of the order you want to issue a replacement | | fields | array | ❌ | The listings that should be replaced. If no listings are provided, all listings will be replaced. |

API.createPayment("4982")
	.then((res) => {
		console.log(res);
	})
	.catch((err) => {
		console.log(err);
	});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | Generates a payment session for the given ORDER ID. |

Ticket Endpoint

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

API.getTicket("69").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | Retrieves a ticket by the entered ID. |

Ticket Message Endpoint

API.getAllTicketMessages("69").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :--------------------: | | id | string | ✔️ | Retrieves a list of all the messages within a ticket by its entered ID. |

API.getTicketMessage("69", "420").then((res) => {
    console.log(res);
});

| Parameters | Type | Required | Description | |:-----------:|:----:|:--------:|:-----------------------------------------------------------------------------:| | id | int | ✔️ | ID of a ticket | | messageId | int | ✔️ | Retrieves a specific message within a ticket by their respective entered IDs. |

API.respondTicket("69", {
	"author": "STORE",
	"content": "This is a response message."
}).then((res) => {
	console.log(res);
});

| Parameters | Type | Required | Description | | :--------: | :----: | :------: | :----------------------------------: | | id | string | ✔️ | ID of the ticket you want to respond | | fields | object | ✔️ | Response's field |

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Sell.app API Wrapper

TO-DO List

Requirements

Installation

Usage

Multi-Store Support

Supported Endpoints

Blacklists Endpoint

Coupons Endpoint

Listings/Products Endpoint

Listings/Products v2 Endpoint

Sections Endpoint

Feedback Endpoint

Invoices Endpoint

Tickets Endpoint

Ticket Messages Endpoint

Endpoints' examples of usage

Blacklist Endpoint

Coupon Endpoint

Product Endpoint

Section Endpoint

Feedback Endpoint

Invoice Endpoint

Ticket Endpoint

Ticket Message Endpoint

Contributing

License