Henter leveringsalternativer og forbereder forsendelser.
Gå til:
Hent leveringsalternativer
GET /delivery-checkouts/{deliveryCheckoutId}Henter leveringsalternativer som er tilgjengelige i en Leveringsutsjekking.
Språk og valuta som brukes som spørringsparametere må være konfigurert for Leveringsutsjekkingen i nShift Delivery.
Noen transportører kan kreve flere adresseparametere for å anse adressen som komplett.
URI-parametere
| deliveryCheckoutId | string | ID for Leveringsutsjekking fra oppsettet | Påkrevd |
Spørringsparametere
| currency | string | Valutakode | Påkrevd |
| language | string | Språkkode | Påkrevd |
| tocountry | string | Mottakerland | Påkrevd |
| tozipcode | string | Mottaker postnummer | Påkrevd |
Se parameterlisten for verdier og andre parametere som kan legges til i spørringen.
Eksempel på respons
{
"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": []
}
]
}
]
}
For en beskrivelse av egenskapene, vennligst se Egenskapsreferanseguide.
For skjema og testing, vennligst se https://api.unifaun.com/rs-docs/ og naviger til /delivery-checkouts/{deliveryCheckoutId} GET.
Opprett en forberedt forsendelse
POST /delivery-checkouts/{deliveryCheckoutId}Oppretter en forberedt forsendelse basert på leveringsalternativet forbrukeren har valgt i nettbutikken.
Denne endepunktet er obligatorisk.
Bruk alltid komplett Leveringsutsjekking-ID siden versjonen av Leveringsutsjekkingen er inkludert i ID-en.
URI-parametere
| deliveryCheckoutId | string | Leveringsutsjekking-ID returnert fra GET-forespørselen | Påkrevd |
| returnShipmentData | boolean | Forsendelsesdata vil bli returnert i responsen. | Valgfritt |
Eksempel på body med agent (PUDO) og SMS-varsling tillegg
{
{
"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
}
Eksempel på body med tidsluke
{
"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
}
Et vellykket kall returnerer en tom respons med status 200 OK, med mindre verdien returnShipmentData er satt til true.
For en beskrivelse av egenskapene, vennligst se Egenskapsreferanseguide.
For skjema og testing, vennligst se https://api.unifaun.com/rs-docs/ og naviger til /delivery-checkouts/{deliveryCheckoutId} POST.