Dieser Artikel erläutert, wo die Konfiguration von Delivery Checkout bei Verwendung mit Transsmart von der Standardkonfiguration abweicht.
Abschnitte in diesem Artikel:
- Einen Delivery Checkout zur Verwendung mit Transsmart erstellen
- Buchen und drucken mit Transsmart
- DeliveryCheckout API
Einen Delivery Checkout zur Verwendung mit Transsmart erstellen
Wenn Sie neu bei Delivery Checkout sind, empfehlen wir, mit dem Lesen dieser Artikel zu beginnen:
- Stellen Sie vor Beginn der Einrichtung sicher, dass Sie mindestens einen Absender in Ihrem Adressbuch haben. Bitte lesen Sie Neuen Absender hinzufügen, Adressbuch über API oder Adressbuch importieren.
- Sie müssen außerdem Ihre Transsmart-Kontonummer, Benutzer-ID und Ihr Passwort im Abschnitt Transsmart details auf der Seite Sender in nShift Delivery eingeben.
- Befolgen Sie anschließend die in folgendem Artikel beschriebenen Schritte: Einen Delivery Checkout erstellen
Lesen Sie unsere weiteren Artikel zu
Delivery Checkout-Ablauf mit Transsmart:
Buchen und drucken mit Transsmart
Sie können Sendungen mit Transsmart über die API, MyTranssmart oder einen direkten Link buchen und drucken.
Über API
Um Sendungen über die Transsmart API zu buchen und zu drucken, verwenden Sie die Prepare ID als Referenz, um die Aktion BOOK oder PRINT auszuführen. Bei Verwendung der Option PRINT wird die Sendung auch gebucht. Beim Buchen der Sendung müssen fehlende obligatorische Sendungsinformationen, wie z. B. Paketinformationen, ergänzt werden.
Im MyTranssmart-Dashboard können Sie außerdem Standardeinstellungen konfigurieren, die dann automatisch verwendet werden.
Lesen Sie die Transsmart Developer Documentation, um die Buchungs- und Druckfunktion aus Ihrem E-Commerce-, ERP- oder WMS-System heraus zu nutzen hier.
Verwalten Sie die Standardeinstellungen in Transsmart hier.
Über MyTranssmart
Sie können die Sendung auch in der MyTranssmart-Benutzeroberfläche buchen und drucken.
Zu Buchen und drucken in MyTranssmart wechseln.
Über direkten Link
Wenn Sie direkt zur Sendung wechseln möchten, um sie zu buchen und zu drucken, verwenden Sie eine URL.
https://api.transsmart.com/v2/direct/details?key=<transsmart key>&reference=<prepareId>
- Ersetzen Sie <transsmart key> durch Ihren Schlüssel von Transsmart.
- Ersetzen Sie <prepareId> durch die Prepare ID aus Delivery Checkout.
Ihren Transsmart-Schlüssel erhalten Sie hier.
DeliveryCheckoutAPI
DeliveryCheckout API ist ein Integrationsdienst für die Kommunikation zwischen Delivery Checkout und Ihrem Webshop. DeliveryCheckout API verwendet ein REST API-Framework für die Kommunikation mit JSON als Datenträger und bietet eine Reihe von Funktionen.
Die gesamte allgemeine Dokumentation für die DeliveryCheckoutAPI finden Sie hier.
Bei gemeinsamer Verwendung mit Transsmart gibt es einige besondere Szenarien, die wir im Folgenden behandeln.
Eine Teilsendung erstellen
POST /delivery-checkouts/{deliveryCheckoutId}/shipmentsErstellt eine Teilsendung basierend auf der Versandoption, die der Verbraucher im Webshop ausgewählt hat.
Dieser Endpunkt ist obligatorisch.
Verwenden Sie stets die vollständige Delivery Checkout-ID, da die Delivery Checkout-Version in der ID enthalten ist.
URI-Parameter
| deliveryCheckoutId | string | Die Delivery Checkout-ID, die von der GET-Anfrage zurückgegeben wird | Erforderlich |
| returnShipmentData | boolean | Sendungsdaten werden in der Antwort zurückgegeben. | Optional |
Body-Beispiel
{
"selectedOptionId": "3e01c458-b4fb-4a15-9468-f9179a516a0c",
"language": "en",
"orderNo": "order number 123",
"prepareId": "test34",
"receiver": {
"name": "Testname",
"address1": "Testaddress 1",
"zipCode": "1080",
"city": "Ixelles",
"country": "BE",
"mobile": "0733000000",
"email": "email2@example.com"
},
"agent": {
"quickId": "19172",
"name": "DISTRIBUTEUR TRIBES BXL CN",
"address1": "Avenue Louise 279",
"address2": null,
"zipCode": "1050",
"city": "Bruxelles",
"state": null,
"country": "BE",
"mapLongitude": 4.36706,
"mapLatitude": 50.82386,
"phone": null,
"email": null
}
}
Antwort-Beispiel
{
"sourceSystem": "TS",
"serviceId": "TS:BPO:TAXIPOST24H",
"optionTitle": "BPost taxipost 24h pickup point delivery",
"serviceCaption": "BPost taxipost 24h pickup point delivery"
}Eine Beschreibung der Eigenschaften finden Sie im Eigenschafts-Referenzhandbuch.
Für Schema und Tests lesen Sie bitte https://api.unifaun.com/rs-docs/ und navigieren Sie zu /delivery-checkouts/{deliveryCheckoutId}/shipments POST.
Eine Teilsendung abrufen
GET /delivery-checkout-shipments/{prepareId}Ruft eine zuvor erstellte Teilsendung ab.
URI-Parameter
| prepareId | string | Identifikation der Teilsendung. | Erforderlich |
Antwort-Beispiel
{
"serviceId": "DCTEST",
"serviceTitle": "Delivery Checkout Test Service",
"sourceSystem": "UO",
"orderNo": "order number 123",
"prepareId": "123",
"sender": {
"quickId": "1",
"name": "nShift AB",
"address1": "Skeppsbron 5-6",
"postalCode": "41121",
"city": "GÖTEBORG",
"country": "SE",
"phone": "+46 31 725 35 00",
"email": "email1@example.com"
},
"receiver": {
"name": "nShift AB",
"address1": "Tegnérgatan 34",
"postalCode": "11359",
"city": "STOCKHOLM",
"country": "SE",
"phone": "+46 8 34 35 15",
"email": "email2@example.com"
}
}Eine Beschreibung der Eigenschaften finden Sie im Eigenschafts-Referenzhandbuch.
Für Schema und Tests lesen Sie bitte https://api.unifaun.com/rs-docs/ und navigieren Sie zu /delivery-checkout-shipments/{prepareId} GET.
Eine Teilsendung löschen
DELETE /delivery-checkout-shipments/{prepareId}Löscht eine Teilsendung.
Wenn die Teilsendung gelöscht wurde, kann die Prepare ID für neue Teilsendungen wiederverwendet werden.
URI-Parameter
| prepareId | string | Identifikation der Teilsendung | Erforderlich |
Es wird kein Antwort-Body zurückgegeben, wenn eine Teilsendung erfolgreich gelöscht wurde.
Eine Beschreibung der Eigenschaften finden Sie im Eigenschafts-Referenzhandbuch.
Für Schema und Tests lesen Sie bitte https://api.unifaun.com/rs-docs/ und navigieren Sie zu /delivery-checkout-shipments/{prepareId} DELETE.
Das Quellsystem des Dienstes abrufen
GET /delivery-checkout-shipments/{prepareId}/source-systemRuft das Quellsystem ab, aus dem der Dienst der Teilsendung stammt.
Nützlich, wenn nur die Prepare ID bekannt ist und die Delivery Checkout-Konfiguration Optionen mit Diensten aus mehreren Quellsystemen enthält.
URI-Parameter
| prepareId | string | Identifikation der Teilsendung. | Erforderlich |
Eine Beschreibung der Eigenschaften finden Sie im Eigenschafts-Referenzhandbuch.
Für Schema und Tests lesen Sie bitte https://api.unifaun.com/rs-docs/ und navigieren Sie zu /delivery-checkout-shipments/{prepareId}/source-system GET.