Dit artikel legt uit waarin de configuratie van Delivery Checkout, wanneer deze wordt gebruikt met nShift Ship, verschilt van de standaardconfiguratie.
Onderwerpen in dit artikel:
- Een Delivery Checkout maken voor gebruik met nShift Ship
- Boeken en afdrukken met nShift Ship
- DeliveryCheckout API
Een Delivery Checkout maken voor gebruik met nShift Ship
Als u nieuw bent met Delivery Checkout, raden wij aan eerst deze artikelen te lezen:
Voordat u begint met de configuratie, moet u ervoor zorgen dat u ten minste één afzender in uw adresboek hebt. Raadpleeg Een nieuwe afzender toevoegen, Adresboek via API of Adresboek importeren.
U moet ook uw nShift Ship Actor ID en Key invoeren in de sectie Ship details van uw Sender in nShift Delivery:
- Ga naar Maintenance > Senders.
- Zoek naar uw afzender of voeg een nieuwe afzender toe.
- Voer uw Actor ID en Key in de sectie Ship details in.
Volg vervolgens de stappen die in dit artikel worden beschreven: Een Delivery Checkout maken.
Zie ook onze andere artikelen over:
Delivery Checkout-flow met nShift Ship:
Boeken en afdrukken met nShift Ship
U kunt zendingen boeken en afdrukken met Ship via API of bestandsimport.
Via API
Om zendingen te boeken en af te drukken via de Shipment Server API gebruikt u prepare ID als OrderId-referentie voor het uitvoeren van de actie SubmitShipment.
Bij het uitvoeren van SubmitShipment moet u ontbrekende verplichte verzendinformatie toevoegen, zoals pakketinformatie.
Lees meer over Het gebruik van StoreOrder om orders op te slaan voor import.
Bestandsimport
U kunt de prepare ID importeren en deze waarde importeren in References > ShipAdvisor Reference, samen met verplichte verzendinformatie zoals pakketinformatie.
Ga naar Ship Help hier.
DeliveryCheckout API
DeliveryCheckout API is een integratieservice voor communicatie tussen Delivery Checkout en uw webshop. DeliveryCheckout API gebruikt een REST API-framework voor communicatie met JSON als gegevensdrager en biedt een aantal functies.
Alle algemene documentatie voor de DeliveryCheckout API vindt u hier.
Bij gebruik in combinatie met nShift Ship zijn er enkele speciale scenario's die hieronder worden beschreven.
Een gedeeltelijke zending maken
POST /delivery-checkouts/{deliveryCheckoutId}/shipmentsMaakt een gedeeltelijke 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 |
Zie de Property reference guide voor een beschrijving van de eigenschappen.
Voor schema's en testen gaat u naar https://api.unifaun.com/rs-docs/ en navigeert u naar /delivery-checkouts/{deliveryCheckoutId}/shipments POST.
Een gedeeltelijke zending ophalen
GET /delivery-checkout-shipments/{prepareId}Haalt een gedeeltelijke zending op die eerder is aangemaakt.
URI-parameters
| prepareId | string | Identificatie van de gedeeltelijke zending. | Verplicht |
Zie de Property reference guide voor een beschrijving van de eigenschappen.
Voor schema's en testen gaat u naar https://api.unifaun.com/rs-docs/ en navigeert u naar /delivery-checkout-shipments/{prepareId} GET.
Een gedeeltelijke zending verwijderen
DELETE /delivery-checkout-shipments/{prepareId}Verwijdert een gedeeltelijke zending.
Wanneer de gedeeltelijke zending wordt verwijderd, kan de prepare ID opnieuw worden gebruikt voor nieuwe gedeeltelijke zendingen.
URI-parameters
| prepareId | string | Identificatie van de gedeeltelijke zending | Verplicht |
Er wordt geen antwoordtekst geretourneerd wanneer een gedeeltelijke zending succesvol is verwijderd.
Zie de Property reference guide voor een beschrijving van de eigenschappen.
Voor schema's en testen gaat u naar https://api.unifaun.com/rs-docs/ en navigeert u naar /delivery-checkout-shipments/{prepareId} DELETE.
Het bronsysteem van de service ophalen
GET /delivery-checkout-shipments/{prepareId}/source-systemHaalt het bronsysteem op waaruit de service voor de gedeeltelijke zending afkomstig is.
Handig wanneer alleen de prepare ID bekend is en de Delivery Checkout-configuratie opties bevat met services uit meerdere bronsystemen.
URI-parameters
| prepareId | string | Identificatie van de gedeeltelijke zending. | Verplicht |
Zie de Property reference guide voor een beschrijving van de eigenschappen.
Voor schema's en testen gaat u naar https://api.unifaun.com/rs-docs/ en navigeert u naar /delivery-checkout-shipments/{prepareId}/source-system GET.