+ All Categories
Home > Documents > Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch...

Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch...

Date post: 09-Aug-2019
Category:
Upload: lamthuan
View: 217 times
Download: 0 times
Share this document with a friend
35
Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen bei der Bestellabwicklung in Magento 2. Dazu wird der Webservice der Deutsche Post AG verwendet. English The Deutsche Post Internetmarke Extension enables the creation of frankings during the order process in Magento 2. The web service of the Deutsche Post AG is used for this purpose. Version: 2.0.0
Transcript
Page 1: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Ein Produkt der Deutschen Post

Deutsch

Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen bei

der Bestellabwicklung in Magento 2. Dazu wird der Webservice der Deutsche Post AG

verwendet.

English

The Deutsche Post Internetmarke Extension enables the creation of frankings during the order

process in Magento 2. The web service of the Deutsche Post AG is used for this purpose.

Version: 2.0.0

Page 2: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

1

Inhalt

1 Voraussetzungen .................................................................................................. 3

1.1 Magento ................................................................................................................ 3

1.2 PHP ....................................................................................................................... 3

2 Installation und Konfiguration ................................................................................ 4

2.1 Installation ............................................................................................................. 4

2.2 Modulkonfiguration ................................................................................................ 5

2.3 Einrichten der Cron-Jobs ....................................................................................... 7

3 Verwendung im Bestellprozess.............................................................................. 8

3.1 Aufnahme einer Bestellung .................................................................................... 8

3.2 Erstellung eines Lieferscheins ............................................................................... 8

3.3 Erstellung eines Lieferscheins - Schnellauswahl ................................................... 9

3.3.1 Beauftragung der Frankierung...................................................................10

3.4 Erstellung eines Lieferscheins - Sendungsassistent .............................................11

3.4.1 Sendungsassistent - Schritt 1: Adresse .....................................................11

3.4.2 Sendungsassistent – Schritt 2: Label ........................................................12

3.4.3 Sendungsassistent – Schritt 3: Finalisierung .............................................13

3.5 Stornieren der PDF-Frankierung...........................................................................14

3.6 Herunterladen der PDF-Frankierung ....................................................................15

4 DP Shop ...............................................................................................................16

5 Deinstallation oder Deaktivierung .........................................................................17

5.1 Deinstallation ........................................................................................................17

5.2 Deaktivierung .......................................................................................................17

6 Technischer Support ............................................................................................18

1 Requirements ........................................................................................................ 1

1.1 Magento ................................................................................................................ 1

1.2 PHP ....................................................................................................................... 1

2 Installation and configuration ................................................................................. 2

2.1 Installation ............................................................................................................. 2

2.2 Module configuration ............................................................................................. 3

2.3 Setting up the cron job ........................................................................................... 5

3 Use in the ordering process ................................................................................... 6

3.1 Taking an order ..................................................................................................... 6

3.2 Creating a shipment .............................................................................................. 6

3.3 Creating a shipment – Quick label select ............................................................... 7

3.3.1 Comissioning the frankings ........................................................................ 8

3.4 Creating a shipment – Shipment Wizard ................................................................ 9

Page 3: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

2

3.4.1 Shipment wizard – Step 1: Address ........................................................... 9

3.4.2 Shipment wizard – Step 2: Label ...............................................................10

3.4.3 Shipment wizard – Step 3: Finalization ......................................................11

3.5 Canceling (refunding) a franking ...........................................................................12

3.6 Downloading the PDF frankings ...........................................................................13

4 DP Shop ...............................................................................................................14

5 Uninstall or deactivate ..........................................................................................15

5.1 Uninstallation ........................................................................................................15

5.2 Deactivation..........................................................................................................15

6 Technical support .................................................................................................16

Page 4: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

3

1 Voraussetzungen

Die nachfolgenden Voraussetzungen müssen für den reibungslosen Betrieb der Extension

gegeben sein.

