node-foodics v0.1.1

node-foodics

Simple Node.js wrapper for Foodics API.

Getting Started

Installation

npm install node-foodics

Setup

Basically require node-foodics and create a new instance with new NodeFoodics().

If you have all of your credentials, you can use new NodeFoodics(token, xbusiness, branchHid) initialization to access all functions.

If you already have your token, then you can create instance using new NodeFoodics(token) OR you can set token using foodics.setToken(token). Using this initialization you'll be able to use Get Allowed Businesses function. All other endpoints require X-Business.

After you have your X-Business, you can set it using foodics.setXBusiness(xbusiness).

Example

const NodeFoodics = require("node-foodics");
..
const foodics = new NodeFoodics(token, xbusiness, branchHid);
// OR
const foodics = new NodeFoodics();
foodics.setToken(token);
const businesses = await foodics.allowedbusinesses.list();
foodics.setXBusiness(businesses[0].hid);

Filtering

You can find more information about allowed filters in detail pages. For LIST functions, you can pass a filter object for filtering.

Example

const businesses = await foodics.categories.list({
  sku: "SKU_01"
});

Available Functions

Contributing

If you want to contribute to a project and make it better, your help is very welcome.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.