URL

/plis

Type

GET

Description

Liste les plis. Il est possible de filtrer les envois suivant différents critères (voir les Paramètres d'URL).

Paramètre d'URL

Nom du paramètre Type DescriptionObligatoireValeur par défaut
statutIntUn des identifiants de statut :
  • "a_deposer" : À envoyer
  • "depose" : Déposé
  • "encours" : En cours
  • "distribue" : Distribué
  • "ar_recu" : AR Reçu
  • "incident" : Incident
  • "reclamation_demandee" : Réclamation ouverte
  • "reclamation_resolue_paiement" : Réclamation résolue : indemnisation La Poste
  • "reclamation_resolue_pli_retrouve" : Réclamation résolue : Pli retrouvé par La Poste
  • "pnd" : PND
  • "pnd_non_recu" : PND non reçu
  • "npai_non_recu" : NPAI non reçu
  • "pnd_recu" : PND reçu
  • "npai_recu" : NPAI reçu
  • "envoye" : Envoyé
Non
id_utilisateurIntIdentifiant d'un utilisateur.Non
startIntIndex de début d'enregistrement. Le nombre de plis par page est défini par le paramètre length.Non1
lengthIntNombre de plis par page.Non30
searchStringMot clé de recherche.Non
filterStringChamps dans lequel rechercher le mot clé. Si vide, le mot clé est recherché dans l'ensemble des champs.
  • numero : Numéro de suivi du pli.
  • reference : Descriptif de l'envoi ou référence du pli.
 		Non
periode[from]StringDate de début du dépôt, au format jj/mm/aaaa.Non
periode[to]StringDate de fin du dépôt, au format jj/mm/aaaa.Non
date_creation[from]StringDate de début de création, au format jj/mm/aaaa.Non
date_creation[to]StringDate de début de création, au format jj/mm/aaaa.Non
date_impression[from]StringDate de début d'impression, au format jj/mm/aaaa.Non
date_impression[to]StringDate de fin d'impression, au format jj/mm/aaaa.Non
stepIntUne des constantes :
  • 1 : À imprimer
  • 2 : À déposer
  • 3 : Déposé
Non

Réponse

Liste des propriétésExemple
Nom du paramètre Type DescriptionObligatoireValeur par défaut
plisArrayTableau d'objets pli.Non
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295

{
    "plis": [
        {
            "id": 1,
            "id_utilisateur": 1,
            "support": 1,
            "expediteur": {
                "raison_sociale": "UXEN UXENUXEN UXENUXEN UXENUXEN UXENUX",
                "nom": "EXPEDITEUR NOM EXPEDITEUR NOM EXPEDITE",
                "complement_voie": "EXPEDITEUR COMPLEMENT VOIE EXPEDITEUR",
                "voie": "26 RUE GEORGE SAND 26 RUE GEORGE SAND2",
                "boite_postale": "EXPEDITEUR BOITE POSTALEEXPEDITEUR BOI",
                "code_postale_commune": "75016 PARIS"
            },
            "destinataire": {
                "raison_sociale": "DEMO SAS DEMO SAS DEMO SAS DEMO SAS DE",
                "nom": "M DEMO JEANM DEMO JEANM DEMO JEANM DEM",
                "complement_voie": "DESTINATAIRE COMPLEMENT VOIE DESTINATA",
                "voie": "10 RUE DES LILAS10 RUE DES LILAS10 RUE",
                "boite_postale": "DESTINATAIRE BP DESTINATAIRE BP DESTIN",
                "code_postale_commune": "33000 BORDEAUX",
                "pays": "FRANCE"
            },
            "imputation": {
                "libelle": "1001-Informatique/1011-Dév/Utilisateur 2",
                "id_code_imputation": 1,
                "id_utilisateur_imputation": 2
            },
            "retour_ar": {
                "raison_sociale": "ADR RETOUR AR DEMO SAS DEMO SAS DEMO S",
                "nom": "ADR RETOUR AR M DEMO JEANM DEMO JEANM",
                "complement_voie": "ADR RETOUR AR DESTINATAIRE COMPLEMENT",
                "voie": "ADR RETOUR AR 10 RUE DES LILAS10 RUE D",
                "boite_postale": "ADR RETOUR AR DESTINATAIRE BP DESTINAT",
                "code_postale_commune": "33000 BORDEAUX"
            },
            "reference": "DESC\nRéf du 1er pli",
            "options": 5,
            "poids": 0,
            "statut_libelle_general": null
        },
        {
            "id": 2770635,
            "id_utilisateur": 6692,
            "support": 1,
            "expediteur": {
                "raison_sociale": "UXEN UXENUXEN UXENUXEN UXENUXEN UXENUX",
                "nom": "EXPEDITEUR NOM EXPEDITEUR NOM EXPEDITE",
                "complement_voie": "EXPEDITEUR COMPLEMENT VOIE EXPEDITEUR",
                "voie": "26 RUE GEORGE SAND 26 RUE GEORGE SAND2",
                "boite_postale": "EXPEDITEUR BOITE POSTALEEXPEDITEUR BOI",
                "code_postale_commune": "75016 PARIS"
            },
            "destinataire": {
                "raison_sociale": "DEMO SAS DEMO SAS DEMO SAS DEMO SAS DE",
                "nom": "M DEMO JEANM DEMO JEANM DEMO JEANM DEM",
                "complement_voie": "DESTINATAIRE COMPLEMENT VOIE DESTINATA",
                "voie": "10 RUE DES LILAS10 RUE DES LILAS10 RUE",
                "boite_postale": "DESTINATAIRE BP DESTINATAIRE BP DESTIN",
                "code_postale_commune": "33000 BORDEAUX",
                "pays": "FRANCE"
            },
            "imputation": {
                "libelle": "Utilisateur 1",
                "id_code_imputation": 0,
                "id_utilisateur_imputation": 1
            },
	    "retour_ar": {
                "raison_sociale": "ADR RETOUR AR DEMO SAS DEMO SAS DEMO S",
                "nom": "ADR RETOUR AR M DEMO JEANM DEMO JEANM",
                "complement_voie": "ADR RETOUR AR DESTINATAIRE COMPLEMENT",
                "voie": "ADR RETOUR AR 10 RUE DES LILAS10 RUE D",
                "boite_postale": "ADR RETOUR AR DESTINATAIRE BP DESTINAT",
                "code_postale_commune": "33000 BORDEAUX"
            },
            "numero": "2C00000003193",
            "reference": "",
            "options": 5,
            "poids": 0,
            "statut_libelle_general": "AR Reçu",
            "suivi": [
                {
                    "date": "2014-06-06T23:00:00+02:00",
                    "detail": "Distribué (920600 LE PLESSIS ROBINSON)"
                },
                {
                    "date": "2014-05-28T23:00:00+02:00",
                    "detail": "Attend d'être retiré au guichet (920600 LE PLESSIS ROBINSON)"
                },
                {
                    "date": "2014-05-27T23:00:00+02:00",
                    "detail": "Pli présenté (920870 LE PLESSIS ROBINSON PDC1)"
                },
                {
                    "date": "2014-05-27T22:59:59+02:00",
                    "detail": "En cours de traitement (920870 LE PLESSIS ROBINSON PDC1)"
                },
                {
                    "date": "2014-05-26T23:00:00+02:00",
                    "detail": "Départ (951140 GONESSE PARIS NORD PIC)"
                },
                {
                    "date": "2014-05-26T22:59:59+02:00",
                    "detail": "Pris en charge (752265 PARIS LA TREMOILLE APV)"
                },
                {
                    "date": "2014-04-14T12:27:56+02:00",
                    "detail": "AR Reçu"
                }
            ]
        },
        {
            "id": 2770631,
            "id_utilisateur": 6692,
            "support": 1,
            "expediteur": {
                "raison_sociale": "UXEN UXENUXEN UXENUXEN UXENUXEN UXENUX",
                "nom": "EXPEDITEUR NOM EXPEDITEUR NOM EXPEDITE",
                "complement_voie": "EXPEDITEUR COMPLEMENT VOIE EXPEDITEUR",
                "voie": "26 RUE GEORGE SAND 26 RUE GEORGE SAND2",
                "boite_postale": "EXPEDITEUR BOITE POSTALEEXPEDITEUR BOI",
                "code_postale_commune": "75016 PARIS"
            },
            "destinataire": {
                "raison_sociale": "DEMO SAS DEMO SAS DEMO SAS DEMO SAS DE",
                "nom": "M DEMO JEANM DEMO JEANM DEMO JEANM DEM",
                "complement_voie": "DESTINATAIRE COMPLEMENT VOIE DESTINATA",
                "voie": "10 RUE DES LILAS10 RUE DES LILAS10 RUE",
                "boite_postale": "DESTINATAIRE BP DESTINATAIRE BP DESTIN",
                "code_postale_commune": "33000 BORDEAUX",
                "pays": "FRANCE"
            },
            "imputation": {
                "libelle": "Utilisateur 2",
                "id_code_imputation": 0,
                "id_utilisateur_imputation": 6692
            },
	    "retour_ar": {
                "raison_sociale": "ADR RETOUR AR DEMO SAS DEMO SAS DEMO S",
                "nom": "ADR RETOUR AR M DEMO JEANM DEMO JEANM",
                "complement_voie": "ADR RETOUR AR DESTINATAIRE COMPLEMENT",
                "voie": "ADR RETOUR AR 10 RUE DES LILAS10 RUE D",
                "boite_postale": "ADR RETOUR AR DESTINATAIRE BP DESTINAT",
                "code_postale_commune": "33000 BORDEAUX"
            },
            "numero": "2C00000003292",
            "reference": "DESCRIPTION DESCRIPTION DESCRIPTION \nTEST Utilisateur",
            "options": 5,
            "poids": 0,
            "statut_libelle_general": "Distribué",
            "suivi": [
                {
                    "date": "2014-05-27T23:00:00+02:00",
                    "detail": "Distribué (752290 PARIS 17 PDC1)"
                },
                {
                    "date": "2014-05-27T22:59:59+02:00",
                    "detail": "En cours de traitement (752290 PARIS 17 PDC1)"
                },
                {
                    "date": "2014-05-26T23:00:00+02:00",
                    "detail": "Départ (951140 GONESSE PARIS NORD PIC)"
                },
                {
                    "date": "2014-05-26T22:59:59+02:00",
                    "detail": "Pris en charge (752265 PARIS LA TREMOILLE APV)"
                }
            ]
        },
        {
            "id": 2770632,
            "id_utilisateur": 6692,
            "support": 1,
            "expediteur": {
                "raison_sociale": "UXEN UXENUXEN UXENUXEN UXENUXEN UXENUX",
                "nom": "EXPEDITEUR NOM EXPEDITEUR NOM EXPEDITE",
                "complement_voie": "EXPEDITEUR COMPLEMENT VOIE EXPEDITEUR",
                "voie": "26 RUE GEORGE SAND 26 RUE GEORGE SAND2",
                "boite_postale": "EXPEDITEUR BOITE POSTALEEXPEDITEUR BOI",
                "code_postale_commune": "75016 PARIS"
            },
            "destinataire": {
                "raison_sociale": "DEMO SAS DEMO SAS DEMO SAS DEMO SAS DE",
                "nom": "M DEMO JEANM DEMO JEANM DEMO JEANM DEM",
                "complement_voie": "DESTINATAIRE COMPLEMENT VOIE DESTINATA",
                "voie": "10 RUE DES LILAS10 RUE DES LILAS10 RUE",
                "boite_postale": "DESTINATAIRE BP DESTINATAIRE BP DESTIN",
                "code_postale_commune": "33000 BORDEAUX",
                "pays": "FRANCE"
            },
            "imputation": {
                "libelle": "Utilisateur 2",
                "id_code_imputation": 0,
                "id_utilisateur_imputation": 6692
            },
	    "retour_ar": {
                "raison_sociale": "ADR RETOUR AR DEMO SAS DEMO SAS DEMO S",
                "nom": "ADR RETOUR AR M DEMO JEANM DEMO JEANM",
                "complement_voie": "ADR RETOUR AR DESTINATAIRE COMPLEMENT",
                "voie": "ADR RETOUR AR 10 RUE DES LILAS10 RUE D",
                "boite_postale": "ADR RETOUR AR DESTINATAIRE BP DESTINAT",
                "code_postale_commune": "33000 BORDEAUX"
            },
            "numero": "2C00000003391",
            "reference": "",
            "options": 5,
            "poids": 0,
            "statut_libelle_general": "Distribué",
            "suivi": [
                {
                    "date": "2014-05-27T23:00:00+02:00",
                    "detail": "Distribué (752290 PARIS 17 PDC1)"
                },
                {
                    "date": "2014-05-27T22:59:59+02:00",
                    "detail": "En cours de traitement (752290 PARIS 17 PDC1)"
                },
                {
                    "date": "2014-05-26T23:00:00+02:00",
                    "detail": "Départ (951140 GONESSE PARIS NORD PIC)"
                },
                {
                    "date": "2014-05-26T22:59:59+02:00",
                    "detail": "Pris en charge (752265 PARIS LA TREMOILLE APV)"
                }
            ]
        },
        {
            "id": 2770638,
            "id_utilisateur": 6692,
            "support": 1,
            "expediteur": {
                "raison_sociale": "UXEN UXENUXEN UXENUXEN UXENUXEN UXENUX",
                "nom": "EXPEDITEUR NOM EXPEDITEUR NOM EXPEDITE",
                "complement_voie": "EXPEDITEUR COMPLEMENT VOIE EXPEDITEUR",
                "voie": "26 RUE GEORGE SAND 26 RUE GEORGE SAND2",
                "boite_postale": "EXPEDITEUR BOITE POSTALEEXPEDITEUR BOI",
                "code_postale_commune": "75016 PARIS"
            },
            "destinataire": {
                "raison_sociale": "DEMO SAS DEMO SAS DEMO SAS DEMO SAS DE",
                "nom": "M DEMO JEANM DEMO JEANM DEMO JEANM DEM",
                "complement_voie": "DESTINATAIRE COMPLEMENT VOIE DESTINATA",
                "voie": "10 RUE DES LILAS10 RUE DES LILAS10 RUE",
                "boite_postale": "DESTINATAIRE BP DESTINATAIRE BP DESTIN",
                "code_postale_commune": "33000 BORDEAUX",
                "pays": "FRANCE"
            },
            "imputation": {
                "libelle": "Utilisateur 2",
                "id_code_imputation": 0,
                "id_utilisateur_imputation": 6692
            },
	    "retour_ar": {
		"raison_sociale": "SAS DEMO 5",
		"nom": "ADR RETOUR AR",
		"complement_voie": "ADR RETOUR AR DESTINATAIRE COMPLEMENT_",
		"voie": "ADR RETOUR AR 10 RUE DES LILAS 10 RUE",
		"boite_postale": "ADR RETOUR AR DESTINATAIRE BP DESTINAT",
		"code_postale_commune": "33000 BORDEAUX"
	    },
            "numero": "2c00000004190",
            "reference": "",
            "options": 5,
            "poids": 0,
            "statut_libelle_general": "PND",
            "suivi": [
                {
                    "date": "2014-12-03T15:33:23+01:00",
                    "detail": "PND"
                },
                {
                    "date": "2014-06-21T23:00:00+02:00",
                    "detail": "Retourné à l'expéditeur (931270 VILLETANEUSE PDC1)"
                },
                {
                    "date": "2014-06-21T22:59:59+02:00",
                    "detail": "En cours de traitement (931270 VILLETANEUSE PDC1)"
                },
                {
                    "date": "2014-06-20T23:00:00+02:00",
                    "detail": "Départ (951140 GONESSE PARIS NORD PIC)"
                },
                {
                    "date": "2014-06-20T22:59:59+02:00",
                    "detail": "Pris en charge (752265 PARIS LA TREMOILLE APV)"
                },
                {
                    "date": "2014-04-26T23:00:00+02:00",
                    "detail": "Distribué (699200 LYON  SULLY)"
                }
            ]
        }
    ]
}