API Merci Facteur /getPostagePrice : Obtenir le montant d'un ou plusieurs courriers (non nécessaire à l'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/getPostagePrice

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

← Voir ce endpoint dans la doc Swagger

GET /getPostagePriceObtenir le montant d'un ou plusieurs courriers (non nécessaire à l'envoi)
 
Voir dans Swagger →

Vous permet d'avoir le montant de l'affranchissement et du contenu d'un courrier en fonction de son contenu, de son mode d'envoi et de sa destination. Vous n'avez pas besoin d'utiliser cette fonction pour envoyer un courrier, mais vous pouvez l'utiliser si vous avez besoin de cette information avant d'envoyer un courrier (par exemple pour des raisons de facturation). Le montant retourné est un montant HT. La partie "affranchissement" n'est pas soumise à la TVA.

Paramètres

NomInTypeDescription
ww-service-idheaderstringVotre service Id
ww-access-tokenheaderstringUn access token valide
modeEnvoiqueryarray<string>Mode d'envoi du courrier : normal, suivi, lrar ou lrare
Items:
Valeurs autorisées : normal, suivi, lrar, lrare
paysDestinataire[]queryarray<string>Tableau de pays de destination, avec une orthographe conforme via /getCountry (indiquez soit paysDestinataire, soit idDestinataire).
idDestinataire[]queryarray<integer>Tableau d'id de destinataire(s) déjà créé (indiquez soit paysDestinataire, soit idDestinataire).
cardFormatqueryarray<string>Format de la carte (laisser vide si pas de carte)
Items:
Valeurs autorisées : , postcard, naked-postcard, classic, folded, large
cardPapierqueryarray<string>Papier de la carte (laisser vide si pas de carte)
Items:
Valeurs autorisées : , classic, nacre, creation
cardCoinqueryarray<string>Coins de la carte (laisser vide si pas de carte)
Items:
Valeurs autorisées : , carre, arrondi
letterPageNumberqueryintegerNombre de page(s) de lettre (indiquer 0 si pas de lettre)
letterPrintSidesquerystringrectoverso pour une lettre imprimée recto-verso, recto pour une lettre imprimée en recto simple.
photoNumberqueryintegerNombre de photo(s) (indiquer 0 si pas de lettre)

Request body

Aucun body.

Réponses

HTTP 200 — montant HT du courrier

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorstringle code d'erreur en cas d'erreur
poidsstringLe poids du courrier en grammes
affranchissementobjectobject avec, pour chaque pays demandé, le montant de l'affranchissement et la zone géographique
PropriétéTypeDescription
PAYSobjectObject contenant le montant d'affranchissement pour ce pays ainsi que la zone géographique.
PropriétéTypeDescription
amountstringmontant HT de l'affranchissement
zonestringZone géographique du pays (fr, z1, z2, om1, om2)
contentobjectobject avec, pour chaque pays demandé, le montant de l'affranchissement et la zone géographique
PropriétéTypeDescription
photoHtstringmontant HT des photos
lettreHtstringmontant HT des pages de lettres
carteHtstringmontant HT de la carte
totalContentHtstringmontant HT du contenu du courrier
HTTP 400 — Erreur (code d'erreur dans l'entête)

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorobjectObjet contenant les infos de l'erreur.
PropriétéTypeDescription
codestringle code d'erreur en cas d'erreur
textstringle 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éTypeDescription
successbooleantrue si HTTP 200, sinon false
errorobjectObjet contenant les infos de l'erreur.
PropriétéTypeDescription
codestringle code d'erreur en cas d'erreur
textstringle message d'erreur correspondant


imprimé en france depuis 2004