@orchesty/connector-base 1.0.1 → 2.0.0
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 +95 -0
- package/dist/package.json +2 -2
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Base.com Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-base)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Base.com, an e-commerce marketplace management tool for orders, shipments, and warehouse operations.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**Basic**
|
|
11
|
+
|
|
12
|
+
This connector authenticates using an API token sent in the `X-BLToken` request header. All API calls are made via `POST` to a single endpoint (`https://api.baselinker.com/connector.php`), with the operation specified as a `method` field in the `multipart/form-data` body.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `token` | Your Base.com API token |
|
|
17
|
+
|
|
18
|
+
## Components
|
|
19
|
+
|
|
20
|
+
| Class | Type | Description |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| `CourierFields` | Connector | Fetches available fields for a given courier code |
|
|
23
|
+
| `CouriersList` | Connector | Retrieves the list of all available couriers |
|
|
24
|
+
| `CreatePackage` | Connector | Creates a shipment package for an order using a courier |
|
|
25
|
+
| `CreatePackageManual` | Connector | Manually registers a package with a provided tracking number |
|
|
26
|
+
| `GetLabel` | Connector | Retrieves the shipping label (base64) for a courier package |
|
|
27
|
+
| `Inventories` | Connector | Returns all inventories with languages, price groups, and warehouses |
|
|
28
|
+
| `InventoryWarehouses` | Connector | Returns all warehouses across all inventories |
|
|
29
|
+
| `OrderPaymentsHistory` | Connector | Retrieves payment history for a specific order |
|
|
30
|
+
| `OrderStatusList` | Connector | Returns the list of order statuses |
|
|
31
|
+
| `Orders` | Connector | Fetches orders with rich filtering options |
|
|
32
|
+
| `SetOrderStatus` | Connector | Sets the status of a specific order |
|
|
33
|
+
| `UpdateInventoryProductsStock` | Connector | Updates stock quantities for products in an inventory |
|
|
34
|
+
| `InventoryProductsData` | Batch | Fetches full product data for specified product IDs in an inventory |
|
|
35
|
+
| `InventoryProductsList` | Batch | Paginates through all products in an inventory with filtering |
|
|
36
|
+
| `JournalList` | Batch | Fetches journal/activity log entries since a tracked last log ID |
|
|
37
|
+
| `OrderExtraFields` | Batch | Retrieves all custom extra fields defined for orders |
|
|
38
|
+
|
|
39
|
+
## Setup
|
|
40
|
+
|
|
41
|
+
### Credentials
|
|
42
|
+
|
|
43
|
+
1. Log in to your Base.com account.
|
|
44
|
+
2. Navigate to **Integrations → API** to find your API token.
|
|
45
|
+
3. In Orchesty, open the Base.com application settings and paste the token into the **API token** field.
|
|
46
|
+
|
|
47
|
+
### API Documentation
|
|
48
|
+
|
|
49
|
+
Base.com (Baselinker) API Reference: [https://api.baselinker.com/](https://api.baselinker.com/)
|
|
50
|
+
|
|
51
|
+
## Installation & Usage
|
|
52
|
+
|
|
53
|
+
Install the package:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npm install @orchesty/connector-base @orchesty/nodejs-sdk
|
|
57
|
+
# or
|
|
58
|
+
pnpm add @orchesty/connector-base @orchesty/nodejs-sdk
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Register the application and nodes in your Orchesty DI container:
|
|
62
|
+
|
|
63
|
+
```typescript
|
|
64
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
65
|
+
import BaseApplication from '@orchesty/connector-base/dist/BaseApplication';
|
|
66
|
+
import CouriersList from '@orchesty/connector-base/dist/Connector/CouriersList';
|
|
67
|
+
import Orders from '@orchesty/connector-base/dist/Connector/Orders';
|
|
68
|
+
import SetOrderStatus from '@orchesty/connector-base/dist/Connector/SetOrderStatus';
|
|
69
|
+
import InventoryProductsList from '@orchesty/connector-base/dist/Batch/InventoryProductsList';
|
|
70
|
+
import JournalList from '@orchesty/connector-base/dist/Batch/JournalList';
|
|
71
|
+
// ... import remaining nodes as needed
|
|
72
|
+
|
|
73
|
+
const app = new BaseApplication();
|
|
74
|
+
container.setApplication(app);
|
|
75
|
+
container.setNode(new CouriersList(), app);
|
|
76
|
+
container.setNode(new Orders(), app);
|
|
77
|
+
container.setNode(new SetOrderStatus(), app);
|
|
78
|
+
container.setNode(new InventoryProductsList(), app);
|
|
79
|
+
container.setNode(new JournalList(), app);
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## License
|
|
83
|
+
|
|
84
|
+
This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
|
|
85
|
+
|
|
86
|
+
## Contributing
|
|
87
|
+
|
|
88
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
89
|
+
|
|
90
|
+
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
|
|
91
|
+
|
|
92
|
+
All contributions should include:
|
|
93
|
+
- Source code in `src/` following the existing connector structure
|
|
94
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
95
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-base",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.1",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"keywords": [],
|
|
18
18
|
"author": "info@hanaboso.com",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orchesty/nodejs-sdk": "^
|
|
20
|
+
"@orchesty/nodejs-sdk": "^5.0.8",
|
|
21
21
|
"form-data": "^4.0.5"
|
|
22
22
|
},
|
|
23
23
|
"engines": {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-base",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"keywords": [],
|
|
12
12
|
"author": "info@hanaboso.com",
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@orchesty/nodejs-sdk": "^
|
|
14
|
+
"@orchesty/nodejs-sdk": "^5.0.8",
|
|
15
15
|
"form-data": "^4.0.5"
|
|
16
16
|
},
|
|
17
17
|
"engines": {
|