Menu principal

Documentation du module Mondial Relay

Livraison et impression des étiquettes

Prérequis

Magento

  • Magento supérieure ou égale à la version 2.0 (2.0+, 2.1+, 2.2+) pour les versions CE et EE

Tunnels de commande

Liste des tunnels de commande compatibles

PHP

  • Version de PHP comprise entre 5.6 et 7.2
  • Extension SOAP (php-soap) pour la livraison en Point Relais® et l'impression des étiquettes

Configuration

L'activation du mode de livraison Mondial Relay s'effectue depuis le menu : Stores > Configuration > Sales > Shipping Methods > Mondial Relay

Général

  • Enabled : activer les méthodes d'expédition Mondial Relay
  • Title : titre de la méthode
  • API Company : enseigne fournie par Mondial Relay
  • API Reference : référence
  • API key : clé privée fournie par Mondial Relay
  • Sort Order : position de la méthode dans le tunnel de commande
  • Show Method if Not Applicable : afficher la méthode Mondial Relay même si elle ne peut s'appliquer à l'adresse de livraison du client
  • Displayed Error Message : Message affiché si la méthode ne peut s'appliquer à l'adresse de livraison du client
  • Label Size : Format PDF de l'étiquette à générer (10x15, A4, A5)
  • Delete label after : supprimer les étiquettes de la base de données X jour(s) après génération. Cette configuration permet de ne pas alourdir inutilement la base avec des données obsolètes.
  • Return Label Postcode : code postal des Point Relais® à proposer lors de la génération de l'étiquette de retour
  • Return Label Country : pays des Point Relais® à proposer lors de la génération de l'étiquette de retour

Méthodes de livraison

Activez les méthodes de livraison Mondial Relay souhaitées :

  • Point Relais® (24R)
  • Standard (HOM)
  • Confort (LD1)
  • Premium (LDS)

