sell-app-fixed v1.1.1

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", "hi@example.com", "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.updateBlacklist(
	"164",
	"country",
	"MX",
	"sorry my fellow Mexican friends :sob:"
).then((res) => {
	console.log(res);
});

Coupon Endpoint

Product Endpoint

Section Endpoint

Feedback Endpoint

Invoice Endpoint

Ticket Endpoint

Ticket Message Endpoint

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