Haalt leveringsopties op en maakt voorbereide zendingen aan.
Ga naar:
Leveringsopties ophalen
GET /delivery-checkouts/{deliveryCheckoutId}Haalt de leveringsopties op die beschikbaar zijn in een Delivery Checkout.
De taal en valuta die als queryparameters worden gebruikt, moeten geconfigureerd zijn voor de Delivery Checkout in nShift Delivery.
Sommige vervoerders vereisen mogelijk aanvullende adresparameters om een adres als volledig te beschouwen.
URI-parameters
| deliveryCheckoutId | string | Het Delivery Checkout-ID uit de configuratie | Verplicht |
Queryparameters
| currency | string | Valutacode | Verplicht |
| language | string | Taalcode | Verplicht |
| tocountry | string | Land van de ontvanger | Verplicht |
| tozipcode | string | Postcode van de ontvanger | Verplicht |
Raadpleeg de parameterlijst voor waarden en andere parameters die aan de query kunnen worden toegevoegd.
Response example
{
"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": []
}
]
}
]
}
Zie de Property reference guide voor een beschrijving van de eigenschappen.
Voor schema's en testen, ga naar https://api.unifaun.com/rs-docs/ en navigeer naar /delivery-checkouts/{deliveryCheckoutId} GET.
Een voorbereide zending aanmaken
POST /delivery-checkouts/{deliveryCheckoutId}Maakt een voorbereide zending aan op basis van de leveringsoptie die de consument in de webshop heeft geselecteerd.
Dit endpoint is verplicht.
Gebruik altijd het volledige Delivery Checkout-ID omdat de Delivery Checkout-versie in het ID is opgenomen.
URI-parameters
| deliveryCheckoutId | string | Het Delivery Checkout-ID dat door de GET-aanvraag is geretourneerd | Verplicht |
| returnShipmentData | boolean | Verzendgegevens worden in het antwoord geretourneerd. | Optioneel |
Body example with agent (PUDO) and SMS-notification 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
}
Body example with timeslot
{
"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
}
Een succesvolle aanvraag retourneert een leeg antwoord met status 200 OK, tenzij de waarde van returnShipmentData is ingesteld op true.
Zie de Property reference guide voor een beschrijving van de eigenschappen.
Voor schema's en testen, ga naar https://api.unifaun.com/rs-docs/ en navigeer naar /delivery-checkouts/{deliveryCheckoutId} POST.