1.1 Magento

Folgende Magento Versionen werden vom Modul unterstützt:

Community Edition 2.0

Community Edition 2.1

Community Edition 2.2

Community Edition 2.3

1.2 PHP

Folgende PHP-Versionen werden vom Modul unterstützt:

PHP 7.2

PHP 7.1

PHP 7.0

PHP 5.6

PHP 5.5

Für die Anbindung des Webservices der Deutschen Post AG, muss die PHP SOAP

Erweiterung auf dem Webserver installiert und aktiviert sein.

Page 5: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

4

2 Installation und Konfiguration

Im Folgenden wird beschrieben, wie das Modul installiert wird und welche

Konfigurationseinstellungen vorgenommen werden müssen.

Für weitere Informationen, wenden Sie sich an die offizielle Magento 2 Dokumentation.

2.1 Installation

Installieren Sie die Dateien gemäß Ihrer bevorzugten Installations- und Deployment-Strategie.

Aktualisieren Sie den Konfigurations-Cache, damit die Änderungen wirksam werden.

Beim ersten Aufruf des Moduls werden die folgenden neuen Tabellen in der Datenbank

angelegt:

deutschepost_country

deutschepost_internetmarke_franking

deutschepost_internetmarke_pageformat

deutschepost_product_sales

deutschepost_product_basic

deutschepost_product_additional

deutschepost_product_sales_additional

deutschepost_shipment_item

deutschepost_shipment_attachment

deutschepost_t_app_service

deutschepost_t_app_service_feature

deutschepost_t_app_service_provider

Page 6: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

5

2.2 Modulkonfiguration

Öffnen Sie nach der Installation den Konfigurationsbereich unter:

Shops / Konfiguration / Verfkäufe / Versandarten

Dort finden Sie einen neuen Reiter "Deutsche Post Internetmarke", mit den für das Modul

relevanten Konfigurationseinstellungen.

Tabelle 1: Konfiguration Deutsche Post INTERNETMARKE

Konfiguration Pflichtfeld Kommentar

Allgemein

Modul NEIN Anzeige der installierten Modul-Version.

Titel JA Titel des Moduls.

Aktiviert JA Legt fest, ob das Modul aktiviert ist.

Kontaktperson Absender

JA / NEIN

Legt fest, welcher Absender für die Beauftragung von Frankierungen verwendet wird. Diese Angaben sind optional, wenn sie bereits in der allgemeinen Magento Store-Konfiguration vorliegen.

Protokollierung aktivieren

NEIN Legt fest, ob die Webservice-Nachrichten geloggt werden sollen. Ist diese Protokollierung erwünscht, muss ebenfalls die allgemeine Protokollierung in Magento aktiviert sein.

Protokollstufe NEIN Bestimmt, ob die Log-Datei immer oder nur im Fehlerfall geschrieben wird.

Gewichtseinheit NEIN Bestimmt die angezeigte Gewichtseinheit im Modul.

Ansprechpartner NEIN Legt den Ansprechpartner beim Versand fest. Nur relevant für Harmonized Labels bzw. CN22 Zollinhaltserklärungen.

Portokasse

Kontofunktionen NEIN Über die angezeigten Links können diverse Account-Einstellungen durchgeführt werden.

Lizenzvereinbarung JA Durch die Auswahl von „Ja“, werden die Lizenzvereinbarungen akzeptiert und die Funktionen der Erweiterung freigeschaltet.

E-Mail-Adresse JA Zugangsdaten Portokasse: E-Mail-Adresse

Password JA Zugangsdaten Portokasse: Passwort

Page 7: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

6

Konfiguration Pflichtfeld Kommentar

Porto aufladen NEIN Hier kann der aktuelle Portokasse Kontostand kontrolliert bzw. ein neuer Auflade Vorgang angestoßen werden. Nach einem Klick auf „Aufladen“, wird eine Weiterleitung zur Deutschen Post durchgeführt, um den Auflade Vorgang abzuschließen.

