Hakee toimitusvaihtoehdot ja valmistaa lähetykset.
Siirry kohtaan:
Hae toimitusvaihtoehdot
GET /delivery-checkouts/{deliveryCheckoutId}Hakee toimitusvaihtoehdot, jotka ovat saatavilla Toimitusmaksussa.
Kyselyparametreina käytettävä kieli ja valuutta tulee olla määriteltynä Toimitusmaksussa nShift Deliveryssä.
Jotkut kuljetusyritykset saattavat vaatia enemmän osoitetietoja, jotta osoite katsotaan täydelliseksi.
URI-parametrit
| deliveryCheckoutId | merkkijono | Toimitusmaksun tunniste asetuksista | Pakollinen |
Kyselyparametrit
| currency | merkkijono | Valuuttakoodi | Pakollinen |
| language | merkkijono | Kielikoodi | Pakollinen |
| tocountry | merkkijono | Vastaanottajan maa | Pakollinen |
| tozipcode | merkkijono | Vastaanottajan postinumero | Pakollinen |
Katso parametrilista arvot ja muut parametrit, joita voi lisätä kyselyyn.
Vastausesimerkki
{
"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": "Sähköposti-ilmoitus",
"selected": false,
"priceDescription": "Ilmainen!",
"price": 0,
"oneOf": null,
"atLeastOneOf": [
"FCNOTIFYEMAIL",
"FCNOTIFYSMS",
"FCNOTIFYLETTER"
],
"exclude": [
"FCNOTIFYLETTER"
],
"fields": [
{
"id": "email",
"description": "Sähköposti",
"type": "EMAIL",
"value": null,
"mandatory": true,
"min": null,
"max": null,
"pattern": null,
"items": []
}
]
},
{
"id": "FCNOTIFYSMS",
"description": "SMS-ilmoitus",
"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": "Kirjeilmoitus",
"selected": false,
"priceDescription": "49 SEK",
"price": 49,
"oneOf": null,
"atLeastOneOf": [
"FCNOTIFYEMAIL",
"FCNOTIFYSMS",
"FCNOTIFYLETTER"
],
"exclude": [
"FCNOTIFYSMS",
"FCNOTIFYEMAIL"
],
"fields": []
}
]
}
]
}
Ominaisuuksien kuvauksen löydät Ominaisuuksien viiteoppaasta.
Kaavion ja testauksen osalta katso https://api.unifaun.com/rs-docs/ ja siirry kohtaan /delivery-checkouts/{deliveryCheckoutId} GET.
Luo valmisteltu lähetys
POST /delivery-checkouts/{deliveryCheckoutId}Luo valmistellun lähetyksen perustuen verkkokaupassa kuluttajan valitsemaan toimitusvaihtoehtoon.
Tämä päätepiste on pakollinen.
Käytä aina täydellistä Toimitusmaksun tunnistetta, koska Toimitusmaksun versio sisältyy tunnisteeseen.
URI-parametrit
| deliveryCheckoutId | merkkijono | Toimitusmaksun tunniste, joka palautettiin GET-pyynnöstä | Pakollinen |
| returnShipmentData | totuusarvo | Lähetyksen tiedot palautetaan vastauksessa. | Valinnainen |
Esimerkkipyyntö sisältäen agentin (PUDO) ja SMS-ilmoituslisäosan
{
{
"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
}
Esimerkkipyyntö aikavälillä
{
"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
}
Onnistunut kutsu palauttaa tyhjän vastauksen tilakoodilla 200 OK, ellei returnShipmentData-arvoksi ole asetettu true.
Ominaisuuksien kuvauksen löydät Ominaisuuksien viiteoppaasta.
Kaavion ja testauksen osalta katso https://api.unifaun.com/rs-docs/ ja siirry kohtaan /delivery-checkouts/{deliveryCheckoutId} POST.