API Merci Facteur /getEnvoi : Lister les courriers d'un envoi en particulier

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/getEnvoi

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

GET /getEnvoi — Lister les courriers d'un envoi en particulier

Cette opération entre dans le détail des informations d'un envoi précis. Un envoi peut etre composé de plusieurs destinataires (une lettre identique envoyée a des destinataires différents). Un envoi peut donc contenir plusieurs courriers.

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 les détails.

Request body

Aucun body.

Réponses

HTTP 200 — Objet contenant les détails de l'envoi en question

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

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

envoi array<object>

Items:

Propriété Type Description

general array<object>

Items:

Propriété Type Description

idEnvoi integer Id de l'envoi

statut string Statut de l'envoi

nbPage integer Nb page de chaque courrier de l'envoi

nbDest integer Nombre de destinataires de l'envoi (=nombre de courriers)

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

date integer Date de l'envoi au format timestamp

idExp integer adresse Id de l'adresse d'expéditeur

idDest array<integer> adresse Id de/des l'adresse(s) de destinataire(s)

amount array<object> Résumé du montant facturé par Merci facteur

Items:

Propriété Type Description

contenu array<object>

Items:

Propriété	Type	Description
`ht`	string

affranchissement string Sous-total de l'affranchissement

total array<object> Montant total facturé

Items:

Propriété	Type	Description
`ht`	string

detail array<object>

Items:

Propriété Type Description

refCourrier string Référence Merci facteur du courrier, si=null alors le courrier n'est pas encore généré (cf. statut de l'envoi)

dest object Infos du destinataire du courrier

Propriété	Type	Description
`id`	integer	Adress ID e ce destinataire
`civilite`	string	Civilité de ce destinataire
`nom`	string	Nom de ce destinataire
`prenom`	string	Prénom de ce destinataire
`societe`	string	Société de ce destinataire
`adresse1`	string	Ligne 1 d'adresse de ce destinataire
`adresse2`	string	Ligne 2 d'adresse de ce destinataire
`adresse3`	string	Ligne 3 d'adresse de ce destinataire
`cp`	string	Code postal de ce destinataire
`ville`	string	Ville de ce destinataire
`pays`	string	Pays de ce destinataire

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