Internetmarke 1C4A

Aktiviert NEIN Zeigt an, ob das Service aktiv ist.

Druckformat JA Legt das PDF-Seitenformat für die am Webservice beauftragten Frankierungen fest. Die Druckformate müssen über den „Druckformate Abrufen“ Button zunächst abgerufen werden. Nach einer Aktualisierung der Seite, kann das gewünschte Format ausgewählt werden.

Internetmarke 1C4R

Aktiviert NEIN Zeigt an, ob das Service aktiv ist.

Internetmarke ProdWS

Aktiviert NEIN Zeigt an, ob das Service aktiv ist.

Packet Plus International

Aktiviert NEIN Legt fest, ob das Service aktiv ist.

EKP-Nummer NEIN Vertragsnummer.

Standard Sendungsart

NEIN Standardart der Sendung beim internationalen Versand von Harmonized Labels und CN22 Zollinhaltserklärungen.

Standard Produktherkunft

NEIN Rückfallwert für Produkte die kein Warenursprungsland im Katalog definiert haben. Nur relevant für den international Versand mit Harmonized Label und CN22 Zollinhaltserklärung.

Service-Level NEIN Service-Level der Sendung. Derzeit nur Priority.

HS Code Produktattribut ID

NEIN ID des Produktattributes in welchem der HS Code hinterlegt ist.

Zollinhaltserklärung Produktattribut ID

NEIN ID des Produktattributes in welchem die Zollbeschreibung hinterlegt ist.

Werkzeuge

Page 8: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

7

Konfiguration Pflichtfeld Kommentar

Druckformat JA Nachdem die notwendigen Anmeldeinformationen hinterlegt worden sind, müssen über den angezeigten Link die Druckformate abgerufen werden.

Produktliste JA Nachdem die notwendigen Anmeldeinformationen hinterlegt worden sind, müssen über den angezeigten Link die mit Ihrem Konto verknüpften Postprodukte vom Webservice abgerufen werden. Wenn ein grünes Häkchen angezeigt wird, ist das Modul einsatzfähig.

Der Absender wird in den vom System dafür vorgesehenen Feldern gepflegt:

Store-Name

Shops → Konfiguration → Allgemein → Allgemein → Shop Informationen

Shop-Telefonnummer

Shops → Konfiguration → Allgemein → Allgemein → Shop Informationen

Anschrift

Shops → Konfiguration → Verkäufe → Versand-Einstellungen → Herkunft

Stadt

Shops → Konfiguration → Verkäufe → Versand-Einstellungen → Herkunft

Region/Staat

Shops → Konfiguration → Verkäufe → Versand-Einstellungen → Herkunft

Postleitzahl

Shops → Konfiguration → Verkäufe → Versand-Einstellungen → Herkunft

Land

Shops → Konfiguration → Verkäufe → Versand-Einstellungen → Herkunft

2.3 Einrichten der Cron-Jobs

Die Extension stellt zwei Cron-Jobs bereit:

deutschepost_prodws_update_products

Dieser Cron-Job aktualisiert die verfügbaren Postprodukte und Preise im System. Er

läuft einmal täglich um Mitternacht.

deutschepost_oneclickforapp_checkout

Dieser Cron-Job beauftragt im System vorbereitete Frankierungen und ruft die

resultierenden PDF-Dateien ab. Er läuft viertelstündlich.

Page 9: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

8

3 Verwendung im Bestellprozess

3.1 Aufnahme einer Bestellung

Die Extension stellt keine neue Versandart im Checkout bereit. Nutzen Sie für die

Versandkostenberechnung stattdessen beliebige andere im System verfügbare Versandarten

(bspw. tabellarische oder feste Versandkosten).

3.2 Erstellung eines Lieferscheins

Öffnen Sie die Bestellung im Admin Panel über Verkäufe → Bestellungen. Starten Sie die

