2 - Lettres en nombre

Soumettre un publipostage déjà prêt

Soumission d'un publipostage préalablement généré de votre côté.

Si vous disposez d'un publipostage complet, c'est-à-dire contenant l'ensemble de vos courriers les uns à la suite des autres au sein d'un seul document PDF ou Word, vous pouvez passer par cet endpoint pour nous le soumettre. Cela implique que les adresses des destinataires soient déjà présentes sur la première page de chaque lettre, au bon emplacement au regard du type d'enveloppe que vous choisissez. Autrement dit : votre document doit être prêt à imprimer et à mettre sous pli par nos équipes de production, tel quel.

post/publipostages/fichiercomplet

Request

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

Request body

type_affranchissement'ecopli' | 'verte' | 'vertesuivi' | 'performance' | 'perfsuivi' required

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 des courriers : <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> A titre de rappel, le nombre de feuilles est calculé en fonction : <ul> <li>du nombre de pages</li> <li>du mode d'impression (recto ou recto-verso)</li> </ul>

nb_courriersunknown required

couleur'nb' | 'couleur'

Couleur d'impression de votre courrier : noir et blanc ou bien couleur. Veuillez noter que ce choix concerne l'ensemble de votre courrier (nous ne pouvons pas imprimer une partie en couleur et une autre en noir et blanc)

recto_verso'recto' | 'rectoverso'

Mode d'impression de votre courrier : 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. <div class='toptip' style='font-size:16px;'> 🗎 Lors de l'impression de votre publipostage, deux configurations sont disponibles sur nos imprimantes : recto et recto-verso; comme votre document sera imprimé en une seule passe, si vous demandez une impression recto verso et que chaque courrier contient un nombre impair de pages, il sera nécessaire que vous insériez une page blanche sur la dernière page de chaque courrier pour atteindre un nombre pair de pages (sans quoi le début du courrier suivant s'imprimera au verso de la dernière page du courrier précédent). </div>

impression_expediteurtrue | false

Cette option permet d'indiquer si vous souhaitez utiliser une enveloppe à simple fenêtre (valeur : false) ou à double fenêtre (valeur : true). Par défaut si vous ne précisez pas l'option, une enveloppe à double fenêtre sera utilisée. Le champ s'appelle impression_expéditeur car elle sert en général à faire apparaître l'adresse expéditeur, mais vous pouvez très bien vous en servir pour faire apparaître du branding, par exemple un logo, etc. Pour plus de détails sur les quotes des emplacements des fenêtres en fonction des tailles d'enveloppe, vous pouvez consulter <a href='enveloppes/index.html' target='_blank'> notre page</a> dédiée à ce sujet. Attention : veuillez noter que dans le cas d'une enveloppe au format c4 (courrier non plié), seule l'enveloppe à simple fenêtre est disponible

validation_autotrue | false

Si vous êtes confiant sur l'usage du endpoint de soumission et que vous souhaitez nous soumettre un publipostage directement, sans avoir besoin de le valider, vous pouvez forcer la validation automatique en passant le paramètre validation_auto à true. Veuillez noter toutefois que nous conseillons à tous nos clients de passer systématiquement par une phase de validation pour être certains de la forme finale de vos plis, cette option n'est qu'à votre disposition pour une facilité d'usage mais peut représenter un risque si vous n'êtes pas sûrs de ce que vous faites.

referencestring

Reference dossier ou client (50 caractères maximum). Champ libre qui vous permet de rattacher à un courrier * un identifiant provenant de vos services.

date_envoistring

Nos services (et donc, notre API également) permettent de planifier l'envoi de courriers à l'avance. Grâce à ce paramètre, vous pouvez nous indiquer le jour auquel nous déposerons votre publipostage en Poste. Format de date : AAAA-MM-JJ Example : 2023-06-30 <div class='toptip'> ⏰ Pour que votre publipostage parte ASAP, il suffit de ne PAS nous envoyer de paramètre date_envoi. Autrement dit : par défaut (sans précision de date) tous les courriers poussés sont pris en compte immédiatement. </div>

Example request

{
  "nb_pages_courrier": [
    [
      2,
      2,
      2,
      3,
      2
    ]
  ],
  "nb_courriers": 5,
  "impression_expediteur": true,
  "fichier": {
    "format": "pdf",
    "nom": "VoteParCorrespondance-Juillet-2023.pdf",
    "contenu_base64": "<Base64 doc. principal>"
  },
  "fichier_annexes": [
    {
      "contenu_base64": "<Base64 d'annexe>"
    }
  ]
}

Response

Opération réussie

codeinteger

Report du code correspondant à la réponse HTTP

messagestring

Détail de la réponse, correspondant au code de succès ou d'erreur

uidstring

Identifiant unique permettant d'accéder à des opérations ultérieures sur ce publipostage (suivi, etc.)

fichierstring

Lien URL pour accéder à votre fichier original

fichier_annexesstring[]

Tableau qui contient les liens URL pour accéder à chacun de vos annexes originales

lettresstring[]

Tableau d'UID des lettres. Seules les 500 premières lettres sont retournées. Le premier UID correspond au premier courrier de votre document, le second UID correspond au second courrier, etc.

serviceunknown

affranchissementunknown

totalunknown

Example response

{
  "code": 201,
  "message": "Votre publipostage a été créé avec succès",
  "uid": "p-a54bd707d6e3fb03a9b5333f582e9a57",
  "service": 39,
  "affranchissement": 95,
  "total": 134
}

Changes

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