Invoice v2

All endpoints related to Invoices v2

Invoices v2 is pretty much the same functionality as invoices v1 with the acceptation to extra fields.

Supported Endpoints

• getAllInvoices(): Returns a list of all the listings created.

• getInvoice(id): Retrieves a listing by the entered ID.

• getOrderDeliverables(id): Creates a listing and returns the created listing.

• createInvoice(fields): Updates a listing by the entered ID.

• issueReplacement(id, fields): Deletes a listing by the entered ID.

• createPayment(id): Generates a payment session for the given order.

---

Invoices v2

getAllInvoices()

Parameters	Type	Required	Description
limit	integer	❌	Limit the number of invoices returned
page	integer	❌	The page number you are attempting to access.

Usage

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

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

---

getInvoice()

	Type	Required	Description
id	string	✔️	ID of an invoice

Usage

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

API.invoices.getInvoice("6666").then((res) => {
    console.log(res)
})

---

getOrderDeliverables()

Parameters

Parameters	Type	Required	Description
id	string	✔️	ID of an invoices

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.invoices.getOrderDeliverables("666").then((res) => {
    console.log(res);
}).catch((err) => {
    console.log(err);
});

---

createInvoice()

Parameters

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

Fields' Value

Fields' Values	Type	Required	Description
customer_email	string	❌	The email of the customer who placed this order.
total	string	❌	The total amount to pay for this order. Can be excluded to create free-of-charge orders.
payment_method	string	❌	Enum: "COINBASE" "PAYDASH" "PAYPAL" "STRIPE". The payment gateway to process this order with.The selected payment gateway must be configured for the issuing store and should only be included in the request if the total of the order is greater than zero.
coupon	string	❌	The coupon code to apply to this order.
products	object	❌	Association of products with quantity and additional information to include in the order. The object keys must be the ids of the listings to include

Usage

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

API.invoices.createInvoice({
	"customer_email": "[e-mail]",
	"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);
});

---

issueReplacement()

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.

Usage

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

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

---

createPayment()

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

Usage

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

API.invoices.createPayment("4982").then((res) => {
    console.log(res)
})