Mit dem $wsShipTrack Modul können Sie auf Sendungsverfolgung und Lieferprüfungen zugreifen. Sie können dies z.B. für Tracking-Anzeigen oder PLZ-Validierungen bei der Lieferung verwenden.

Inhaltsverzeichnis

1 Modulübersicht
2 Templates
3 Variablen
4 Methoden
- 4.1 $wsShipTrack.getTracking()
- 4.2 $wsShipTrack.zipCodeConfirmed()
5 Beispiele
- 5.1 Sendungsverfolgung mit PLZ-Prüfung
6 Weiterführende Links

Modulübersicht

Beispiel / Ausschnitt über $wsShipTrack

{{= $wsShipTrack | json }}

JSON-Ausgabe

{
  "getTracking": "ƒ()",
  "zipCodeConfirmed": "ƒ()"
}

Anmerkung: "ƒ()" kennzeichnet eine Funktion.

Methoden in der Übersicht

Methode	Rückgabe-Typ	Beschreibung

Methode	Rückgabe-Typ	Beschreibung
`getTracking()`	map	Gibt Tracking-Informationen eines Versanddienstleisters für bestimmte Sendungen zurück.
`zipCodeConfirmed()`	bool	Gibt zurück, ob die Postleitzahl für eine bestimmte Bestellung bereits bestätigt wurde.

Templates

Sendungsverfolgung und PLZ-Prüfungen werden typischerweise an folgenden Stellen eingesetzt:

Bestellbestätigung: Tracking-Link nach Versand der Bestellung.
Kundenkonto: Übersicht der Sendungsverfolgung für vergangene Bestellungen.
Checkout: PLZ-Validierung für Lieferoptionen.

Variablen

Für $wsShipTrack stehen keine Variablen zur Verfügung.

Methoden

$wsShipTrack.getTracking()

Lädt Tracking-Informationen eines Versanddienstleisters für eine bestimmte Sendungsnummer. Die zurückgegebenen Daten hängen direkt vom jeweiligen Provider ab, schauen Sie sich daher bei der Integration die entsprechende Schnittstelle des Anbieters an (z.B. DHL-API).

Signatur
$wsShipTrack.getTracking(id, trackingId)

Rückgabe
map - eine Map mit dem Ergebnis der Tracking-Anfrage.

Beispiel für die Struktur, die im Erfolgsfall zurückgegeben wird:

{
  "success": true,
  "lastErrorText": "",
  "lastErrorCode": 0,
  "data": <Objekt>
}

Der Wert unter data wird direkt vom Provider (z.B. DHL) geliefert und ist daher abhängig von der jeweiligen Schnittstelle.

Wenn keine Tracking-Informationen geladen werden konnten, ist data nicht vorhanden und lastErrorText sowie lastErrorCode enthalten die Fehlerdetails des Providers.

Parameter

Name	Typ	Pflicht	Beschreibung

Name	Typ	Pflicht	Beschreibung
`id`	string	ja	ID des Versanddienstleisters (z.B. `dhl`). Wird unter checkout.shipTrack konfiguriert.
`trackingId`	string	ja	Sendungsnummer des Versanddienstleisters (z.B. die Sendungsnummer bei DHL).

Beispiel, das versucht, Tracking-Informationen zu laden.

{{ var $tracking = $wsShipTrack.getTracking('dhl', '1234567890') }}
{{ if $tracking.success }}
    // Tracking-Daten geladen.
{{ else }}
    // keine Tracking-Daten gefunden.
{{ /if }}

$wsShipTrack.zipCodeConfirmed()

Gibt zurück, ob die Postleitzahl für eine Bestimmte Bestellung bereits bestätigt wurde. Diese Prüfung wird eingesetzt, um vor der Anzeige der Sendungsverfolgung sicherzustellen, dass es sich tatsächlich um den ursprünglichen Besteller handelt.

Signatur
$wsShipTrack.zipCodeConfirmed(orderId)

Rückgabe
bool - true, wenn die Postleitzahl für die angegebene Bestellung bereits bestätigt wurde, sonst false.

Parameter

Name	Typ	Pflicht	Beschreibung

Name	Typ	Pflicht	Beschreibung
`orderId`	string	ja	ID der Bestellung, für die die PLZ-Bestätigung geprüft werden soll.

Beispiel, das prüft, ob die Postleitzahl bestätigt wurde.

{{ if $wsShipTrack.zipCodeConfirmed($myOrderId) }}
    // Postleitzahl bestätigt.
{{ else }}
    // Postleitzahl nicht bestätigt.
{{ /if }}

Beispiele

Sendungsverfolgung mit PLZ-Prüfung

Dieses Beispiel prüft zunächst, ob die Postleitzahl bestätigt wurde und zeigt anschließend, sofern Tracking-Daten vorliegen, eine entsprechende Meldung an.

{{ if $wsShipTrack.zipCodeConfirmed($myOrderId) }}
    <p>Lieferung an bestätigte Postleitzahl.</p>
    {{ var $tracking = $wsShipTrack.getTracking('dhl', $myTrackingId) }}
    {{ if $tracking.success }}
        <p>Tracking-Informationen verfügbar.</p>
    {{ else }}
        <p>Tracking konnte nicht geladen werden: {{= $tracking.lastErrorText }}</p>
    {{ /if }}
{{ else }}
    <p>Bitte bestätigen Sie Ihre Postleitzahl, um die Sendungsverfolgung zu nutzen.</p>
{{ /if }}

$wsShipTrack