API Merci Facteur /getSuiviEnvoi : Obtenir le suivi et l'état des courriers d'un envoi

Base URL API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service

Endpoint API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service/getSuiviEnvoi

← Retour à la liste des endpoints de l'API Merci Facteur

GET /getSuiviEnvoi — Obtenir le suivi et l'état des courriers d'un envoi

Cette opération vous permet d'obtenir à n'importe quel moment l'état de courriers qui composent un envoi. Cet état correspond à l'état de l'impression du courrier jusqu'à sa remise à La Poste, et dans le cas des envois en LRAR ou en SUIVI, également l'historique du suivi de l'acheminement des courriers de la prise en charge par La Poste jusqu'à la distribution au destinataire.

Paramètres

Nom	In	Type	Description
`ww-service-id`	header	string	Votre service Id
`ww-access-token`	header	string	Un access token valide
`idEnvoi`	query	integer	Id de l'envoi dont on veut extraire le suivi.

Request body

Aucun body.

Réponses

HTTP 200 — Objet contenant les détails du suivi des courriers de l'envoi

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error string le code d'erreur en cas d'erreur

statutPrintEnvoi string Le statut de l'impression des courriers (exemples "Traitement en attente","Génération des courriers en cours", "Préparation en cours", "Impression en attente", "Impression en cours", "Impression terminée")

suiviCourrier array<object> Les infos de suivi de chaque courrier constituant cet envoi

Items:

Propriété Type Description

dest string Nom et/ou société du destinataire

refCourrier string Référence Merci facteur du courrier

refTracking string Référence de suivi postal

modeEnvoi string Mode d'envoi du courrier (lrar, lrare, suivi ou normal)

lastState string Dernier état connu de l'acheminement

lastStateCode object Code du dernier état connu (cf. nomenclature sur notre github)

Propriété	Type	Description
`event`	string
`suivi_courrier`	string

historique string Historique complet de l'acheminement

pnd string 1 en cas de pli non distribuable, sinon 0. Est égale à null si le courrier n'a pas de suivi.

are_base64_jpeg string Si vous avez envyé ce courrier en lrare, "pending" si l'accusé de réception n'est pas encore disponible, ou la base64 de l'AR numérisé (format jpeg) si il est disponible. Est égale à null le mode d'envoi du courrier n'est pas lrare.

HTTP 400 — Erreur (code d'erreur dans l'entête)

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error object Objet contenant les infos de l'erreur.

Propriété	Type	Description
`code`	string	le code d'erreur en cas d'erreur
`text`	string	le message d'erreur correspondant

HTTP 401 — Erreur authentification (code d'erreur dans l'entête : token invalide ou expiré, service-id incorrecte, IP non autorisée)

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error object Objet contenant les infos de l'erreur.

Propriété	Type	Description
`code`	string	le code d'erreur en cas d'erreur
`text`	string	le message d'erreur correspondant