https://github.com/rigwild/suivi-poste
Suivre les envois postaux
https://github.com/rigwild/suivi-poste
Last synced: 6 months ago
JSON representation
Suivre les envois postaux
- Host: GitHub
- URL: https://github.com/rigwild/suivi-poste
- Owner: rigwild
- License: mit
- Created: 2020-04-29T17:01:55.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-23T21:45:27.000Z (over 5 years ago)
- Last Synced: 2025-10-11T10:49:25.214Z (10 months ago)
- Language: TypeScript
- Size: 18.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# suivi-poste
[](https://www.npmjs.com/package/suivi-poste)
> Suivre les envois postaux
La Poste fourni en Open Data une [API de suivi postal](https://developer.laposte.fr/products/suivi/latest). Ce module permet de consommer cette API.
Les produits supportés sont les suivants :
- Courriers suivis national
- Courriers suivis international
- Colis Colissimo
- Envois Chronopost
Il faut s'inscrire sur le portail [developer.laposte.fr](https://developer.laposte.fr) pour générer une clef d'API en mode production.
Documentation des réponses d'API : https://developer.laposte.fr/products/suivi/latest
## Installation
```
$ yarn add suivi-poste
```
## Usage
```ts
import { suiviPosteApi } from 'suivi-poste'
const suiviPoste = suiviPosteApi({ token: 'my-api-key' })
const result = await suiviPoste.getTracking('6A15602676300', 'A00000001', '6A15602683841')
console.log(result)
/* =>
{ lang: 'fr_FR',
scope: 'open',
returnCode: 200,
shipment:
{ idShip: '6A15602676300',
holder: 4,
product: 'colissimo',
...
*/
```
## Related
- [suivi-poste-cli](https://github.com/rigwild/suivi-poste-cli) - CLI pour ce module
- [suivi-poste-proxy](https://github.com/rigwild/suivi-poste-proxy) - Serveur proxy pour ce module
## License
[The MIT license](./LICENSE)