URL

/envois

Type

POST

Description

Créer un envoi de plis.

Paramètre d'URL

Nom du paramètre Type DescriptionObligatoireValeur par défaut
supportIntSupports d'impression pour le Delivengo Easy :
  • 4 : Planche d'étiquettes (A4)
  • 32  : Étiquette 10x15 cm
Non
positionIntPosition de l'étiquette pour les supports :
  • Delivengo Easy (Planche d'étiquettes) : de 1 à 4.
Non
imprimer_referenceIntPour imprimer la référence sur le support d'impression, passez cette valeur à 1Non
imprimer_descriptifIntPour imprimer le descriptif sur le support d'impression, passez cette valeur à 1Non

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).
Nom du paramètre Type DescriptionObligatoireValeur par défaut
descriptifString(255)Description de l'envoi.Non
extraObjetObjet Extra.Non
id_supportIntType de support des plis créés.
  • 60 : Delivengo Easy
Oui
plisArrayTableau d'objet EnvoiPli.Oui
{
  "data": {
    "id_support": 60,
    "descriptif": "DESCRIPTIF DELIVENGO",
    "extra": {
      "compte": {
        "eori": [
          {
            "code_pays": "GB",
            "numero": "GB123456789012"
          }
        ]
      }
    },
    "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": "Corporate & Co",
          "nom": "JOHN MULLER",
          "complement_voie": "",
          "voie": "1 Street J.F.Kennedy",
          "boite_postale": "",
          "code_postal_commune": "SW10 HOUSTON",
          "pays": "ROYAUME-UNI",
          "code_pays": "GB"
        },
        "imputation": {
          "code": "V1",
          "libelle": "VENDOR"
        },
        "destinataire_email": "jean.reneau@test.fr",
        "reference": "Réf du 1er pli",
        "options": 64,
        "poids": 100,
        "documents_douaniers": {
          "envoi_nature": [
            1,
            2,
            3
          ],
          "envoi_commercial": 1,
          "observation": "OBservation",
          "num_licence": "123",
          "num_certificat": "321",
          "num_facture": "123",
          "frais_port": "1.00",
          "articles": [
            {
              "description_detaillee": "Article 1",
              "quantite": "1",
              "poids": 0.5,
              "valeur": "1",
              "pays_origine": "FRANCE",
              "num_tarifaire": "654123"
            },
            {
              "description_detaillee": "Article 2",
              "quantite": "2",
              "poids": 0.5,
              "valeur": "2",
              "pays_origine": "FRANCE",
              "num_tarifaire": "123451"
            }
          ]
        }
      }
    ]
  }
}

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
dataObjetObjet envoi.Non
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
# Avec l'entête : Accept
{
  "id": 1,
  "plis": [
    {
      "id": "1",
      "numero": "XX000000000FR"
    }
  ],
  "documents_supports": "JVBERi0xLjQKJeLjz9MKMSAwIG9...",
  "documents_douaniers": "JVBERi0xLjQKJeLjz9MKMSAwIG9..."
}
 
# Sans l'entête : Accept
{
  "data": {
    "id": 1,
    "id_utilisateur": 123456,
    "date_creation": "2016-10-19 12:29:56",
    "date_impression": null,
    "id_support": 60,
    "descriptif": "DESCRIPTIF DELIVENGO",
    "plis": [
      {
        "id": 1,
        "support": {
          "id": 60,
          "nom": "Delivengo Conso",
          "nom_long": "Delivengo Conso",
          "code": "DELIVENGOCONSO",
          "classname": "DelivengoConso"
        },
        "date_depot": null,
        "createur": {
          "id": 123456,
          "nom": "Utilisateur 1",
          "email": "utilisateur1@test.fr"
        },
        "numero": "",
        "reference": "",
        "reference_interne": "DESCRIPTIF DELIVENGO\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"
        }
      }
    ]
  }
}