Erstellung eines neuen Lieferscheins über den Button Versand oben rechts auf der

Bestelldetailseite.

Das Modul bietet nun zwei Möglichkeiten ein Versandetikett zu erstellen.

Abbildung 1: Optionen für die Generierung eines Versandetiketts

Page 10: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

9

3.3 Erstellung eines Lieferscheins - Schnellauswahl

Nach einem Klick auf die Schnellauswahl Option, stehen die verfügbaren Versandprodukte zur

Auswahl. Wählen Sie das Basisprodukt und bei Bedarf Zusatzleistungen. Der Preis der

aktuellen Auswahl wird darunter angezeigt. Schließen Sie die Erstellung des Lieferscheins

dann wie üblich ab.

Wichtig: CN22 Zollinhaltserklärung und Harmonized Labels können über die Schnellauswahl

nicht generiert werden. Hierfür benutzen Sie bitte den Sendungsassistenten.

Abbildung 2: Auswahl der Versandprodukte bei der Erstellung eines neuen Versandetiketts

Page 11: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

10

3.3.1 Beauftragung der Frankierung

Durch die Erstellung eines Lieferscheins über die Schnellauswahl, wurden ein neuer

Lieferschein und der dazugehörige Frankierauftrag angelegt. Bestehende Frankieraufträge

und deren Status können in der Liste des Moduls eingesehen werden:

Verkäufe → Internetmarke

Um die PDF-Datei zu erhalten, müssen die Frankieraufträge an den Webservice der

Deutschen Post übertragen werden:

Zur Beauftragung einer Frankierung, klicken Sie Beauftragen in der Spalte Aktion

Zur Beauftragung mehrerer ausgewählter Frankierungen, wählen Sie im Dropdown der

Listenansicht Beauftragen und dann den Button Absenden

Zur Beauftragung aller offenen Frankierungen via Cron Job: siehe Einrichten der Cron-

Jobs

Abbildung 3: Übersicht der INTERNETMARKE Frankieraufträge

Page 12: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

11

3.4 Erstellung eines Lieferscheins - Sendungsassistent

Der Versandassistent bietet ein Schritt-für-Schritt Verfahren für die Generierung eines

Versandetiketts an. Nachdem Sie die Sendungsassistent Option gewählt haben, öffnet Sich

beim Klick auf Sendung erstellen der Sendungsassistent. Dieser führt Sie durch den Rest des

Prozesses. Jeder einzelne Schritt ist in den nachfolgenden Abschnitten beschrieben.

3.4.1 Sendungsassistent - Schritt 1: Adresse

Dieser Schritt beinhaltet eine Kurzübersicht der Adressen des Absenders und des

Empfängers. Um den Empfänger zu ändern, muss die Adresse der entsprechenden Sendung

angepasst werden. Um den Absender zu ändern, passen Sie bitte die Magento System-

Konfiguration erneut an. Dieses Verfahren im Abschnitt 2.2 Modulkonfiguration beschrieben.

Abbildung 4: Sendungsassistent, Schritt 1 – Adresse.

Page 13: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

12

3.4.2 Sendungsassistent – Schritt 2: Label

Im 2. Schritt des Sendungsassistenten wird das Versandprodukt gewählt. Zusatzleistungen

und Zusatzoptionen sind optional.

Wichtig: Achten Sie bitte bei der Zusatzoption „Harmonized Label“ auf die Auswahl der

richtigen Warenpost-Kategorie (EU oder Nicht-EU). Beispiel: Ein Versand nach Österreich,

kombiniert mit der Auswahl eines Produktes der Kategorie Warenpost Nicht-EU, resultiert in

einem Fehler, welcher von der Schnittstelle zurückgegeben wird. Dies hat auch zur Folge,

dass kein Versandetikett erzeugt wird.

Abbildung 5: Sendungsassistent, Schritt 2 – Label.

