Lister les plis.
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 | Description | Obligatoire | Valeur par défaut |
|---|---|---|---|---|
| statut | String | Un des identifiants de statut :
| Non | |
| id_utilisateur | Int | Identifiant d'un utilisateur. | Non | |
| start | Int | Numéro de page à afficher. Le nombre de plis par page est défini par le paramètre max. | Non | 1 |
| length | Int | Nombre de plis par page. | Non | 30 |
| search | String | Mot clé de recherche. | Non | |
| filter | String | Champs dans lequel rechercher le mot clé. Si vide, le mot clé est rechercher dans l'ensemble des champs.
| Non | |
| periode[from] | String | Date de début du dépôt, au format jj/mm/aaaa. | Non | |
| periode[to] | String | Date de fin du dépôt, au format jj/mm/aaaa. | Non | |
| step | Int | Une des constantes :
| Non |
Réponse
Liste des propriétésExemple
| Nom du paramètre | Type | Description | Obligatoire | Valeur par défaut |
|---|---|---|---|---|
| data | Array | Tableau d'objets pli. | Non |
{
"data": [
{
"id": 1,
"support": {
"id": 60,
"nom": "Delivengo Easy",
"nom_long": "Delivengo Easy",
"code": "DELIVENGOEASY",
"classname": "DelivengoEasy"
},
"date_depot": null,
"createur": {
"id": 123456,
"nom": "Utilisateur 1",
"email": "utilisateur1@test.fr"
},
"numero": "",
"reference": "",
"reference_interne": "DESCRIPTIF DELIVENGO EASY\n",
"options": "69",
"date_retour_ar": null,
"imputation": {
"libelle": "Utilisateur 1",
"id_code_imputation": 0,
"id_utilisateur_imputation": 123456
},
"expediteur": {
"raison_sociale": "EXPEDITEUR RAISON SOCIALE",
"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_postal_commune": "75016 PARIS",
"pays": ""
},
"destinataire": {
"raison_sociale": "DESTINATAIRE 1",
"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_postal_commune": "75016 PARIS",
"pays": "ÉTATS-UNIS"
},
"retour_ar": {
"raison_sociale": null,
"nom": null,
"complement_voie": null,
"voie": null,
"boite_postale": null,
"code_postal_commune": "",
"pays": ""
},
"documents_douaniers": {
"envoi_commercial": 1,
"envoi_nature": [
1,
2,
3
],
"observation": "Observation",
"num_licence": "123",
"num_certificat": "321",
"num_facture": "123",
"frais_port": "1.00",
"quantite_total": 3,
"poids_total": "150.00",
"valeur_dts": 3.9473684106648,
"valeur_total": "5.00",
"facture_fichier": false,
"articles": [
{
"code_article": null,
"description_detaillee": "Article 1",
"quantite": "1",
"valeur": "1.00",
"poids": "50.00",
"pays_origine": "FRANCE",
"num_tarifaire": "654123"
},
{
"code_article": null,
"description_detaillee": "Article 2",
"quantite": "2",
"valeur": "2.00",
"poids": "50.00",
"pays_origine": "FRANCE",
"num_tarifaire": "123451"
}
]
},
"tracking": {
"url": null,
"api_key": null
},
"statut": {
"id": "0",
"libelle": "Préparation",
"date": null
},
"data": {
"emails_notifications_suivi": [],
"email_destinataire": "jean.reneau@test.fr",
"reference": "",
"envoiNotification": "0",
"poids": 100,
"preciser_notifications": "0"
}
},
{
"id": 2,
"support": {
"id": 60,
"nom": "Delivengo Easy",
"nom_long": "Delivengo Easy",
"code": "DELIVENGOEASY",
"classname": "DelivengoEasy"
},
"date_depot": null,
"createur": {
"id": 123456,
"nom": "Utilisateur 1",
"email": "utilisateur1@test.fr"
},
"numero": "",
"reference": "",
"reference_interne": "DESCRIPTIF DELIVENGO EASY\n",
"options": "69",
"date_retour_ar": null,
"imputation": {
"libelle": "Utilisateur 1",
"id_code_imputation": 0,
"id_utilisateur_imputation": 123456
},
"expediteur": {
"raison_sociale": "EXPEDITEUR RAISON SOCIALE",
"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_postal_commune": "75016 PARIS",
"pays": ""
},
"destinataire": {
"raison_sociale": "DESTINATAIRE 1",
"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_postal_commune": "75016 PARIS",
"pays": "ÉTATS-UNIS"
},
"retour_ar": {
"raison_sociale": null,
"nom": null,
"complement_voie": null,
"voie": null,
"boite_postale": null,
"code_postal_commune": "",
"pays": ""
},
"documents_douaniers": {
"envoi_commercial": 1,
"envoi_nature": [
1,
2,
3
],
"observation": "Observation",
"num_licence": "123",
"num_certificat": "321",
"num_facture": "123",
"frais_port": "1.00",
"quantite_total": 3,
"poids_total": "150.00",
"valeur_dts": 3.9473684106648,
"valeur_total": "5.00",
"facture_fichier": false,
"articles": [
{
"code_article": null,
"description_detaillee": "Article 1",
"quantite": "1",
"valeur": "1.00",
"poids": "50.00",
"pays_origine": "FRANCE",
"num_tarifaire": "654123"
},
{
"code_article": null,
"description_detaillee": "Article 2",
"quantite": "2",
"valeur": "2.00",
"poids": "50.00",
"pays_origine": "FRANCE",
"num_tarifaire": "123451"
}
]
},
"tracking": {
"url": null,
"api_key": null
},
"statut": {
"id": "0",
"libelle": "Préparation",
"date": null
},
"data": {
"emails_notifications_suivi": [],
"email_destinataire": "jean.reneau@test.fr",
"reference": "",
"envoiNotification": "0",
"poids": 100,
"preciser_notifications": "0"
}
}
]
}