@orchesty/connector-expedico 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 +81 -0
- package/dist/package.json +2 -2
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Expedico Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-expedico)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Expedico, a single point for e-commerce parcel delivery, returns handling, and fulfillment services across Europe.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**Basic**
|
|
11
|
+
|
|
12
|
+
This connector authenticates using an API key and password encoded as HTTP Basic auth (`api_key:password` Base64-encoded in the `Authorization` header).
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `user` | Your Expedico API key (ApiKey) |
|
|
17
|
+
| `password` | Your Expedico API password |
|
|
18
|
+
|
|
19
|
+
## Components
|
|
20
|
+
|
|
21
|
+
| Class | Type | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `ExpedicoCreateParcel` | Connector | Creates a new parcel shipment via `POST /api/v2/parcels` and returns the parcel ID, carrier barcode, and tracking code |
|
|
24
|
+
| `ExpedicoGetCarriers` | Connector | Retrieves the list of available carriers via `GET /api/v2/carriers` |
|
|
25
|
+
| `ExpedicoGetTrackingInfo` | Batch | Posts a list of parcel IDs to `POST /api/v2/parcels_tracking` and fans out one batch item per tracking record |
|
|
26
|
+
|
|
27
|
+
## Setup
|
|
28
|
+
|
|
29
|
+
### Credentials
|
|
30
|
+
|
|
31
|
+
1. Log in to your Expedico account at [expedico.eu](https://expedico.eu).
|
|
32
|
+
2. Navigate to your account settings or contact your Expedico account representative.
|
|
33
|
+
3. Obtain your **API key** and **API password**.
|
|
34
|
+
4. In Orchesty, open the Expedico application settings and fill in:
|
|
35
|
+
- **ApiKey** — paste your API key
|
|
36
|
+
- **Password** — paste your API password
|
|
37
|
+
|
|
38
|
+
### API Documentation
|
|
39
|
+
|
|
40
|
+
Expedico API Reference: [https://expedico.eu/api-docs/](https://expedico.eu/api-docs/)
|
|
41
|
+
|
|
42
|
+
## Installation & Usage
|
|
43
|
+
|
|
44
|
+
Install the package:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npm install @orchesty/connector-expedico @orchesty/nodejs-sdk
|
|
48
|
+
# or
|
|
49
|
+
pnpm add @orchesty/connector-expedico @orchesty/nodejs-sdk
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Register the application and nodes in your Orchesty DI container:
|
|
53
|
+
|
|
54
|
+
```typescript
|
|
55
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
56
|
+
import ExpedicoApplication from '@orchesty/connector-expedico/dist/ExpedicoApplication';
|
|
57
|
+
import ExpedicoCreateParcel from '@orchesty/connector-expedico/dist/Connector/ExpedicoCreateParcel';
|
|
58
|
+
import ExpedicoGetCarriers from '@orchesty/connector-expedico/dist/Connector/ExpedicoGetCarriers';
|
|
59
|
+
import ExpedicoGetTrackingInfo from '@orchesty/connector-expedico/dist/Batch/ExpedicoGetTrackingInfo';
|
|
60
|
+
|
|
61
|
+
const app = new ExpedicoApplication();
|
|
62
|
+
container.setApplication(app);
|
|
63
|
+
container.setNode(new ExpedicoCreateParcel(), app);
|
|
64
|
+
container.setNode(new ExpedicoGetCarriers(), app);
|
|
65
|
+
container.setNode(new ExpedicoGetTrackingInfo(), app);
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## License
|
|
69
|
+
|
|
70
|
+
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.
|
|
71
|
+
|
|
72
|
+
## Contributing
|
|
73
|
+
|
|
74
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
75
|
+
|
|
76
|
+
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.
|
|
77
|
+
|
|
78
|
+
All contributions should include:
|
|
79
|
+
- Source code in `src/` following the existing connector structure
|
|
80
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
81
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-expedico",
|
|
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
|
},
|
|
22
22
|
"engines": {
|
|
23
23
|
"node": ">=24"
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-expedico",
|
|
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
|
},
|
|
16
16
|
"engines": {
|
|
17
17
|
"node": ">=24"
|