2 - Lettres en nombre

Prix d'un publipostage

Calculez le prix (hors taxes) d'un publipostage, en fonction des différentes options et des réductions applicables à votre abonnement actuel. Cela vous permet d'estimer le tarif de votre envoi, avant de le soumettre (voir Soumettre un publipostage). Dans la réponse vous aurez le distinguo entre le prix de l'affranchissement et du service (papier, feuille, impression, mise sous pli, dépôt en poste).

post/publipostages/prix

Request

Base URL: https://sandbox-api.servicepostal.com
URL: https://sandbox-api.servicepostal.com/publipostages/prix
Auth: none declared

Request body

Choix de l'affranchissement pour votre publipostage, qui déterminera les services (suivi du courrier, preuve de distribution) ainsi que le délai de distribution. <ul> <li>lrar : lettre recommandée avec accusé de réception (suivi courrier + retour d'un bordereau prouvant la distribution au destinataire, J+3).</li> <li>lr : lettre recommandée simple (suivi courrier mais pas de bordereau de retour, J+3).</li> <li>verte : Lettre verte (J+3)</li> <li>vertesuivi : Lettre verte avec option suivi (J+3)</li> <li>ecopli : Lettre simple ecopli (J+4)</li> <li>performance : Lettre performance (J+2)</li> <li>perfsuivi : Lettre performance avec option suivi (J+2)</li> </ul> Veuillez noter qu'en fonction du pays passé en paramètres (voir plus bas), le mode d'affranchissement en équivalent international sera utilisé (lettre performance internationale si le type d'affranchissement n'intègre pas le suivi, lettre recommandée internationale sinon)

type_enveloppestring

Il n'est plus nécessaire de transmettre ce paramètre. Le format de l'enveloppe est calculé par l'API en fonction du nombre de feuilles : <ul> <li>Pour une lettre avec moins de 5 feuilles, l'enveloppe est au format C6</li> <li>Pour une lettre avec moins de 9 feuilles, l'enveloppe est au format C5</li> <li>Pour une lettre avec 9 feuilles et plus, l'enveloppe est au format C4</li> </ul>

couleur'nb' | 'couleur'

Couleur d'impression de vos courriers : noir et blanc ou bien couleur. Veuillez noter que ce choix concerne l'ensemble de vos courriers (nous ne pouvons pas imprimer le document principal en couleur et les annexes en noir et blanc)

recto_verso'recto' | 'rectoverso'

Mode d'impression de vots courriers : dans le cas d'une impression recto, le côté verso de chaque feuille sera laissé vierge. Bien sûr, pour des questions écologiques 🌱 (et économiques ! €€), nous vous invitons autant que possible à utiliser l'option recto-verso, qui permettra de réduire le nombre total de feuilles, et donc le poids ainsi que le prix. Veuillez noter que à l'heure actuelle, ce choix concerne l'ensemble des courriers de votre publipostage (nous ne pouvons pas imprimer le document principal en recto et les annexes en recto-verso)

porte_adressetrue | false

Insertion (ou non) d'un porte-adresse, c'est à dire d'une feuille au début de chaque courrier, qui va venir porter l'adresse de votre destinataire (*). <ul> <li>Si vous choisissez de décliner cette option (valeur à false), les adresses seront surimprimées sur la première page de votre document principal, il faut donc vous assurer que l'espace dédié est libre sur cette première page, sans quoi certaines informations pourraient se retrouver masquées par le pavé adresse.</li> <li>Si vous choisissez cette option (valeur à true), nous ajouterons une feuille dédiée au début de chaque courrier, qui va venir porter l'adresse.</li> </ul> Si l'emplacement de l'adresse correspond à un espace vierge sur votre document, nous vous invitons à l'exploiter pour diminuer le poids du courrier (et donc les coûts). ( * ) voire les adresses (destinataire + expéditeur) dans le cas où vous auriez activé l'affichage de l'adresse expéditeur (voir l'option impression_expediteur du endpoint soumission d'un publipostage)

ar_scantrue | false

<table style='margin:0px;'><tr style='border-top:none'> <td style='border:none;padding-left:0px;'>Option correspondant à l'accusé de réception dématérialisé:</td> <td style='border:none;'><img src='../images/ARScanSmall.jpg' /></td> </tr></table> Cette option est disponible uniquement avec l'affranchissement LRAR vers la France ou l'international. Si vous mettez ce paramètre à true, au lieu que l'avis de distribution vous revienne physiquement, il est retourné vers nos services, scanné par nos soins. Dès cet instant, il apparaît dans votre espace client Service Postal sur notre site publipostage (rubrique "Mes Mailings"), mais vous pouvez également le récupérer en utilisant le endpoint <a href='/#tag/Lettres-en-nombre/paths/~1publipostages~1%7Buid%7D~1statut/get'>Statut de distribution</a>. Par défaut, si votre courrier est un LRAR et que vous omettez le paramètre, l'avis de passage vous reviendra physiquement à l'adresse expéditeur indiquée au moment de l'appel. <div class='toptip'> 💡 Un <a href='https://fr.wikipedia.org/wiki/Webhook' target='_blank'>webhook</a> est à votre disposition si vous voulez être tenus au courant en temps réel de la mise à disposition des avis de distribution dématérialisés. Ce webhook vous permet aussi d'être informé à chaque étape de la production et du dépôt en poste (pour tous les types de courriers) ainsi que des différentes étapes de distribution de vos courriers suivis, pour les types de courriers possédant un numéro de suivi (lettre recommandée avec ou sans accusé de réception, lettre verte suivie, lettre performance suivie). </div>

nb_courriersinteger required

Nombre de courriers que vous prévoyez d'envoyer. Veuillez noter qu'il s'agit bien du nombre de plis, pas d'un nombre de pages ou de feuilles que contient chaque pli.

nb_feuilles_courrierinteger required

Nombre de feuilles que contient chaque pli. Veuillez noter deux points : <ul> <li>qu'il s'agit bien d'un nombre de feuilles et non de pages</li> <li>l'ajout d'un porte adresse (voir option plus haut) rajoutera une feuille à chaque courrier</li> </ul>

paysstring

Pays de destination de vos envois. Si aucun pays n'est transmis, nous partons du principe qu'il s'agit d'un envoi national (France, donc).

Example request

{
  "type_affranchissement": "lrar",
  "couleur": "couleur",
  "nb_courriers": 100,
  "nb_feuilles_courrier": 2,
  "pays": "France"
}

Response

type_enveloppestring

Format d'enveloppe validé pour ce publipostage

serviceunknown

affranchissementunknown

totalunknown

Example response

{
  "type_enveloppe": "c6",
  "service": 188,
  "affranchissement": 566,
  "total": 754
}

Changes

No recorded changes to this operation across all 1 revision of this API.