URL

/envois/{ID_ENVOI}

Type

GET

Description

Permet de récupérer toute les informations de l'envoi indiqué par {ID_ENVOI}. 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. Si l'entête est définie à "application/pdf", c'est le support d'impression au format PDF qui sera retourné. Si l'envoi était en attente d'impression, l'appel avec cette API avec l'entête "Accept : application/pdf" passera les plis en état "déposé".

Paramètre d'URL

Nom du paramètre Type DescriptionObligatoireValeur par défaut
supportIntSupports d'impression pour le Delivengo Easy :
  • 4 : Planche d'étiquettes
  • 32  : Étiquette 10x15
 		Non
positionIntPosition pour les supports :
  • Delivengo Easy (Planche d'étiquette) : de 1 à 4.
Non

Réponse

DescriptionListe des propriétésExemple
Suivant la valeur de l'entête HTTP "Accept", le retour est au format JSON ou PDF (supports d'impression des plis de l'envoi).
Nom du paramètre Type DescriptionObligatoireValeur par défaut
dataObjetOBJET envoiNon
documents_supportsStringDocument pdf des étiquettes en Base64 (seulement si l'entête Accept est à "application/pdf")Non
documents_douaniersStringDocument pdf des documents douaniers type CN23 en Base64 (seulement si l'entête Accept est à "application/pdf")Non
facturesStringDocument pdf en Base64 (seulement si l'entête Accept est à "application/pdf")Non
{
  "data": {
    "id": 1,
    "id_utilisateur": 123456,
    "date_creation": "2016-10-19 12:29:56",
    "date_impression": null,
    "id_support": 60,
    "descriptif": "DESCRIPTIF DELIVENGO EASY",
    "plis": [
      {
        "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": "6",
        "date_retour_ar": null,
        "imputation": {
          "libelle": "Utilisateur 1",
          "id_code_imputation": 0,
          "id_utilisateur_imputation": 123456
        },
        "expediteur": {
          "raison_sociale": "EXPEDITEUR RAISON SOCIALE 2",
          "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 2",
          "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": [],
        "tracking": {
          "url": null,
          "api_key": null
        },
        "statut": {
          "id": "0",
          "libelle": "Préparation",
          "date": null
        },
        "data": {
          "emails_notifications_suivi": [],
          "email_destinataire": null,
          "reference": "",
          "envoiNotification": "0",
          "poids": 200,
          "preciser_notifications": "0"
        }
      }
    ]
  }
}

Les erreurs

Code Message Description
403L'envoi #{id_envoi} n'existe pas.Aucun envoi trouvé pour cet identifiant d'envoi.