1 - Lettres unitaires

Valider une lettre

Validation d'une lettre précédemment prévisualisée.

Comme évoqué dans la section dédiée à la prévisualisation, la validation ne concerne que les courriers qui ont été dans un premier temps prévisualisés. Pour valider, il suffit de passer dans l'url l'UID de la lettre, sous la forme :

/lettres/l-7893d696b6770d8fa7ed29cd0b8d01ba/valider

Valider une lettre fait basculer son statut de commande potentielle à une commande définitive. Un cycle de prévisualisation puis validation correspond donc en termes de commande à un envoi immédiat; à l'arrivée le résultat est strictement identique, mais dans le premier cas vous avez possibilité de consulter le prix et l'aspect du document avant de valider sa commande.

Les deux paramètres présents dans le corps de la requête (décrits ci-dessous) sont facultatifs, vous pouvez très bien valider avec un body vide - ceci dit il doit au moins contenir une accolade ouvrante et fermante, pour que le format JSON soit respecté.

post/lettres/{uid}/valider

Request

  • Base URL: https://sandbox-api.servicepostal.com
  • URL: https://sandbox-api.servicepostal.com/lettres/{uid}/valider
  • Auth: none declared

Request body

date_envoistring

Date à laquelle vous souhaitez que votre courrier soit déposé dans le circuit de distribution de La Poste, au format AAAA-MM-JJ. Si le paramètre n'est pas transmis, le courrier partira ASAP (c'est-à-dire le jour même, si soumis avant 17h30)

referencestring

Reference dossier ou client (50 caractères maximum). Champ libre qui vous permet de rattacher à un courrier un identifiant provenant de vos services. Cet élément apparaîtra sur l'avis de distribution dans le cas d'un envoi LRAR.

Example request

{
  "date_envoi": "2023-05-31",
  "reference": "Dossier n°12346"
}

Response

Opération réussie

uidstring

L'identifiant unique ("Unique ID") généré par nos systèmes et associé à votre courrier. Vous pouvez utiliser cet identifiant plus tard, par exemple pour demander son numéro de suivi, ou bien suivre son état de distribution. A transmettre également au endpoint de validation lorsque vous souhaitez confirmer la commande d'un courrier que vous avez préalablement visualisé.

type_enveloppe'c4' | 'c5' | 'c6'

Si vous avez choisi "auto" comme type d'enveloppe dans votre requête, ce paramètre vous permet de savoir quel format d'enveloppe a été retenu par le moteur de l'API. En fonction du nombre de feuilles que contient votre courrier, le choix de certaines enveloppes sera impossible.

enveloppe'fenetre' | 'imprime'
type_affranchissement'lrar' | 'lr' | 'suivi' | 'verte' | 'vertesuivi' | 'ecopli' | 'performance' | 'perfsuivi'
couleur'nb' | 'couleur'
recto_verso'recto' | 'rectoverso'
placement_adresse'premiere_page' | 'insertion_page_adresse'
surimpression_adresses_documentboolean
impression_expediteurboolean
ar_scanboolean
ar_expediteur_champ1string
ar_expediteur_champ2string
nom_entitestring

Entité Service postal pour facture analytique en lettres majuscules UNIQUEMENT

nom_dossierstring

Nom du dossier pour facture analytique (50 caractères maximum)

nom_sousdossierstring

Nom du sous-dossier pour facture analytique (100 caractères maximum)

date_envoistring
referencestring

Reference client (50 caractères maximum)

code_barreboolean
affranchissementstring

Prix de l'affranchissement, hors taxes. Pour information il n'y a pas de TVA sur l'affranchissement donc dans l'absolu, ce montant correspond également au prix TTC.

servicestring

Prix du service (hébergement des données et documents dans le cloud, papiers, encres, enveloppes, dépôt quotidien dans le circuit de distribution de La Poste), hors taxes. Si vous êtes détenteur d'un abonnement chez Service Postal, une réduction s'applique sur le montant du service; ce prix inclut donc une telle réduction le cas échéant. Si vous voulez connaître nos offres d'abonnement, n'hésitez pas à les consulter notre site <a href='https://www.servicepostal.com/lettre-en-ligne/entreprises/#tarifs_offers' target='_blank'><b>Service Postal</b></a>. <br/> Pour obtenir un montant TTC, la TVA sur le service est de 20 % (à rajouter donc, si vous souhaitez un montant TTC)

totalstring

Coût total de votre courrier HT = prix de l'affranchissement HT + prix du service HT

affranchissement_basestring

Prix <b>public</b> (non abonné) de l'affranchissement, hors taxes.

service_basestring

Prix <b>public</b> (non abonné) du service (hébergement des données et documents dans le cloud, papiers, encres, enveloppes, dépôt quotidien dans le circuit de distribution de La Poste), hors taxes. Pour obtenir un montant TTC, la TVA sur le service est de 20 % (à rajouter donc, si vous souhaitez un montant TTC)

total_basestring

Coût total <b>public</b> (non abonné) de votre courrier HT = prix de l'affranchissement HT + prix du service HT

Example response

{
  "uid": "l-3fe173a7820bbcb1d78f854eb1cc2738",
  "type_enveloppe": "c5",
  "enveloppe": "fenetre",
  "adresse_expedition": {
    "civilite": "M.",
    "prenom": "Jacques",
    "nom": "Martin",
    "nom_societe": "JM Productions",
    "adresse_ligne1": "12 rue du Gai Vigneron",
    "adresse_ligne2": "Bâtiment C",
    "code_postal": "33000",
    "ville": "BORDEAUX",
    "pays": "FRANCE"
  },
  "adresse_destination": {
    "civilite": "M.",
    "prenom": "Léon",
    "nom": "Zitrone",
    "nom_societe": "ORTF",
    "adresse_ligne1": "66 avenue des Champs Elysées",
    "adresse_ligne2": "Service secrétariat général",
    "code_postal": "75008",
    "ville": "PARIS",
    "pays": "FRANCE"
  },
  "fichier": {
    "url": "https://sandbox-example-file.servicepostal.com/c456984a48ed710f6a62dcb78dd65e89_01-01-2666.pdf"
  },
  "variables": {
    "reference_client": "CL-06310/07",
    "numero_facture": "FC-06310-2212",
    "civilite": "Monsieur",
    "prenom": "Léon",
    "nom": "Zitrone"
  },
  "fichier_annexes": [
    {
      "url": "https://sandbox-example-file.servicepostal.com/0b6a550f495f9d38500c4af1f3a5a1c0_01-01-2666.pdf"
    }
  ],
  "type_affranchissement": "lrar",
  "couleur": "nb",
  "recto_verso": "rectoverso",
  "placement_adresse": "insertion_page_adresse",
  "surimpression_adresses_document": true,
  "ar_scan": true,
  "ar_expediteur_champ1": "Référence : CL-06310/07",
  "ar_expediteur_champ2": "Facture : FC-06310-2212",
  "code_barre": true,
  "affranchissement": "6.15",
  "service": "2.47",
  "total": "8.62",
  "affranchissement_base": "6.15",
  "service_base": "2.47",
  "total_base": "8.62"
}

Changes

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