Paazl voor ontwikkelaars

REST API

REST status- en foutcodes

Dit artikel legt de verschillende statuscodes en foutmeldingen uit die je kunt ontvangen bij het gebruiken van de Paazl REST API. De informatie is gegroepeerd per endpoint.


Statuscodes worden geretourneerd in de respons-header van de API-call en, waar relevant, worden foutmeldingen geretourneerd in de respons-body van de API-call.


Opmerking


De REST-foutcodes die je kunt ontvangen, kunnen een standaard HTTP-foutcode zijn of een code die we hebben aangepast voor de Paazl REST API. Dit artikel legt alleen de foutcodes en meldingen uit die we speciaal voor de Paazl REST API hebben gewijzigd.


POST token


StatuscodeMeldingBetekenis
401Bad credentials

De API-key die je in je verzoek hebt opgegeven is ongeldig. Er zijn drie mogelijke redenen voor deze fout:

  • Je hebt mogelijk een nieuwe API-key gegenereerd in het account van je Paazl-webapp en gebruikt nog een verouderde key in je API-verzoek.
  • De (backend-)implementatie van jouw webshop verandert mogelijk de key bij het indienen van een verzoek bij de authenticatieserver van Paazl.
  • De combinatie van je inloggegevens en de Paazl-omgeving is onjuist, zoals Paazl staging-inloggegevens sturen naar productie.
403Access denied

De API-secret die je in je verzoek hebt opgegeven is ongeldig. Er zijn twee mogelijke redenen voor deze fout:

  • Je hebt mogelijk een nieuwe API-secret gegenereerd in het account van je Paazl-webapp of gebruikt nog een verouderde secret in je API-verzoek.
  • De (backend-)implementatie van jouw webshop verandert mogelijk de secret bij het indienen van een verzoek bij de authenticatieserver van Paazl.
422Reference is a required attribute

Je hebt geen referentie meegestuurd voor de desbetreffende checkoutsessie. Het attribuut reference hoort te worden opgenomen in de body van het verzoek.


POST shippingOptions


StatuscodeMeldingBetekenis
200{"shippingOptions":[] "fullDeliveryDateSelection": false}

Een postcode of landcode die je hebt opgegeven is ongeldig.


Als een postcode of landcode ongeldig is, retourneert Paazl een lege lijst met verzendopties.


Een postcode is ongeldig als deze niet voorkomt binnen een postcodereeks die voor het desbetreffende land is gedefinieerd in de verzendmatrix (delivery matrix) van jouw webshop.


Een landcode is ongeldig als er in de verzendmatrix van dat land geen tarief is ingesteld voor een actieve verzendoptie.

400Value <tag> not allowed

Zorg ervoor dat je een toegestane waarde opgeeft voor het element tags in je verzoek. Toegestane waarden worden vermeld in de body van de foutmelding.

401Bad credentials

De API-key die je in je verzoek hebt opgegeven is ongeldig. Er zijn drie mogelijke redenen voor deze fout:

  • Je hebt mogelijk een nieuwe API-key gegenereerd in het account van je Paazl-webapp en gebruikt nog een verouderde key in je API-verzoek.
  • De (backend-)implementatie van jouw webshop verandert mogelijk de key bij het indienen van een verzoek bij de authenticatieserver van Paazl.
  • De combinatie van je inloggegevens en de Paazl-omgeving is onjuist, zoals Paazl staging-inloggegevens sturen naar productie.
422<attribute_name> is a required attribute

Zorg ervoor dat je een waarde toekent aan het verplichte attribuut dat in de foutmelding wordt gespecificeerd.


POST pickupLocations


StatuscodeMeldingBetekenis
200{"pickupLocations":[] "fullDeliveryDateSelection": false}

De postcode of landcode is ongeldig.


Als de postcode of landcode ongeldig is, retourneert Paazl een lege lijst met afhaallocaties.


Een postcode is ongeldig als deze niet voorkomt binnen een postcodereeks die voor het desbetreffende land is gedefinieerd in de verzendmatrix (delivery matrix) van jouw webshop.


Een landcode is ongeldig als er in de verzendmatrix van dat land geen tarief is ingesteld voor een actieve verzendoptie.

401Bad credentials

De API-key die je in je verzoek hebt opgegeven is ongeldig. Er zijn drie mogelijke redenen voor deze fout:

  • Je hebt mogelijk een nieuwe API-key gegenereerd in het account van je Paazl-webapp en gebruikt nog een verouderde key in je API-verzoek.
  • De (backend-)implementatie van jouw webshop verandert mogelijk de key bij het indienen van een verzoek bij de authenticatieserver van Paazl.
  • De combinatie van je inloggegevens en de Paazl-omgeving is onjuist, zoals Paazl staging-inloggegevens sturen naar productie.
422<attribute_name> is a required attribute

Zorg ervoor dat je een waarde toekent aan het verplichte attribuut dat in de foutmelding wordt gespecificeerd.


POST checkout


StatuscodeMeldingBetekenis
400Checkout session reference is missing from request URL

Zorg ervoor dat je een referentie voor de checkoutsessie hebt opgegeven als parameter in de URL die de checkoutdetails opvraagt. Bijvoorbeeld:


https://api-acc.paazl.com/v1/checkout?reference=200000150

400Shipping option not configured for webshop

