URL

/envois

Type

GET

Description

Liste les envois. 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
stepStringUne des constantes :
  • 1 : à imprimer
  • 2 : imprimé
Non
id_utilisateurIntIdentifiant d'un utilisateur.Non
lengthIntNombre d'envois à retourner.Non30
startIntIndex de début d'enregistrement.Non0
qStringMot clé de recherche.Non
fStringChamps dans lequel rechercher le mot clé. Si vide, le mot clé est rechercher dans l'ensemble des champs.
  • imputation : Chaîne d'imputation.
  • expediteur : Adresse de l'expéditeur de l'envoi.
  • destinataire : Adresse du destinataire d'un pli.
  • reference : Descriptif de l'envoi ou référence d'un pli.
Non
periode[from]StringDate de début, au format jj/mm/aaaa.Non
periode[to]StringDate de fin, au format jj/mm/aaaaNon
supportIntFiltre sur le type de support.
  • 60 : Delivengo Easy
Non
columnStringTrier le résultat par date de création, nombre de plis ou descriptif. Constantes :
  • date_creation
  • total
  • descriptif
Nondate_creation
orderStringTrier par ordre croissant ou décroissant. Constantes :
  • ASC
  • DESC
NonASC

Réponse

DescriptionListe des propriétésExemple
Tableau des envois répondant aux critères de recherche et de filtre.
Nom du paramètre Type DescriptionObligatoireValeur par défaut
idIntId de l'envoi.Non
id_utilisateurIntIdentifiant de l'utilisateur ayant créé l'envoi.Non
date_creationStringDate de création de l'envoi, au format AAAA-MM-JJ HH:MM:SS.Non
date_impressionStringDate d'impression de l'envoi, au format AAAA-MM-JJ HH:MM:SS. Si vide, alors l'envoi est en attente d'impression.Non
plisArrayTableau des identifiant des plis de l'envoi.Non
id_supportIntConstantes des supports :
  • 60 : Delivengo Easy
Non
{
    "data": [
        {
            "id": 1,
            "id_support": "60",
            "id_utilisateur": 1,
            "date_creation": "2014-02-07 09:35:35",
            "date_impression": "2014-02-07 09:36:23",
            "descriptif": "",
            "plis": [
                1,
		2,
		3,
		4,
		5
            ]
        },
        {
            "id": 2,
            "id_support": "60",
            "id_utilisateur": 1,
            "date_creation": "2014-02-07 09:37:53",
            "date_impression": "2014-02-12 14:21:18",
            "descriptif": "",
            "plis": [
                6,
		7,
		8,
		9
            ]
        },
        {
            "id": 3,
            "id_support": "60",
            "id_utilisateur": 1,
            "date_creation": "2014-02-07 09:37:53",
            "date_impression": "2014-02-12 14:21:18",
            "descriptif": "",
            "plis": [
                10
            ]
        },
        {
            "id": 4,
            "id_support": "60",
            "id_utilisateur": 1,
            "date_creation": "2014-02-07 09:37:53",
            "date_impression": "2014-02-12 14:21:18",
            "descriptif": "",
            "plis": [
                11
            ]
        }
    ]
}