Page 14: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

13

3.4.3 Sendungsassistent – Schritt 3: Finalisierung

Der letzte Schritt dient zur Finalisierung der Sendung. Hier werden die Zusatzinformationen

(HS Code & Warenursprung) der einzelnen Bestellpositionen für Labels mit

Zollinhaltserklärung eingegeben. Nach einem Klick auf Sendung erstellen, wird die Sendung

und das dazugehörende Versandetikett generiert.

Wichtig: In diesem Schritt wird das Label sofort bezogen und das Porto von Ihrer Portokasse

abgebucht.

Abbildung 6: Sendungsassistent, Schritt 3 – Finalisierung.

Page 15: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

14

3.5 Stornieren der PDF-Frankierung

Um eine bereits beauftragte Frankierung zu stornieren, befolgen Sie bitte folgende Schritte:

Frankierung unter Verkäufe → Internetmarke öffnen

In der Spalte Aktion auf „Stornieren“ klicken

Zur Stornierung mehrerer Frankierungen:

Frankierung unter Verkäufe → Internetmarke öffnen

Gewünschte Frankerungen anhaken

Im Dropdown der Listenansicht „Stornieren“ wählen und dann den Button Absenden

klicken

Frankierungen werden auch storniert, wenn die Sendungsverfolgungsnummer einer Sendung

(falls vorhanden) gelöscht wird.

Wichtig: Harmonized Labels (mit oder ohne Zollinhaltserklärung) sind über das Modul nicht

stornierbar. Um derartige Labels zu stornieren, kontaktieren Sie bitte die Deutsche Post unter

der E-Mail-Adresse [email protected].

Page 16: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

15

3.6 Herunterladen der PDF-Frankierung

Wenn der Frankierauftrag erfolgreich vom Webservice verarbeitet wurde, wird die PDF-Datei

mit der Internetmarke zum jeweiligen Lieferschein gespeichert.

Sie können die PDF-Datei unter den folgenden Ansichten herunterladen:

Magento-Bestellübersicht über den Dropdown-Eintrag: Versandetiketten drucken

Listenansicht des Moduls über den Dropdown-Eintrag: Frankierungen drucken

Listenansicht des Moduls in der Spalte: Internetmarke

Die Tracking-Nummer kann auf der Lieferschein-Detailseite in der Box Versandinformation,

sowie im Kundenkonto eingesehen werden.

Abbildung 7: Lieferschein-Detailseite

Page 17: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

16

4 DP Shop

Das Modul unterstützt ebenfalls Einzelkäufe von Internetmarken, welche unabhängig von einer

Sendung durchgeführt werden können. Um zum Bestellformular zu gelangen, können Sie

folgenden Navigationspfad benutzen:

Sales → Internetmarke → DP Shop

Abbildung 8: Kauf einer Internetmarke unabhängig von einer Sendung

Dieser Prozess ist identisch zum Sendungsassistenten im Abschnitt 3.4, ausgenommen

Harmonized Labels. Da für Harmonized Labels Zusatzangaben über die Produkte benötigt

werden und hier keine Verbindung zu einer Bestellung besteht, sind diese aus der Auswahl

ausgeschlossen.

Die unabhängig gekauften Internetmarken werden ebenfalls in der Übersicht unter Verkäufe

