lightspeed-retail-sdk 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -3
- package/package.json +12 -4
package/README.md
CHANGED
|
@@ -1,19 +1,47 @@
|
|
|
1
|
-
# Another Unofficial Lightspeed Retail V3 API SDK
|
|
1
|
+
# Another Unofficial Lightspeed Retail V3 API SDK
|
|
2
2
|
|
|
3
3
|
## Work In Progress
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
We currently have the following methods available:
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
```
|
|
8
|
+
getCustomers()
|
|
9
|
+
getItems()
|
|
10
|
+
getItem()
|
|
11
|
+
getCategories()
|
|
12
|
+
getCategory()
|
|
13
|
+
getManufacturers()
|
|
14
|
+
getManufacturer()
|
|
15
|
+
getOrders()
|
|
16
|
+
getOrder()
|
|
17
|
+
getVendors()
|
|
18
|
+
getVendor()
|
|
19
|
+
getSales()
|
|
20
|
+
getSale()
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Get started:
|
|
8
24
|
|
|
9
25
|
```
|
|
26
|
+
import LightspeedRetailSDK from "lightspeed-retail-sdk";
|
|
27
|
+
|
|
10
28
|
const api = new LightspeedRetailSDK({
|
|
11
29
|
accountID: "Your Account No.",
|
|
12
30
|
clientID: "Your client ID.",
|
|
13
31
|
clientSecret: "Your client secret.",
|
|
14
32
|
refreshToken: "Your refresh token.",
|
|
15
33
|
});
|
|
34
|
+
```
|
|
16
35
|
|
|
36
|
+
## Example Request
|
|
37
|
+
|
|
38
|
+
```
|
|
17
39
|
const item = await api.getItem(7947, '["Category", "Images"]');
|
|
18
40
|
console.log(item);
|
|
41
|
+
|
|
42
|
+
7497 being the itemID. You can pass required relations as above.
|
|
19
43
|
```
|
|
44
|
+
|
|
45
|
+
## More Info
|
|
46
|
+
|
|
47
|
+
The documentation for the Lightspeed Retail API can be found at https://developers.lightspeedhq.com/retail/introduction/introduction/
|
package/package.json
CHANGED
|
@@ -1,15 +1,23 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "lightspeed-retail-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Another unofficial Lightspeed Retail API SDK for Node.js",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
7
7
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
8
8
|
},
|
|
9
|
-
"author": "@
|
|
9
|
+
"author": "@morley_darryl",
|
|
10
10
|
"license": "ISC",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"axios": "^1.2.2"
|
|
13
13
|
},
|
|
14
|
-
"type": "module"
|
|
15
|
-
|
|
14
|
+
"type": "module",
|
|
15
|
+
"repository": {
|
|
16
|
+
"type": "git",
|
|
17
|
+
"url": "https://github.com/darrylmorley/lightspeed-retail-sdk"
|
|
18
|
+
},
|
|
19
|
+
"keywords": [
|
|
20
|
+
"lightspeed retail",
|
|
21
|
+
"node"
|
|
22
|
+
]
|
|
23
|
+
}
|