Paramètres :

  • Enabled : activer la méthode
  • Name : nom de la méthode
  • Price : prix de la méthode (montant / pays / poids (de) / poids (à). Pour un tarif unique, laissez vide les champs "poids (de)" et "poids (à)"
  • Ship to Specific Countries : pays activés pour la méthode
  • Insurance : Niveau d'assurance à appliquer par défaut lors de l'expedition (étiquette)

Uniquement en Points Relais® :

Configuration du prix

Pour une tarification au forfait, la configuration sera par exemple :

PrixPaysPoids (de)Poids (à)
5.90France

Pour une tarification par poids, la configuration sera par exemple :

PrixPaysPoids (de)Poids (à)
5.38France250
5.98France250500
6.70France500750
7.26France7501000
8.06France1000

Paramètres de tests

  • API Company : BDTEST13
  • API Reference : 11
  • API key : PrivateK

Impression des étiquettes

L'étiquette est générée au moment de l'expédition de la commande.

Création manuelle

Sur la vue de création d'expédition de la commande, sélectionnez la case "Créer l'étiquette" (si vous omettez de cocher la case, l'étiquette pourra être générée utlérieurement).

Créer l'étiquette Mondial Relay

Dans la fenêtre suivante, sélectionnez les produits à ajouter au colis. Vous ne pouvez créer qu'un seul colis pour une même expédition. Le poids est automatiquement récupéré à partir de l'attribut "poids" des produits. Vous pouvez manuellement ajuster la valeur, pour prendre par exemple en compte le poids de l'emballage. Sélectionnez le niveau d'assurance (de 0 à 5). Les autres champs (longueur, largeur, profondeur) ne sont pas utilisés.

Ajouter un colis

Note : le poids du colis peut être saisi en kilo-gramme (kgs) ou en Livre (lbs)

L'expédition est alors créée, le numéro de colis est automatiquement associé et transmis au client.

Création automatique

Sur la vue de création d'expédition de la commande, sélectionnez la case "Créer automatiquement l'étiquette" (si vous omettez de cocher la case, l'étiquette pourra être générée utlérieurement).

Créer l'étiquette Colissimo

L'étiquette est alors automatiquement créé selon les données de la commande et les configurations par défaut.

Note : si une erreur survient à la génération de l'étiquette, l'expédition est tout de même créée. Vous pouvez corriger les erreurs puis créer de nouveau l'étiquette manuellement depuis la vue expédition.

Pour finir, vous pouvez imprimer l'étiquette depuis la grille des commandes, en sélectionnant les commandes concernées, puis en sélectionnant l'action "Imprimer les étiquettes".

Si la commande contient déjà une expédition, vous pouvez générer ou re-générer une étiquette depuis la vue expédition de la commande.


Etiquettes de retour

Le module permet au commerçant de générer une étiquette de retour pour un client, sans que celui-ci n'est besoin de payer la livraison.

Le client dépose le colis dans n'importe quel Point Relais® vers le Point Relais® choisi par le commerçant.

La génération de l'étiquette de retour est possible à partir du moment où la commande a été expédiée (livraison générée). Sur la vue commande, un bouton Retour Mondial Relay apparaît :

Générer l'étiquette de retour

Le formulaire permet de :

  • Saisir l'adresse de l'expéditeur (automatiquement remplie à partir des données de l'adresse de facturation du client)
  • Saisir l'adresse du retour, uniquement possible en Point Relais®.

La liste des Point Relais® de retour proposée est modifiable depuis la configuration : Stores > Configuration > Sales > Shipping Methods > Mondial Relay

  • Return Label Postcode : code postal des Point Relais® à proposer lors de la génération de l'étiquette de retour
  • Return Label Country : pays des Point Relais® à proposer lors de la génération de l'étiquette de retour

Vous avez la possibilité d'enregistrer l'adresse de retour pour les prochains retours (l'adresse est enregistrée pour le store depuis lequel la commande a été passée).

La validation du formulaire engendre la génération de l'étiquette. Il est nécessaire d'enregistrer le fichier PDF et de l'envoyer manuellement au client.


API

List of REST APIs

GET    /V1/guest-carts/:cartId/mondialrelay-pickup
PUT    /V1/guest-carts/:cartId/mondialrelay-pickup/:pickupId/:countryId
DELETE /V1/guest-carts/:cartId/mondialrelay-pickup

GET    /V1/carts/mine/mondialrelay-pickup
PUT    /V1/carts/mine/mondialrelay-pickup/:pickupId/:countryId
DELETE /V1/carts/mine/mondialrelay-pickup

GET    /V1/mondialrelayPickup/:pickupId/:countryId
GET    /V1/mondialrelayPickup
GET    /V1/mondialrelayPickup/:orderId

SOAP

mondialRelayShippingPickupRepositoryV1

  • getList

Récupérer la liste des Points Relais® selon les critères de recherche :

['searchCriteria' =>
    ['filterGroups' =>
        [
            ['filters' =>
                [
                    [
                        'field' => 'postcode',
                        'value' => '59450',
                    ],
                    [
                        'field' => 'country',
                        'value' => 'FR',
                    ],
                ]
            ]
        ]
    ]
]
    
  • get

Récupérer les données d'un Point Relais® selon son identifiant et son pays :

[
    'pickupId'  => '001425',
    'countryId' => 'FR'
]
    
  • save

Associer le Point Relais® à la quote :

[
    'cartId'    => 1,
    'pickupId'  => '001425',
    'countryId' => 'FR'
]
  • current

Récupérer le Point Relais® associé à la quote :

[
    'cartId' => 1
]
  • reset

Supprimer le Point Relais® associé à la quote :

[
    'cartId' => 1
]
  • shippingData

Récupérer les données de la livraison : code livraison et identifiant du Point Relais®

[
    'orderId' => 1
]

Exemples (SOAP)

$token = '12345678912345678912345678912345';
$opts = ['http' => ['header' => "Authorization: Bearer " . $token]];
$context = stream_context_create($opts);

$request = new SoapClient(
    "http://website.magento2.com/index.php/soap/?wsdl&services=mondialRelayShippingPickupRepositoryV1",
    ["soap_version" => SOAP_1_2, 'stream_context' => $context]
);

/* Load pickup data */
$token = $request->MondialrelayShippingPickupRepositoryV1Get(
    [
        'pickupId'  => '001425',
        'countryId' => 'FR'
    ]
);

/* Retrieve list of pickup */
$token = $request->MondialrelayShippingPickupRepositoryV1GetList(
    ['searchCriteria' =>
        ['filterGroups' =>
            [
            ['filters' =>
                [
                    [
                        'field' => 'postcode',
                        'value' => '59450',
                    ],
                    [
                        'field' => 'country',
                        'value' => 'FR',
                    ],
                ]
            ]
            ]
        ]
    ]
);

/* Save pickup for quote */
$token = $request->MondialrelayShippingPickupRepositoryV1Save(
    [
        'cartId'    => 1,
        'pickupId'  => '001425',
        'countryId' => 'FR'
    ]
);

/* Retrieve current selected pickup for quote */
$token = $request->MondialrelayShippingPickupRepositoryV1Current(
    [
        'cartId' => 1,
    ]
);

/* Delete selected pickup for quote */
$token = $request->MondialrelayShippingPickupRepositoryV1Reset(
    [
        'cartId' => 1,
    ]
);

/* Retrieve Shipping Data */
$token = $request->MondialrelayShippingPickupRepositoryV1ShippingData(
    [
        'orderId' => 1,
    ]
);
Mondial relay
Magento
Magentix
Magentix Magentix © 2009 / 2018 - 38 rue de la blanchisserie - 59450 SIN-LE-NOBLE - SIRET : 80529846000033