Dieser Artikel erklärt, an welchen Stellen sich die Konfiguration von Delivery Checkout bei der Verwendung mit nShift Ship von der Standardkonfiguration unterscheidet.
Abschnitte in diesem Artikel:
- Einen Delivery Checkout zur Verwendung mit nShift Ship erstellen
- Mit nShift Ship buchen und drucken
- DeliveryCheckout API
Einen Delivery Checkout zur Verwendung mit nShift Ship erstellen
Wenn Delivery Checkout für Sie neu ist, empfehlen wir, zunächst diese Artikel zu lesen:
Bevor Sie mit der Einrichtung beginnen, stellen Sie sicher, dass Sie mindestens einen Absender in Ihrem Adressbuch haben. Weitere Informationen finden Sie unter Adressbuch – nShift Delivery Help Center
Sie müssen außerdem Ihre nShift Ship Actor-ID und Ihren Schlüssel im Abschnitt Versanddetails für Ihren Absender in nShift Delivery eingeben:
- Gehen Sie zu Wartung > Absender.
- Suchen Sie nach Ihrem Absender oder fügen Sie einen neuen Absender hinzu.
- Geben Sie Ihre Actor-ID und Ihren Schlüssel im Abschnitt Versanddetails ein.
Führen Sie anschließend die in diesem Artikel beschriebenen Schritte aus: Einen Delivery Checkout erstellen
Weitere Artikel zu folgenden Themen:
Ablauf von Delivery Checkout mit nShift Ship:
Mit nShift Ship buchen und drucken
Sie können Sendungen mit Ship über die API oder per Dateiimport buchen und drucken.
Über die API
Um Sendungen über die Shipment Server API zu buchen und zu drucken, verwenden Sie die prepare ID als OrderId-Referenz, um die Aktion SubmitShipment auszuführen.
Bei der Ausführung von SubmitShipment müssen Sie fehlende obligatorische Sendungsinformationen, z. B. Paketinformationen, hinzufügen.
Weitere Informationen finden Sie unter StoreOrder zum Speichern von Bestellungen für den Import verwenden
Dateiimport
Sie können die prepare ID importieren und diesen Wert zusammen mit obligatorischen Sendungsinformationen, z. B. Paketinformationen, in Referenzen > ShipAdvisor-Referenz importieren.
Gehen Sie hier zur Ship-Hilfe.
DeliveryCheckoutAPI
Die DeliveryCheckout API ist ein Integrationsdienst für die Kommunikation zwischen Delivery Checkout und Ihrem Webshop. Die DeliveryCheckout API verwendet für die Kommunikation ein REST-API-Framework mit JSON als Datenträger und bietet eine Reihe von Funktionen.
Die vollständige allgemeine Dokumentation zur DeliveryCheckoutAPI finden Sie hier.
Bei der gemeinsamen Verwendung mit nShift Ship gibt es einige besondere Szenarien, die im Folgenden behandelt werden.
Eine Teilsendung erstellen
POST /delivery-checkouts/{deliveryCheckoutId}/shipmentsErstellt eine Teilsendung basierend auf der Lieferoption, die der Verbraucher im Webshop ausgewählt hat.
Dieser Endpunkt ist obligatorisch.
Verwenden Sie immer die vollständige Delivery-Checkout-ID, da die Version von Delivery Checkout in der ID enthalten ist.
URI-Parameter
| deliveryCheckoutId | string | Die Delivery-Checkout-ID, die aus der GET-Anforderung zurückgegeben wird | Erforderlich |
| returnShipmentData | boolean | Die Sendungsdaten werden in der Antwort zurückgegeben. | Optional |
Beispiel für den Body
{
"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
}
}
Beispiel für die Antwort
{
"sourceSystem": "DH",
"serviceId": "DH:7132",
"optionTitle": "PostNord Varubrev 1:a klass (7132)",
"serviceCaption": "PostNord Varubrev 1:a klass (7132)",
"addons": []
}
Eine Beschreibung der Eigenschaften finden Sie im Referenzleitfaden für Eigenschaften.
Informationen zu Schema und Tests finden Sie unter https://api.unifaun.com/rs-docs/. Navigieren Sie dort 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 |
Beispiel für die Antwort
{
"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 Referenzleitfaden für Eigenschaften.
Informationen zu Schema und Tests finden Sie unter https://api.unifaun.com/rs-docs/. Navigieren Sie dort 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 |
Bei erfolgreichem Löschen einer Teilsendung wird kein Antwort-Body zurückgegeben.
Eine Beschreibung der Eigenschaften finden Sie im Referenzleitfaden für Eigenschaften.
Informationen zu Schema und Tests finden Sie unter https://api.unifaun.com/rs-docs/. Navigieren Sie dort 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 Referenzleitfaden für Eigenschaften.
Informationen zu Schema und Tests finden Sie unter https://api.unifaun.com/rs-docs/. Navigieren Sie dort zu /delivery-checkout-shipments/{prepareId}/source-system GET.