Henter leveringsmuligheder og forbereder forsendelser.
Gå til:
Hent leveringsmuligheder
GET /delivery-checkouts/{deliveryCheckoutId}Henter leveringsmuligheder, der er tilgængelige i en Leveringsudtjekning.
Sproget og valutaen, der bruges som forespørgselsparametre, skal være konfigureret for Leveringsudtjekningen i nShift Delivery.
Nogle transportører kan kræve flere adresseparametre for at betragte adressen som fuldstændig.
URI-parametre
| deliveryCheckoutId | string | ID for Leveringsudtjekning fra opsætningen | Påkrævet |
Forespørgselsparametre
| currency | string | Valutakode | Påkrævet |
| language | string | Sprogkode | Påkrævet |
| tocountry | string | Modtagerland | Påkrævet |
| tozipcode | string | Modtagers postnummer | Påkrævet |
Se venligst parameterlisten for værdier og andre parametre, der kan tilføjes til forespørgslen.
Eksempel på svar
{
"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 af egenskaber, se venligst Ejendomsreferencen.
For skema og test, se venligst https://api.unifaun.com/rs-docs/ og naviger til /delivery-checkouts/{deliveryCheckoutId} GET.
Opret en forberedt forsendelse
POST /delivery-checkouts/{deliveryCheckoutId}Opretter en forberedt forsendelse baseret på den leveringsmulighed, som forbrugeren har valgt i webshoppen.
Denne endpoint er obligatorisk.
Brug altid det komplette Leveringsudtjeknings-ID, da Leveringsudtjekningsversionen er inkluderet i ID'et.
URI-parametre
| deliveryCheckoutId | string | Leveringsudtjeknings-ID returneret fra GET-anmodningen | Påkrævet |
| returnShipmentData | boolean | Forsendelsesdata vil blive returneret i svaret. | Valgfri |
Eksempel på body med agent (PUDO) og SMS-notifikations-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
}
Eksempel på body med tidsinterval
{
"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 succesfuldt kald returnerer et tomt svar med status 200 OK, medmindre værdien returnShipmentData er sat til true.
For en beskrivelse af egenskaber, se venligst Ejendomsreferencen.
For skema og test, se venligst https://api.unifaun.com/rs-docs/ og naviger til /delivery-checkouts/{deliveryCheckoutId} POST.