2 - Lettres en nombre

Statut de distribution

Consultez dans le détail le statut de votre publipostage en termes de distribution; Bien sûr ce endpoint n'est disponible que pour les types de courriers applicables, c'est à dire : LR, LRAR, Lettre verte suivie, Lettre performance suivie.

En début de réponse, vous trouverez des informations globales au publipostage :

  • Pour rappel, l'UID de votre publipostage
  • Nombre total de courriers contenus dans le publipostage
  • Nombre total de courriers ayant été distribués à leur destinataire
  • Pourcentage de distribution (simple règle de trois basée sur les deux précédents nombres, mais qui permet de vous donner une vision immédiate et temps réel de l'état de distribution global de votre publipostage)

Pour chacune des lettres en fonction de son état, vous aurez :

  • L'UID de la lettre

  • Le numéro de suivi La Poste

  • Le statut de distribution au destinataire

  • Si vous avez souscrit à l'option AR scanné : le lien vers l'accusé de réception scanné par nos services (si la distribution a bien eu lieu) ou bien le scan du courrier tel que retourné par La Poste dans le cas d'un PND (Pli Non Distribué). Dans ce dernier cas vous verrez l'étiquette collée par le facteur indiquant le motif de non distribution :

    pnd pnd

  • La date du scan de l'AR (ou du courrier dans le cas des PND)

  • L'indication PND (flag à true). Lorsqu'un courrier non distribué nous revient, il est scanné par nos équipes de production.

get/publipostages/{uid}/statut

Request

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

Response

Opération réussie

uidstring
nb_totalunknown
nb_distribueunknown
pourcentage_distributionunknown

Example response

{
  "uid": "p-012345678931732b4b564d9876543210",
  "nb_total": 271,
  "nb_distribue": 215,
  "pourcentage_distribution": 79.34,
  "evenements": [
    {
      "uid": "l-80c1403d-b059-4a58-844a-69487f9a055e",
      "numero_suivi_laposte": "2C15970133908",
      "distribue_destinataire": true,
      "arscan_url": "https://storage.gra.cloud.ovh.net/v1/AUTH_025cee92aa9a4dff87bd9afdc8a65f6c/sp-customer-files/3f2782b4469215789e0f468a65fb71a1.jpg"
    },
    {
      "uid": "l-19b357ef-dca6-41db-8ce8-124048568905",
      "numero_suivi_laposte": "2C15971134735",
      "pnd": true,
      "arscan_url": "https://storage.gra.cloud.ovh.net/v1/AUTH_025cee92aa9a4dff87bd9afdc8a65f6c/sp-customer-files/3f2782b4469215789e0f468a65fb71a2.jpg"
    },
    {
      "uid": "l-5b62a971-19de-437c-8439-21aa2928bbdd",
      "numero_suivi_laposte": "2C15971238954"
    },
    {
      "uid": "l-cc75081a-f7ff-4312-bfec-b430b2b1b6c5",
      "numero_suivi_laposte": "2C15971132561",
      "distribue_destinataire": true
    }
  ]
}

Changes

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