Paazl voor ontwikkelaars

Paazl Perfect

Paazl Perfect integreren

Let op


Als je hulp nodig hebt bij het configureren van Paazl Perfect, neem dan gerust contact op met de Paazl Customer Support. Vanwege snel veranderende technologieën is de Paazl-technologie "Paazl Perfect" "End of Life". Dit betekent dat we bestaande klanten die Paazl Perfect gebruiken blijven ondersteunen, maar dat deze oplossing geen updates of verbeteringen meer zal ontvangen. In plaats daarvan raden we je aan om te kijken naar onze Paazl checkout-widget.


Dit artikel legt uit hoe je Paazl Perfect integreert in de checkout van jouw webshop.


Om een Paazl Perfect-sessie aan te maken in de checkout van jouw webshop, moet je drie dingen doen:


  1. Een Paazl Perfect-sessie aanvragen
  2. De Paazl Perfect-sessie vullen met checkout-gegevens
  3. De geselecteerde leveringsoptie terugsturen naar jouw checkout

De details voor het uitvoeren van deze stappen worden hieronder uitgelegd.


1. Een Paazl Perfect-sessie aanvragen


  1. Maak een nieuwe openstaande bestelling (pending order) aan met de orderRequest webservice call
  2. Start een Paazl Perfect-sessie met de checkoutRequest webservice call. Deze call bevat een verwijzing naar de openstaande bestelling
  3. Laad het URL-script dat door de checkoutResponse webservice-respons wordt geretourneerd in jouw checkout

    <script type="text/javascript" src="https://ost.paazl.com/checkout/a34cb32d-d75c-4aab-8166-f4dd272c106a/loader.js"></script>

2. De Paazl Perfect-sessie vullen met checkout-gegevens


Gebruik de JavaScript-functie PaazlCheckoutModuleLoader.show() om checkout-gegevens naar Paazl te verzenden.


De functie PaazlCheckoutModuleLoader.show() moet toegang kunnen krijgen tot de waarden van de velden in Tabel 1. Er zijn twee manieren om de functie toegang te geven tot deze waarden:

  • als veld-waardeparen in een JSON-object, bijvoorbeeld:

    PaazlCheckoutModuleLoader.show({consigneeCountryCode: "NL", consigneePostalCode: "1019HD"});
  • als naam/data-pcm-input attribuutparen in jouw HTML-code, bijvoorbeeld:

    <select name="country" data-pcm-input="consigneeCountryCode">...</select>
    of

    <input type="text" name="postal_code" data-pcm-input="consigneePostalCode"/>

Tabel 1: Paazl Perfect checkout-velden


VeldTypeVerplichtBeschrijving
localeString(2)NDe ISO 639-1-code van de taal waarin je Paazl Perfect wilt weergeven (standaard: NL)
consigneeCountryCodeString(2)NDe ISO 3166-1-landcode van het afleveradres
consigneePostalCodeString(255)N

De postcode van het afleveradres

Belangrijk! Hoewel dit veld niet verplicht is voor Paazl, raden we je ten zeerste aan om het verplicht te maken op jouw checkout-pagina.
deliveryTypeEnumN

Bepaalt het tabblad waarmee Paazl Perfect start. Kan een van de volgende waarden bevatten:

  • home (thuislevering)
  • servicePoint (afhaalpunt)
servicePointBasePostalCodeString(255)NDe postcode die wordt gebruikt om naar nabijgelegen afhaalpunten te zoeken.
preferredDeliveryDateDateNDe gewenste leverdatum van de klant
notificationEmailAddressString(255)NHet e-mailadres voor meldingen van de vervoerder
notificationPhoneNumberString(255)N

Het mobiele telefoonnummer voor sms-notificaties van de vervoerder

Let op! Om er zeker van te zijn dat elke vervoerder het mobiele nummerformaat accepteert, dien je alle spaties en symbolen die door de klant zijn ingevoerd te verwijderen.
servicepointAccountNumberString(255)NHet accountnummer van de klant voor het openen van kluisjes (bijv. bij DHL Packstations)

3. De geselecteerde leveringsoptie terugsturen naar jouw checkout


Nadat een klant een leveringsoptie heeft gekozen in Paazl Perfect, zijn er twee manieren waarop je deze informatie kunt opslaan en weergeven op de checkout-pagina van jouw webshop.

  • Gebruik een JavaScript-callbackfunctie
  • Gebruik Paazl's checkoutStatusRequest API-call

JavaScript-callbackfunctie


Let op


Hoewel deze optie de beste prestaties levert, zou een klant theoretisch zijn/haar browser kunnen gebruiken om te knoeien met de gegevens die naar jouw checkout worden teruggestuurd.


Wanneer een klant zijn/haar keuze bevestigt, voert jouw webshop het volgende uit:


PaazlCheckoutModuleLoader.show(myCallback);

waarbij myCallback een functie is die je zelf definieert en die je elke gewenste naam kunt geven.


Paazl geeft aan jouw callbackfunctie een HashMap door die de veld-waardeparen bevat uit Tabel 1 hierboven, evenals de paren uit Tabel 2 hieronder. Jouw functie leest vervolgens de waarden in de HashMap en manipuleert de gegevens op jouw checkout-pagina om de keuzes van jouw klant te verwerken.


Voorbeeld van een callbackfunctie


function myCallback(params) {
  alert("User selected " + params.option + " delivery on " + params.preferredDeliveryDate);
}
PaazlCheckoutModuleLoader.show(myCallback, { deliveryType: "home" });

Tabel 2: Aanvullende Paazl Perfect checkout-velden


VeldTypeVerplichtBeschrijving
optionString(255)NCode of ID van de geselecteerde verzendoptie
deliveryFeaturesEnumN

Kenmerken van de geselecteerde verzendoptie. Kan een of meer van de volgende waarden bevatten:

  • cod (onder rembours)
  • insurance (verzekering)
  • signatureRequired (handtekening vereist)
  • directDeliveryOnly (alleen huisadreslevering)
rateDecimalNTarief van de geselecteerde verzendoptie
servicePointCodeString(255)NCode van de geselecteerde afhaallocatie
servicePointNameString(255)NNaam van de geselecteerde afhaallocatie
servicePointAddressString(255)NAdres van de geselecteerde afhaallocatie
notificationTypeEnumN

Geselecteerde meldingsmethode. Kan een van beide of beide volgende waarden bevatten:

  • email
  • sms

checkoutStatusRequest API-call


Je kunt ook de Paazl checkoutStatusRequest API-call gebruiken om de geselecteerde leveringsoptie op te halen en op te slaan wanneer je deze op jouw checkout-pagina weergeeft. Dit is de veiligste optie, maar het kan de prestaties iets vertragen omdat het een extra API-call en -respons vereist binnen jouw checkout.

Was dit artikel nuttig?

Dat is fantastisch!

Hartelijk dank voor uw beoordeling

Sorry dat we u niet konden helpen

Hartelijk dank voor uw beoordeling

Laat ons weten hoe we dit artikel kunnen verbeteren!

Selecteer tenminste een van de redenen
CAPTCHA-verificatie is vereist.

Feedback verzonden

We stellen uw moeite op prijs en zullen proberen het artikel te verbeteren