@robinpath/bigcommerce 0.1.0 → 0.1.1
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 +114 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# @robinpath/bigcommerce
|
|
2
|
+
|
|
3
|
+
> BigCommerce module for RobinPath.
|
|
4
|
+
|
|
5
|
+
   
|
|
6
|
+
|
|
7
|
+
## Why use this module?
|
|
8
|
+
|
|
9
|
+
The `bigcommerce` module lets you:
|
|
10
|
+
|
|
11
|
+
- listProducts
|
|
12
|
+
- getProduct
|
|
13
|
+
- createProduct
|
|
14
|
+
- updateProduct
|
|
15
|
+
- deleteProduct
|
|
16
|
+
|
|
17
|
+
All functions are callable directly from RobinPath scripts with a simple, consistent API.
|
|
18
|
+
|
|
19
|
+
## Installation
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install @robinpath/bigcommerce
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Quick Start
|
|
26
|
+
|
|
27
|
+
**1. Set up credentials**
|
|
28
|
+
|
|
29
|
+
```robinpath
|
|
30
|
+
bigcommerce.setCredentials "your-credentials"
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
**2. listProducts**
|
|
34
|
+
|
|
35
|
+
```robinpath
|
|
36
|
+
bigcommerce.listProducts
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Available Functions
|
|
40
|
+
|
|
41
|
+
| Function | Description |
|
|
42
|
+
|----------|-------------|
|
|
43
|
+
| `bigcommerce.setCredentials` | Configure bigcommerce credentials. |
|
|
44
|
+
| `bigcommerce.listProducts` | listProducts |
|
|
45
|
+
| `bigcommerce.getProduct` | getProduct |
|
|
46
|
+
| `bigcommerce.createProduct` | createProduct |
|
|
47
|
+
| `bigcommerce.updateProduct` | updateProduct |
|
|
48
|
+
| `bigcommerce.deleteProduct` | deleteProduct |
|
|
49
|
+
| `bigcommerce.listOrders` | listOrders |
|
|
50
|
+
| `bigcommerce.getOrder` | getOrder |
|
|
51
|
+
| `bigcommerce.updateOrder` | updateOrder |
|
|
52
|
+
| `bigcommerce.listCustomers` | listCustomers |
|
|
53
|
+
| `bigcommerce.getCustomer` | getCustomer |
|
|
54
|
+
| `bigcommerce.createCustomer` | createCustomer |
|
|
55
|
+
| `bigcommerce.updateCustomer` | updateCustomer |
|
|
56
|
+
| `bigcommerce.listCategories` | listCategories |
|
|
57
|
+
| `bigcommerce.createCategory` | createCategory |
|
|
58
|
+
| `bigcommerce.listBrands` | listBrands |
|
|
59
|
+
| `bigcommerce.createBrand` | createBrand |
|
|
60
|
+
| `bigcommerce.getOrderProducts` | getOrderProducts |
|
|
61
|
+
| `bigcommerce.getStoreInfo` | getStoreInfo |
|
|
62
|
+
| `bigcommerce.listChannels` | listChannels |
|
|
63
|
+
| `bigcommerce.getOrderShipments` | getOrderShipments |
|
|
64
|
+
|
|
65
|
+
## Examples
|
|
66
|
+
|
|
67
|
+
### listProducts
|
|
68
|
+
|
|
69
|
+
```robinpath
|
|
70
|
+
bigcommerce.listProducts
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### getProduct
|
|
74
|
+
|
|
75
|
+
```robinpath
|
|
76
|
+
bigcommerce.getProduct
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### createProduct
|
|
80
|
+
|
|
81
|
+
```robinpath
|
|
82
|
+
bigcommerce.createProduct
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Integration with RobinPath
|
|
86
|
+
|
|
87
|
+
```typescript
|
|
88
|
+
import { RobinPath } from "@wiredwp/robinpath";
|
|
89
|
+
import Module from "@robinpath/bigcommerce";
|
|
90
|
+
|
|
91
|
+
const rp = new RobinPath();
|
|
92
|
+
rp.registerModule(Module.name, Module.functions);
|
|
93
|
+
rp.registerModuleMeta(Module.name, Module.functionMetadata);
|
|
94
|
+
|
|
95
|
+
const result = await rp.executeScript(`
|
|
96
|
+
bigcommerce.setCredentials "your-credentials"
|
|
97
|
+
bigcommerce.listProducts
|
|
98
|
+
`);
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## Full API Reference
|
|
102
|
+
|
|
103
|
+
See [MODULE.md](./MODULE.md) for complete documentation including all parameters, return types, error handling, and advanced examples.
|
|
104
|
+
|
|
105
|
+
## Related Modules
|
|
106
|
+
|
|
107
|
+
- [`@robinpath/shopify`](../shopify) — Shopify module for complementary functionality
|
|
108
|
+
- [`@robinpath/woocommerce`](../woocommerce) — WooCommerce module for complementary functionality
|
|
109
|
+
- [`@robinpath/square`](../square) — Square module for complementary functionality
|
|
110
|
+
- [`@robinpath/json`](../json) — JSON module for complementary functionality
|
|
111
|
+
|
|
112
|
+
## License
|
|
113
|
+
|
|
114
|
+
MIT
|