→ Internetmarke aufgelistet (ohne Lieferung #).

Page 18: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

5 Deinstallation oder Deaktivierung

5.1 Deinstallation

Um das Deutsche Post Internetmarke Modul zu deinstallieren, benutzen Sie die folgende Kommandozeile:

bin/magento module:uninstall DeutschePost_Internetmarke

Für weitere Informationen, wenden Sie sich an die offizielle Magento 2 Dokumentation.

5.2 Deaktivierung

Um das Deutsche Post Internetmarke Modul zu deaktivieren, benutzen Sie die folgende Kommandozeile:

bin/magento module:disable DeutschePost_Internetmarke

Für weitere Informationen, wenden Sie sich an die offizielle Magento 2 Dokumentation.

Page 19: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

6 Technischer Support

Bei Fragen oder Problemen bezüglich des Moduls, kontaktieren Sie uns unter der folgenden

E-Mail-Adresse:

[email protected]

Sofern Fragen zu dem Produkt Internetmarke auftauchen, kontaktieren Sie bitte die

Deutsche Post unter der folgenden E-Mail-Adresse:

[email protected]

Page 20: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 1

1 Requirements

The following requirements must be met to ensure proper functionality of the Extension.

1.1 Magento

The following Magento versions are supported by the module:

Community Edition 2.0

Community Edition 2.1

Community Edition 2.2

Community Edition 2.3

1.2 PHP

The following PHP versions are supported by the module:

PHP 7.2

PHP 7.1

PHP 7.0

PHP 5.6

PHP 5.5

For the implementation of the Deutsche Post AG web service, the PHP SOAP extension must

be installed and enabled on the server.

Page 21: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 2

2 Installation and configuration

The following section describes how the module is installed and which settings need to be

configured.

2.1 Installation

Copy the DeutschePost folder from the archive into your /app/code/ folder, or Install the files

according to your preferred installation and deployment strategy. Refresh your configuration

cache so that the changes you made take effect.

On activation, the module will create the following tables in the database:

deutschepost_country

deutschepost_internetmarke_franking

deutschepost_internetmarke_pageformat

deutschepost_product_sales

deutschepost_product_basic

deutschepost_product_additional

deutschepost_product_sales_additional

deutschepost_shipment_item

deutschepost_shipment_attachment

deutschepost_t_app_service

deutschepost_t_app_service_feature

deutschepost_t_app_service_provider

Page 22: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 3

2.2 Module configuration

After the installation, open the module configuration area:

Shops / Configuration / Sales / Shipping Methods

You will find a new tab named “Deutsche Post Internetmarke”, which contains the module’s

configuration settings.

Table 2: Configuration - Deutsche Post INTERNETMARKE

Configuration Mandatory Comment

General

Module NO Displays the currently installed module version.

Title YES Module title.

Enabled YES Determines if the module should be activated.

Shipper Contact YES / NO Determines which sender will be used while commissioning frankings. This field is optional, because it’s already present in the Magento general store configuration.

Enable Logging NO Determines if the web service messages will be logged. If so, the Magento logging option must be activated as well.

Log Level NO Determines if everything is logged, or just the error messages.

Weight unit NO Determines the displayed weight unit across the module.

Contact name NO Determines the contact person for international shipments. Only relevant for Harmonized Labels (with or without CN22 customs declaration).

Portokasse

Account actions NO Various account options can be accessed through the listed links.

License agreement YES By selecting „Yes“ the license agreement is accepted and the functionality of the plugin is activated.

Email Address YES Portokasse credentials: Email address

Password YES Portokasse credentials: Password

Page 23: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 4

Configuration Mandatory Comment

Wallet Top-up NO The current Portokasse balance can be viewed and topped up through this field. After clicking the “Charge” button the module will perform a redirect to the Deutsche Post website to complete the wallet top-up process.

Internetmarke 1C4A

Enabled NO Shows if the service is active.

Page Format YES Determines the PDF page format for the frankings commissioned through the web service. The page formats need to be retrieved beforehand by using the “Retrieve page formats” button below. After the page reloaded the desired page format can be selected.

Internetmarke 1C4R

Enabled NO Shows if the service is active.

Internetmarke ProdWS

Enabled NO Shows if the service is active.

Packet Plus International

Enabled NO Determines if the web service should be active.

EKP Number NO Contract number.

Default Shipment Nature Type

NO Default shipment nature type for international shipments using Harmonized Labels and CN22 customs declarations.

Default Line Item Origin

NO Fallback value for products with no defined country of manufacture inside the Catalog. Only relevant for international shipments with Harmonized Labels and CN22 customs declarations.

Service Level NO Shipment service level. Currently only Priority.

HS Code Product Attribute ID

NO ID of the Product Attribute which contains the Product HS Code

Customs Declaration Product Attribute ID

NO ID of the Product Attribute which contains the Product Customs Declaration

Tools

Page 24: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 5

Configuration Mandatory Comment

Page Format YES Determines the PDF page format for the frankings commissioned through the web service. The page formats need to be retrieved beforehand by using the “Retrieve page formats” button below. After the page reloaded the desired page format can be selected.

Product List YES After the necessary credentials were provided, the associated product list needs to be retrieved from the web service. This can be done by clicking the link in this field. When a green checkmark is visible, the module is ready for use.

The sender will be retrieved from the following default Magento configuration fields:

Store Name

Store → Configuration → General → General → Store Information

Store Phone Number

Store → Configuration → General → General → Store Information

Street Address

Store → Configuration → Sales → Shipping Settings → Origin

City

Store → Configuration → Sales → Shipping Settings → Origin

Region/State

Store → Configuration → Sales → Shipping Settings → Origin

ZIP/Postal Code

Store → Configuration → Sales → Shipping Settings → Origin

Country

Store → Configuration → Sales → Shipping Settings → Origin

2.3 Setting up the cron job

The module will set up two cron jobs:

deutschepost_prodws_update_products

This cron job updates the available post products and prices. It will run once a day at

midnight.

deutschepost_oneclickforapp_checkout

This cron job will commission the prepared frankings and retrieve the resulting PDF

files. It runs once every 15 minutes.

Page 25: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 6

3 Use in the ordering process

3.1 Taking an order

The module does not provide a new shipping method in the checkout. Instead, for calculating

the shipping costs, use any other available shipping methods (for example tabular or fixed

shipping prices).

3.2 Creating a shipment

Open the specific order in the Admin Panel via Sales → Orders. Select an unshipped order

and in the upper right corner click on the Ship button.

The module now offers two distinct options for creating a shipping label.

Figure 1: Shipping information when creating a new shipment

Page 26: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 7

3.3 Creating a shipment – Quick label select

After clicking the „Quick label select“ option, the module will display all available shipping

products. Choose the base product and when needed an additional service. The price of your

current selection will be shown below. After your selection submit the shipment as usual.

Important: CN22 customs declarations and Harmonized Labels cannot be bought using the

quick label select option. For these labels please use the shipment wizard.

Figure 2: Shipping products selection when creating a new shipment

Page 27: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 8

3.3.1 Comissioning the frankings

A new shipment and a corresponding franking have now been created in your Magento shop.

Existing frankings and their statuses can be viewed on the module page:

Sales → Internetmarke

To obtain the PDF files, the franking orders need to be transmitted to the web service of the

Deutsche Post:

To commission a single franking, click on the Order Internetmarke in the Action column

To commission multiple frankings, select the desired frankings via checkbox and then

from the Actions dropdown menu select Order Internetmarke and click the submit

button

To commission all open frankings via cron job see Setting up the cron job

Figure 3: Preview of the INTERNETMARKE franking orders

Page 28: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 9

3.4 Creating a shipment – Shipment Wizard

The shipment wizard offers a step-by-step solution for generating shipping labels. After you

have chosen the “Shipment wizard” option a new modal window containing the wizard will open

as soon as you click the “Submit shipment” button. This wizard will guide you through the rest

of the process. Each individual step is described in the next sections of this manual.

3.4.1 Shipment wizard – Step 1: Address

This step offers a short overview of both the recipient and the sender's address. To change

the recipient's address please close the wizard and edit the addresses of the corresponding

shipment. To change the sender please reconfigure the sender address in the Magento system

configuration, described in section 2.2 Module configuration.

Figure 4: Shipment wizard, Step 1 – Address.

Page 29: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 10

3.4.2 Shipment wizard – Step 2: Label

The second step of the shipment wizard allows you to choose a shipping product. Additional

services and options are not mandatory.

Important: If the additional option “Harmonized Label” has been chosen, selecting the correct

Warenpost category depending on the recipient country (EU or non-EU) is paramount. For

example, if the recipient is from Austria, and a non-EU Warenpost label has been chosen

(alongside with the harmonized label), the interface will throw an error and the label will not be

generated.

Figure 5: Shipment wizard, Step 2 – Label.

Page 30: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 11

3.4.3 Shipment wizard – Step 3: Finalization

The last step serves as a finalizing point of the shipment. For “Harmonized Labels” this is the

part where you input your HS Codes and origin of your line items. After clicking the “Submit

shipment” button the shipment and a corresponding shipping label will be generated.

Important: After clicking the „Submit shipment“ button, the amount of the shipping product will

be deducted from your Portokasse right away.

Figure 6: Shipment wizard, Step 3 – Finalization.

Page 31: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 12

3.5 Canceling (refunding) a franking

To cancel and refund an already purchased franking please follow the following steps:

Choose a franking in the Sales → Internetmarke view

In the Action column click on „Cancel“

To cancel and refund multiple frankings:

Open the Sales → Internetmarke view

Select the desired frankings using the checkboxes

In the „Actions“

Frankierungen werden auch storniert, wenn die Sendungsverfolgungsnummer einer Sendung

(falls vorhanden) gelöscht wird.

Important: Harmonized Labels (with or without customs declaration) are not refundable inside

the module. To cancel and refund such labels please contact the Deutsche Post using the

following email address: [email protected].

Page 32: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 13

3.6 Downloading the PDF frankings

When the franking order has been completed successfully by the web service, the PDF file will

be added and saved to the corresponding shipment.

You can download the PDF file in the following views:

Magento order overview, through the dropdown item: Print Shipping Labels

The module list view, through the dropdown item: Print Shipping Labels

The module list view, in the Franking Link column

The tracking number can be found in the Shipment detail view in the Shipping and Tracking

Information section, as well as in the customer account.

Figure 2: Shipment detail view

Page 33: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 14

4 DP Shop

The module also supports single purchases of Internetmarke stamps, which are not linked to

any existing order or shipment. To access this feature, navigate the menu as described:

Sales → Internetmarke → DP Shop

Figure 3: Independent Internetmarke stamp purchase

This process is identical to the Shipment wizard in Section 3.4, with the exception that

Harmonized Labels cannot be generated through the DP Shop. Harmonized Labels require

information about the contents of the shipment, since this is an independent purchase and no

contents are available the Harmonized Label purchase is not available here.

The independently purchased stamps are also displayed in the Sales → Internetmarke view

(without any associated shipment number).

Page 34: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Uninstall or deactivate

Page 15

5 Uninstall or deactivate

5.1 Uninstallation

To uninstall the Deutsche Post Internetmarke module, use the following command:

bin/magento module:uninstall DeutschePost_Internetmarke

For more information, please visit the official Magento 2 documentation on uninstalling modules.

5.2 Deactivation

To disable the Deutsche Post Internetmarke module, use the following command:

bin/magento module:disable DeutschePost_Internetmarke

For more information, please visit the official Magento 2 documentation on disabling modules.

Page 35: Ein Produkt der Deutschen Post - marketplace.magento.com · Ein Produkt der Deutschen Post Deutsch Die Deutsche Post Internetmarke Extension ermöglicht die Erstellung von Frankierungen

Deutsche Post Internetmarke

Page 16

6 Technical support

If you have questions or problems concerning the module, please contact:

[email protected]

In case of any questions concerning the Internetmarke service, please contact:

[email protected]


Recommended