sneakers-quick-task

1.1.2 • Public • Published

Sneakers AIO Quick Task Generator

A simple API for generating Sneakers AIO Quick Task URLs.

Installation

Using npm:

$ npm i --save sneakers-quick-task

In Node.JS:

const quickTask = require('sneakers-quick-task');

Usage

// Create keywords task: sneakersaio://quick-task?sites=https%3A%2F%2Fkith.com,https%3A%2F%2Fwww.deadstock.ca&keywords=yeezy,350,-kid,-infant&color_keywords=&size=any%20size&mode=queue
let quickTaskUrl = quickTask.createKeywordsTask(["https://kith.com", "https://www.deadstock.ca"], ["yeezy", "350", "-kid", "-infant"], [], "any size", "queue");

// Create product url task: sneakersaio://quick-task?sites=https%3A%2F%2Fkith.com&color_keywords=white,red&product_url=https%3A%2F%2Fkith.com%2Fcollections%2Fkith-monday-program%2Fproducts%2Fkh2636-101&size=Medium&mode=safe
quickTaskUrl = quickTask.createProductUrlTask("https://kith.com", "https://kith.com/collections/kith-monday-program/products/kh2636-101", ["white", "red"], "Medium");

// Create variant task: sneakersaio://quick-task?sites=https%3A%2F%2Fkith.com&variant=39246354940032&mode=safe
quickTaskUrl = quickTask.createVariantTask("https://kith.com", "39246354940032");

// Create size id task: sneakersaio://quick-task?sites=https%3A%2F%2Fwww.footlocker.ca&size_id=22661425&mode=safe
quickTaskUrl = quickTask.createSizeIDTask("https://www.footlocker.ca", "22661425");

// Create product number task: sneakersaio://quick-task?sites=https%3A%2F%2Fwww.footlocker.ca&color_keywords=white,red,-yellow&product_number=41047318&size=User%20Shoe&mode=safe
quickTaskUrl = quickTask.createProductNumberTask("https://www.footlocker.ca", "41047318", ["white", "red", "-yellow"], "User Shoe")

Documentation

Functions

createKeywordsTask(sites, keywords, colorKeywords, size, mode)String

Creates a Sneakers AIO Quick Task URL using the keywords search type.

createProductUrlTask(site, productUrl, colorKeywords, size, mode)String

Creates a Sneakers AIO Quick Task URL using the product URL search type.

createVariantTask(site, variant, mode)String

Creates a Sneakers AIO Quick Task URL using the Shopify variant search type.

createSizeIDTask(site, sizeID, mode)String

Creates a Sneakers AIO Quick Task URL using the Footsites size id search type.

createProductNumberTask(site, productNumber, colorKeywords, size, mode)String

Creates a Sneakers AIO Quick Task URL using the Footsites product number search type.

createKeywordsTask(sites, keywords, colorKeywords, size, mode) ⇒ String

Creates a Sneakers AIO Quick Task URL using the keywords search type.

Kind: global function
Returns: String - Sneakers AIO Quick Task URL

Param Type Default Description
sites Array.<String> Array of website URLs to create tasks for. These should be for the base url of the site (no path or query). All sites must be of the same type (ie. all Shopify or all Footsites).
keywords Array.<String> Array of keywords to search for. Negative keywords begin with -
colorKeywords Array.<String> Array of color keywords to search for. Negative keywords begin with -
size String User Shoe The size of the product. Special size types include: "Any Size", "One Size", "User Shoe" & "User Clothing".
mode String safe The bot mode. Shopify modes include "Safe", "Quick", "Queue", & "Input". Footsites modes include "Safe" & "Release". There may be more modes.

createProductUrlTask(site, productUrl, colorKeywords, size, mode) ⇒ String

Creates a Sneakers AIO Quick Task URL using the product URL search type.

Kind: global function
Returns: String - Sneakers AIO Quick Task URL

Param Type Default Description
site String Website URL to create the task for. This should be for the base url of the site (no path or query).
productUrl String Full url of the product to purchase (w/ path).
colorKeywords Array.<String> Vector of color keywords to search for. Negative keywords begin with -
size String User Shoe The size of the product. Special size types include: "Any Size", "One Size", "User Shoe" & "User Clothing".
mode String safe The bot mode. Shopify modes include "Safe", "Quick", "Queue", & "Input". Footsites modes include "Safe" & "Release". There may be more modes.

createVariantTask(site, variant, mode) ⇒ String

Creates a Sneakers AIO Quick Task URL using the Shopify variant search type.

Kind: global function
Returns: String - Sneakers AIO Quick Task URL

Param Type Default Description
site String Website URL (Shopify only) to create the task for. This should be for the base url of the site (no path or query).
variant String Variant of the product to purchase.
mode String safe The bot mode. Shopify modes include "Safe", "Quick", "Queue", & "Input". There may be more modes.

createSizeIDTask(site, sizeID, mode) ⇒ String

Creates a Sneakers AIO Quick Task URL using the Footsites size id search type.

Kind: global function
Returns: String - Sneakers AIO Quick Task URL

Param Type Default Description
site String Website URL (Footsites only) to create the task for. This should be for the base url of the site (no path or query).
sizeID String Size ID of the product to purchase (ID used for carting the product).
mode String safe The bot mode. Footsites modes include "Safe" & "Release". There may be more modes.

createProductNumberTask(site, productNumber, colorKeywords, size, mode) ⇒ String

Creates a Sneakers AIO Quick Task URL using the Footsites product number search type.

Kind: global function
Returns: String - Sneakers AIO Quick Task URL

Param Type Default Description
site String Website URL (Footsites only) to create the task for. This should be for the base url of the site (no path or query).
productNumber String Product Number of product to find. Can be found in the product url. Ie. the product number for https://www.footlocker.ca/en/product/jordan-retro-3-mens/48818677.html is 48818677.
colorKeywords Array.<String> Vector of color keywords to search for. Negative keywords begin with -
size String User Shoe The size of the product. Special size types include: "Any Size", "One Size", "User Shoe" & "User Clothing".
mode String safe The bot mode. Footsites modes include "Safe" & "Release". There may be more modes.

Package Sidebar

Install

npm i sneakers-quick-task

Weekly Downloads

1

Version

1.1.2

License

MIT

Unpacked Size

19.7 kB

Total Files

4

Last publish

Collaborators

  • sneakersaio