Ruft Lieferoptionen ab und bereitet Sendungen vor.
Gehe zu:
Lieferoptionen abrufen
GET /delivery-checkouts/{deliveryCheckoutId}Ruft Lieferoptionen ab, die in einem Liefer-Checkout verfügbar sind.
Die als Abfrageparameter verwendete Sprache und Währung müssen für den Liefer-Checkout in nShift Delivery konfiguriert sein.
Einige Versanddienstleister benötigen möglicherweise weitere Adressparameter, um die Adresse als vollständig zu betrachten.
URI-Parameter
| deliveryCheckoutId | string | Die Liefer-Checkout-ID aus der Einrichtung | Erforderlich |
Abfrageparameter
| currency | string | Währungscode | Erforderlich |
| language | string | Sprachcode | Erforderlich |
| tocountry | string | Empfängerland | Erforderlich |
| tozipcode | string | Empfänger-Postleitzahl | Erforderlich |
Bitte beachten Sie die Parameterliste für Werte und weitere Parameter, die der Abfrage hinzugefügt werden können.
Beispiel für eine Antwort
{
"deliveryCheckoutId": "ece27d51-614d-4339-9728-4113e16b87ff+37",
"options": [
{
"id": "121f80bf-2652-43c7-9870-74de9d3157d9",
"name": "Hemleverans",
"description1": "Få paket hem",
"description2": "",
"description3": "",
"description4": "",
"description5": "",
"carrierId": null,
"priceDescription": null,
"priceValue": null,
"subOptions": [ {
"id": "aa59c047-21cc-46fa-bb62-3ca2566b6bbe",
"name": "PostNord Parcel",
"description1": "Leverans 1-2 vardagar",
"description2": "",
"description3": "",
"description4": "",
"deliveryTime": "",
"carrierId": "PLAB",
"priceDescription": "20 kr",
"priceValue": 20,
"taxRate": 5,
"subOptions": [],
"agents": []
}],
"agents": []
},
{
"id": "199e9ed0-5abf-4109-9899-270cf39f7138",
"name": "MyPack Collect",
"description1": "",
"description2": "",
"description3": "",
"description4": "",
"description5": "",
"carrierId": "PLAB",
"priceDescription": "29 SEK",
"priceValue": 29,
"taxRate": 2,
"subOptions": [],
"agents": [
{
"id": "74383",
"name": "Agent name",
"address1": "Agentstreet 1",
"address2": null,
"zipCode": "11111",
"city": "STOCKHOLM",
"country": "SE"
},
{
"id": "43333",
"name": "Agent name",
"address1": "Agentstreet 2",
"address2": null,
"zipCode": "11111",
"city": "STOCKHOLM",
"country": "SE"
}
],
"fields": null"addons": [
{
"id": "FCNOTIFYEMAIL",
"description": "E-postavisering",
"selected": false,
"priceDescription": "Gratis!",
"price": 0,
"oneOf": null,
"atLeastOneOf": [
"FCNOTIFYEMAIL",
"FCNOTIFYSMS",
"FCNOTIFYLETTER"
],
"exclude": [
"FCNOTIFYLETTER"
],
"fields": [
{
"id": "email",
"description": "E-post",
"type": "EMAIL",
"value": null,
"mandatory": true,
"min": null,
"max": null,
"pattern": null,
"items": []
}
]
},
{
"id": "FCNOTIFYSMS",
"description": "SMS-avisering",
"selected": false,
"priceDescription": "40 SEK",
"price": 40,
"oneOf": null,
"atLeastOneOf": [
"FCNOTIFYEMAIL",
"FCNOTIFYSMS",
"FCNOTIFYLETTER"
],
"exclude": [
"FCNOTIFYLETTER"
],
"fields": [
{
"id": "sms",
"description": "Sms",
"type": "PHONE",
"value": null,
"mandatory": true,
"min": null,
"max": null,
"pattern": null,
"items": []
}
]
},
{
"id": "FCNOTIFYLETTER",
"description": "Brevavisering",
"selected": false,
"priceDescription": "49 SEK",
"price": 49,
"oneOf": null,
"atLeastOneOf": [
"FCNOTIFYEMAIL",
"FCNOTIFYSMS",
"FCNOTIFYLETTER"
],
"exclude": [
"FCNOTIFYSMS",
"FCNOTIFYEMAIL"
],
"fields": []
}
]
}
]
}
Für eine Beschreibung der Eigenschaften lesen Sie bitte den Eigenschaftsreferenzleitfaden.
Für Schema und Tests besuchen Sie bitte https://api.unifaun.com/rs-docs/ und navigieren Sie zu /delivery-checkouts/{deliveryCheckoutId} GET.
Eine vorbereitete Sendung erstellen
POST /delivery-checkouts/{deliveryCheckoutId}Erstellt eine vorbereitete Sendung basierend auf der Lieferoption, die der Verbraucher im Webshop ausgewählt hat.
Dieser Endpunkt ist verpflichtend.
Verwenden Sie immer die vollständige Liefer-Checkout-ID, da die Version des Liefer-Checkouts in der ID enthalten ist.
URI-Parameter
| deliveryCheckoutId | string | Die Liefer-Checkout-ID, die von der GET-Anfrage zurückgegeben wurde | Erforderlich |
| returnShipmentData | boolean | Sendungsdaten werden in der Antwort zurückgegeben. | Optional |
Beispiel für Body mit Agent (PUDO) und SMS-Benachrichtigungs-Addon
{
{
"shipment": {
"receiver": {
"name": "nShift AB",
"address1": "Tegnérgatan 34",
"zipcode": "11359",
"city": "STOCKHOLM",
"country": "SE",
"phone": "+46 8 34 35 15",
"email": email2@example.com
},
"agent": {
"quickId": "74383",
"name": "Agent name",
"address1": "Agentstreet 1",
"address2": null,
"zipcode": "11111",
"city": "STOCKHOLM",
"country": "SE"
},
"orderNo": "order number 123",
"senderReference": "sender ref 234",
"receiverReference": "receiver ref 345"
},
"selectedOptionId": "199e9ed0-5abf-4109-9899-270cf39f7138",
"selectedAddons": [
{
"id": "FCNOTIFYSMS",
"fields": [
{
"id": "sms",
"value": "070000000"
}
]
}
],
"prepareId": "100012",
"returnShipmentData": true
}
Beispiel für Body mit Zeitfenster
{
"shipment": {
"receiver": {
"name": "nShift AB",
"address1": "Tegnérgatan 34",
"zipcode": "11359",
"city": "STOCKHOLM",
"country": "SE",
"phone": "+46 8 34 35 15",
"email": email2@example.com
},
"orderNo": "order number 123",
"senderReference": "sender ref 234",
"receiverReference": "receiver ref 345"
},
"selectedOptionId": "6d9b4f7a-944e-4543-b21c-6e28d717cddf",
"fields": [
{
"id": "FCDELIVERYTIMEINTERVAL",
"value": "1678860000:1678892400:1678982400:1679000400"
}
],
"prepareId": "100013",
"returnShipmentData": false
}
Ein erfolgreicher Aufruf gibt eine leere Antwort mit dem Status 200 OK zurück, es sei denn, der Wert von returnShipmentData ist auf true gesetzt.
Für eine Beschreibung der Eigenschaften lesen Sie bitte den Eigenschaftsreferenzleitfaden.
Für Schema und Tests besuchen Sie bitte https://api.unifaun.com/rs-docs/ und navigieren Sie zu /delivery-checkouts/{deliveryCheckoutId} POST.