URL

/envois

Type

POST

Description

Créé un envoi de plis.

Paramètre d'URL

Nom du paramètre Type DescriptionObligatoireValeur par défaut
imprimer_referenceIntPour imprimer la référence sur le support d'impression, passez cette valeur à 1Non
supportIntSupports d'impression pour le Lettre Suivie :
  • 2 : Insert A4 (PDF)
  • 4  : Planche d'étiquettes (PDF)
  • 16 : Étiquette 10x5 (PDF)
  • 32  : Étiquette 10x15 cm (PDF)
  • 64 : Étiquette 10x15 cm ZPL 200dpi
  • 128 : Étiquette 10x15 cm ZPL 300dpi
Supports d'impression pour le Lettre Expert :
  • 2 : Insert A4 (PDF)
  • 4  : Planche d'étiquettes (PDF)
  • 16 : Étiquette 10x5 (PDF)
Non
positionIntPosition de l'étiquette pour les supports :
  • Delivengo sans AR : de 1 à 3.
  • Lettre Suivie : de 1 à 12.
  • Lettre Expert : de 1 à 12.
Non

Requête

DescriptionListe des propriétésExemple
Les informations de l'envoi sont retournées sous forme JSON. Si l'entête "Accept" est définie à "application/pdf", le support d'impression et le document douanier au format PDF peuvent être ajoutés aux informations en Base64, en plus de l'id_envois ("id") et des id_plis (plis). Si l'entête "Accept" est définie à "application/zpl", le support d'impression au format ZPL 200dpi peut être ajouté aux informations en Base64, en plus de l'id_envois ("id") et des id_plis (plis).
Nom du paramètre Type DescriptionObligatoireValeur par défaut
id_utilisateurIntId de l'utilisateur créateur de l'envoiOui
id_supportIntType de support des plis créés.
  • 1 : Recommandé national avec AR avec CAB
  • 2 : Recommandé national sans AR avec CAB
  • 3 : Recommandé international avec AR avec CAB
  • 4 : Recommandé national avec AR sans CAB
  • 5 : Recommandé national sans AR sans CAB
  • 6 : Recommandé international sans AR avec CAB
  • 7 : Recommandé international sans AR sans CAB
  • 8 : Recommandé international avec AR sans CAB
  • 9 : Lettre Suivie sans CAB
  • 10 : Lettre Expert sans CAB
Oui
descriptifString(255)Description de l'envoi.Non
plisArrayTableau d'objet EnvoiPli.Oui
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

{
  "data": {
    "id_utilisateur": 123456,
    "id_support": 4,
    "descriptif": "DESCRIPTIF",
    "plis": [
      {
        "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"
        },
        "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"
        },
        "destinataire_email": "jean.reneau@test.fr",
        "reference": "Réf du 1er pli",
        "options": 1
 
      }
    ]
  }
}

Réponse

DescriptionListe des propriétésExemple
Les données de la requête peuvent avoir été modifiées (par exemple, les adresses sont normalisée). La réponse est identique à l'API GET /envois/{ID ENVOI}. Référez vous à la document de GET /envois/{ID ENVOI} pour le détail de la réponse.
Nom du paramètre Type DescriptionObligatoireValeur par défaut
envoiObjetObjet envoi.Non
documents_supportsStringDocument pdf en Base64 (seulement si l'entête Accept est à "application/pdf") Document zpl en Base64 (seulement si l'entête Accept est à "application/zpl")Non
documents_douaniersStringDocument pdf en Base64 (seulement si l'entête Accept est à "application/pdf")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

{
  "data": {
    "id": 1,
    "id_utilisateur": 1,
    "date_creation": "2016-10-19 12:29:56",
    "date_impression": null,
    "id_support": 33,
    "descriptif": "DESCRIPTIF",
    "plis": [
      {
        "id": 1,
        "support": {
          "id": 4,
          "nom": "avec AR sans CAB",
          "nom_long": "Recommandé avec AR sans code à barres",
          "code": "AR"
        },
        "date_depot": null,
        "createur": {
          "id": 1,
          "nom": "Utilisateur 1",
          "email": "utilisateur1@test.fr"
        },
        "numero": "",
        "reference": "",
        "reference_interne": "DESCRIPTIF",
        "options": "6",
        "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"
        },
        "retour_ar": {
          "raison_sociale": null,
          "nom": null,
          "complement_voie": null,
          "voie": null,
          "boite_postale": null,
          "code_postal_commune": "",
          "pays": ""
        },
        "documents_douaniers": [],
        "tracking": {
          "url": null,
          "api_key": null
        },
        "statut": {
          "id": "0",
          "libelle": "Préparation",
          "date": null
        },
        "data": []
      }
    ]
  }
}