De verzendoptie die je probeert op te slaan bij een sessie met checkoutdetails, bestaat niet of is niet beschikbaar voor jouw webshop. De meest waarschijnlijke redenen voor deze fout zijn:

  • Je implementatie gebruikt een naam voor de verzendoptie die niet bestaat, wellicht omdat je de naam niet rechtstreeks overneemt uit de lijst met beschikbare verzendopties die Paazl retourneert met de POST shippingOptions-methode.
  • Je hebt de desbetreffende verzendoptie geconfigureerd in de staging-omgeving van Paazl, maar (nog) niet in de productieomgeving.

Je vindt een lijst met de geconfigureerde verzendopties voor jouw webshop onder Vervoerders > Verzendopties (Carriers > Shipping options) in het account van je Paazl-webapp. Neem contact op met de klantenservice van Paazl als je een specifieke verzendoptie niet geconfigureerd ziet staan voor jouw webshop.

400Shipping option not obtained from Paazl API

Je hebt geprobeerd een verzendoptie op te slaan zonder dat je eerst de aanroep POST shippingOptions of POST pickupLocations hebt uitgevoerd. Deze twee aanroepen zorgen ervoor dat de verzendopties die je klanten kunnen selecteren, voldoen aan de verzendregels die je hebt geconfigureerd in je verzendmatrix (Delivery Matrix).


Als je de verzendopties wilt wijzigen die Paazl aan jouw webshop retourneert, wijzig dan de configuratie van de verzendmatrix van jouw webshop.

422<attribute_name> is a required attribute

Zorg ervoor dat je een waarde toekent aan het verplichte attribuut dat in de foutmelding wordt gespecificeerd.

2110customer number <number> is incorrect

Het nummer dat je moet invoeren is het "klantnummer" (ook wel bekend als "Postnummer") dat DHL PackStation aan klanten verstrekt als identificatie wanneer zij hun bestellingen ophalen bij een DHL-afhaallocatie.


GET checkout


StatuscodeMeldingBetekenis
401Bad credentials

De API-key die je in je verzoek hebt opgegeven is ongeldig. Er zijn drie mogelijke redenen voor deze fout:

  • Je hebt mogelijk een nieuwe API-key gegenereerd in het account van je Paazl-webapp en gebruikt nog een verouderde key in je API-verzoek.
  • De (backend-)implementatie van jouw webshop verandert mogelijk de key bij het indienen van een verzoek bij de authenticatieserver van Paazl.
  • De combinatie van je inloggegevens en de Paazl-omgeving is onjuist, zoals Paazl staging-inloggegevens sturen naar productie.
403Access denied

De API-secret die je in je verzoek hebt opgegeven is ongeldig. Er zijn twee mogelijke redenen voor deze fout:

  • Je hebt mogelijk een nieuwe API-secret gegenereerd in het account van je Paazl-webapp en gebruikt nog een verouderde secret in je API-verzoek.
  • De (backend-)implementatie van jouw webshop verandert mogelijk de secret bij het indienen van een verzoek bij de authenticatieserver van Paazl.
404Reference not found

Jouw webshop heeft geen checkoutsessie met de referentiewaarde die in de query-string wordt gebruikt. Zorg ervoor dat je een verzoek indient met een bestaande referentie van een checkoutsessie.


POST order


StatuscodeMeldingBetekenis
400The shop order with reference <reference> already exists

De orderreferentie in je verzoek bestaat al in jouw webshop. Zorg ervoor dat je elke bestelling in jouw webshop een unieke referentiecode geeft.

400Shipping option <identifier> not configured for webshop

De verzendoptie die je probeert op te slaan bij een bestelling bestaat niet of is niet beschikbaar voor jouw webshop. De meest waarschijnlijke redenen voor deze fout zijn:

  • Je implementatie gebruikt een naam voor de verzendoptie die niet bestaat, wellicht omdat je de naam niet rechtstreeks overneemt uit de lijst met beschikbare verzendopties die Paazl retourneert met de POST shippingOptions-methode.
  • Je hebt de desbetreffende verzendoptie geconfigureerd in de staging-omgeving van Paazl, maar (nog) niet in de productieomgeving.

Je vindt een lijst met de geconfigureerde verzendopties voor jouw webshop onder Vervoerders > Verzendopties (Carriers > Shipping options) in het account van je Paazl-webapp. Neem contact op met de klantenservice van Paazl als je een specifieke verzendoptie niet geconfigureerd ziet staan voor jouw webshop.

422<attribute> is a required attribute

Je hebt geen waarde toegekend aan een of meer verplichte POST order-attributen. Raadpleeg de REST API-referentie om te zien welke niet-adresgerelateerde attributen vereist zijn voor een POST order-verzoek.


DELETE order


StatuscodeMeldingBetekenis
400Order <reference> cannot be deleted because it has already been scanned.

Zodra een bestelling is gescand, kun je deze niet meer verwijderen. Controleer het account van je webapp onder Zendingen > Alle zendingen (Shipments > All shipments) voor een lijst van al je bestellingen en hun statussen.


Opmerking


Bestellingen in het overzicht van de webapp met de status "Scanned", "Delivery" of "Delivered" zijn allemaal gescand.

404Order <reference> could not be found

Een bestelling met de door jou opgegeven referentie bestaat niet in de database van Paazl. Controleer het account van je webapp onder Zendingen > Alle zendingen (Shipments > All shipments) voor een lijst van alle bestellingen die je hebt opgeslagen in de Paazl-database.

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