suivi-poste

Suivre les envois postaux

Usage no npm install needed!

<script type="module">
  import suiviPoste from 'https://cdn.skypack.dev/suivi-poste';
</script>

README

suivi-poste

npm badge

Suivre les envois postaux

La Poste fourni en Open Data une API de suivi postal. 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 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

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

License

The MIT license