English

General description

The Envoi du Net webservice provides shipment label creation, to be integrated in your IT systems, coding skills are required to complete the integration. The goal is to abstract the differences between shipping carriers and provide a unified interface to ship packages.

The webservice is using the request-response model and uses the SOAP technology and HTTP requests.

Available methods

1. Shipment label creation

   Given the physical data of the package (weight, dimensions, ...), the geographical data (origin and destination addresses) and the shipping company data, the webservice sends back a PDF label and a tracking number.

2. Quotation

   Given the physical data of the package (weight, dimensions, ...) and the geographical data (origin and destination addresses), the webservice sends back a detailed quotation for every available shipping carrier.

3. Package tracking

   Given the package tracking number, the webservice sends back the shipment tracking history.

Français

Description générale du service

Le webservice Envoi du Net est destiné à l'automatisation de la création d'étiquettes, pour intégration dans un système informatique. Une compétence de développement est nécessaire pour réaliser l'intégration. L'objectif est d'abstraire les différences entre les différents transporteurs et de proposer une interface unifiée pour l'expédition de colis.

Le service utilise le modèle de requête-réponse, et s'appuie sur la technologie SOAP. Toutes les opérations sont donc faites par appels HTTP.

Opérations disponibles

1. Création d'étiquette

   A partir des données physiques du colis (poids, dimensions, ...), géographiques (adresse d'origine et d'arrivée), et du transporteur, le service renvoie un lien vers une étiquette au format PDF, ainsi que le numéro de suivi du colis.

2. Cotation

   A partir des données physiques du colis (poids, dimensions, ...) et géographiques (adresse d'origine et d'arrivée), le service renvoie une cotation détaillée pour chaque transporteur disponible vers cette destination.

3. Suivi du colis

   A partir du numéro de suivi du colis ou de la référence client, le service renvoie l'historique de suivi du colis.

Exemples de schémas d'intégration pour création d'étiquettes

Branchement direct du site

Branchement logisticien

Code samples

PHP example

$client = new SoapClient('http://api.envoidunet.com/?wsdl');


$login = new stdClass();
$login->api_account = 'API_ACCOUNT';
$login->api_key = 'API_KEY';

$params = new stdClass();

$params->reference = 'MY_REFERENCE';
$params->value = 100;
$params->carrier = 'fedex';
$params->format = 'A6';

$params->from = new stdClass();
$params->from->company = 'Envoi du Net';
$params->from->firstname = 'Jane';
$params->from->lastname = 'Doe';
$params->from->address1 = '21 allée des Métallos';
$params->from->postcode = '06700';
$params->from->city = 'Saint Laurent du Var';
$params->from->country = 'FR';
$params->from->email = 'test@envoidunet.com';
$params->from->phone = '0123456789';

$params->to = new stdClass();
$params->to->firstname = 'John';
$params->to->lastname = 'Doe';
$params->to->address1 = '21 teststrasse';
$params->to->postcode = '10115';
$params->to->city = 'Berlin';
$params->to->country = 'DE';
$params->to->email = 'client@envoidunet.com';
$params->to->phone = '0123456789';

$package = new stdClass();
$package->weight = 5;

$product = new stdClass();
$product->name = 'Test product';
$product->price = 10;
$product->qty = 1;
$product->weight = 5;

$package->products = array($product);
$params->packages = array($package);

try {
    $result = $client->createShipment($login, $params);
    if ($result['error']->error_id > 0) {
        $error = $result['error'];
        $message = $error->error_message;
        $message .= isset($error->error_description) ? ' ('.$error->error_description.')' : '';
        echo $message."\n";
    }

    var_dump($result);
} catch (SoapFault $e) {
    echo $e->getMessage()."\n";
}

  

Python 3 example

from zeep import Client


client = Client('http://api.envoidunet.com/?wsdl')

login = {
    'api_account': 'ENVOIDUNET_API_ACCOUNT',
    'api_key': 'ENVOIDUNET_API_KEY',
}

product = {'name': 'Test product', 'price': 18.80, 'qty': 2, 'weight': 0.50}

product_type = client.get_type('ns0:productType')
productObj = product_type(**product)

array_of_products_type = client.get_type('ns0:arrayOfProducts')
productsObj = array_of_products_type([productObj])

package_type = client.get_type('ns0:packageType')
packageObj = package_type(weight=0.50, products=productsObj)

array_of_packages_type = client.get_type('ns0:arrayOfPackages')
packagesObj = array_of_packages_type([packageObj])


params = {
    'reference': 'MY_REFERENCE',
    'value': 37.6,
    'carrier': 'fedex',
    'format': 'A6',
    'from': {
        'company': 'Envoi du Net',
        'firstname': 'Jane',
        'lastname': 'Doe',
        'address1': u'21 allée des Métallos',
        'postcode': '06700',
        'phone': '0123456789',
        'city': 'Saint Laurent du Var',
        'country': 'FR',
        'email': 'test@envoidunet.com',
    },
    'to': {
        'firstname': 'John',
        'lastname': 'Doe',
        'address1': '21 teststrasse',
        'postcode': '10115',
        'city': 'Berlin',
        'phone': '0123456789',
        'country': 'DE',
        'email': 'client@envoidunet.com',
    },
    'packages': packagesObj,
}

try:
    result = client.service.createShipment(login, params)
    if result.error.error_id > 0:
        error = result.error
        message = error.error_message
        message += (
            ' (' + error.error_description + ')'
            if error.error_description
            else ''
        )
        print(message)

    print(result)

except Exception as e:
    print(e)
  

Ruby example

require 'savon'
require 'pp'

client = Savon.client(wsdl: "http://api.envoidunet.com/?wsdl", convert_request_keys_to: :none, log: false)

login = {
  api_account: 'API_ACCOUNT',
  api_key: 'API_KEY'
}

params = {
    reference: 'MY_REFERENCE',
    value: 37.6,
    carrier: 'fedex',
    format: 'A6',
    from: {
      company: 'Envoi du Net',
      firstname: 'Jane',
      lastname: 'Doe',
      address1: '21 allée des Métallos',
      postcode: '06700',
      phone: '0123456789',
      city: 'Saint Laurent du Var',
      country: 'FR',
      email: 'test@envoidunet.com'
    },
    to: {
      firstname: 'John',
      lastname: 'Doe',
      address1: '21 teststrasse',
      postcode: '10115',
      city: 'Berlin',
      phone: '0123456789',
      country: 'DE',
      email: 'client@envoidunet.com'
    },
    packages: {
      package: [
        weight: 5,
          products: {
            product: [
              {
                name: "Test product",
                price: 18.80,
                qty: 2,
                weight: 0.50
              }
            ]
          }
      ]
    }
}

begin
  response = client.call(:create_shipment, message: {login: login, params: params})
  error = response.body[:create_shipment_response][:error]

  if error[:error_id].to_i > 0
    message = error[:error_message]
    message += " (#{error[:error_description]})" if error.has?(:error_description)
    puts message
  else
    response = response.body[:create_shipment_response][:response]
    pp response
  end

rescue Exception => e
  puts e.message
end