API Merci Facteur /setNewAdress : Créer une nouvelle adresse dans le carnet d'adresses (non obligatoire pour l'envoi d'un courrier)

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

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

POST /setNewAdress — Créer une nouvelle adresse dans le carnet d'adresses (non obligatoire pour l'envoi d'un courrier)

Voir dans Swagger →

Cela peut-être une adresse d'expéditeur ou de destinataire. Les adresses sont liées à un utilisateur précis.
Vous ne pouvez pas créer plusieurs fois la même adresse, mais réutiliser les adresses créées.
Sont obligatoires : (nom et/ou société), (cp), (ville), (pays)
Pays doit être avec une orthographe conforme cf. getCountry()
Si une infos est inutilisée, tout de même l'envoyer en string vide.
Si vous ne souhaitez pas utiliser de carnet d'adresses, vous pouvez intégrer directement les adresses dans l'envoi des courriers, sans avoir recours à cette fonction avant.

Paramètres

Nom	In	Type	Description
`ww-service-id`	header	string	Votre service Id
`ww-access-token`	header	string	Un access token valide
`idUser`	query	integer	User Id de l'utilisateur propriétaire de cette adresse.
`type`	query	string	Type d'adresse : Expéditeur (exp) ou destinataire (dest)

Request body

application/x-www-form-urlencoded

Propriété Type Description

adress object

Propriété	Type	Description
`logo`	string	Url du logo (uniquement pour les expéditeurs)
`civilite`	string	Civilité du contact
`nom`	string	Nom du contact (doit être rempli si societe est vide)
`prenom`	string	Prénom du contact
`societe`	string	Société du contact (doit être rempli si le nom est vide)
`adresse1`	string	Première ligne de l'adresse (exemple : la rue)
`adresse2`	string	Seconde ligne de l'adresse (exemple : le lieu-dit)
`adresse3`	string	Troisième ligne de l'adresse (exemple : la boite postale)
`cp`	string	Code postal de l'adresse
`ville`	string	Ville de l'adresse
`pays`	string	Pays avec une orthographe conforme (cf. getCountry)
`phone`	string	Le téléphone mobile du destinataire en cas d'envoi de recommandé électronique avec OTP SMS (format +33628749452)
`email`	string	Adesse email du destinataire ou de l'expéditeur en cas d'envoi de recommandé électronique
`consent`	integer	Pour le destinataire dans le cas d'un envoi de recommandé électronique, il s'agit du consentement donné par le destinataire (doit être =1 pour permettre l'envoi d'un recommandé électronique)

Réponses

HTTP 200 — Objet contenant le Id de la nouvelle adresse

application/json

Propriété	Type	Description
`success`	boolean	true si HTTP 200, sinon false
`error`	string	le code d'erreur en cas d'erreur
`adress_id`	integer	L'id de l'adresse, à sauvegarder en local pour plus de confort

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