REST status and error codes
This article explains the various status codes and error messages you might receive when using the Paazl REST API. The information is grouped by endpoint.
Status codes are returned in the the API call's response header, and, where relevant, error messages are returned in the the API call's response body.
Note
The REST error codes you might receive could be a standard HTTP error code or one we have customized for the Paazl REST API. This article only explains those error codes and messages that we have modified specially for the Paazl REST API.
POST token
Status code | Message | Meaning |
---|---|---|
401 | Bad credentials |
The API key you specified in your request is invalid. There are three possible reasons for this error:
|
403 | Access denied |
The API secret you specified in your request is invalid. There are two possible reasons for this error:
|
422 | Reference is a required attribute |
You did not include a reference for the checkout session concerned. The reference attribute concerned is included in the body of the request. |
POST shippingOptions
Status code | Message | Meaning |
---|---|---|
200 | { "shippingOptions":[] "fullDeliveryDateSelection": false } |
A postal code or country code you specified is invalid. If a postal code or country code is invalid, Paazl will return an empty shipping option list. A postal code is invalid if it doesn't occur within a postal code range defined for the country concerned in your webshop's delivery matrix. A country code is invalid if, in that country's delivery matrix, a rate hasn't been set for an active shipping option. See How to activate shipping options and set shipping rates. |
400 | Value <tag> not allowed |
Make sure you specify a permitted value for the tags element in your request. Permitted values are listed in the error message body. |
401 | Bad credentials |
The API key you specified in your request is invalid. There are three possible reasons for this error:
|
422 | <attribute_name> is a required attribute |
Make sure you assign a value to the required attribute that is specified in the error message. |
POST pickupLocations
Status code | Message | Meaning |
---|---|---|
200 | { "pickupLocations":[] "fullDeliveryDateSelection": false } |
Postal code or country code is invalid If the postal code or country code is invalid, Paazl will return an empty pickup location list. A postal code is invalid if it doesn't occur within a postal code range defined for the country concerned in your webshop's delivery matrix. A country code is invalid if, in that country's delivery matrix, a rate hasn't been set for an active shipping option. See How to activate shipping options and set shipping rates. |
401 | Bad credentials |
The API key you specified in your request is invalid. There are three possible reasons for this error:
|
422 | <attribute_name> is a required attribute | Make sure you assign a value to the required attribute that is specified in the error message. |
POST checkout
Status code | Message | Meaning |
---|---|---|
400 | Checkout session reference is missing from request URL |
Make sure you have provided a checkout session reference as a parameter in the URL that requests checkout details. For example: https://api-acc.paazl.com/v1/checkout?reference=200000150 |
400 | Shipping option not configured for webshop |
The shipping option you've tried to save with a checkout details session either doesn't exist or isn't available for your webshop. The most likely reasons for this error are:
You will find a list of the shipping options configured for your webshop under Paazl Customer Support if you don't see a particular shipping option configured for your webshop. in your Paazl web app account. Contact |
400 | Shipping option not obtained from Paazl API |
You've tried to save a shipping option without having called the POST shippingOptions or POST pickupLocations first. These two calls ensure that the shipping options your customers can select conform to the shipping rules you configured in your Delivery Matrix. If you want change the shipping options Paazl returns to your webshop, change the configuration of your webshop's delivery matrix. About delivery matrices explains how to do this. |
422 | <attribute_name> is a required attribute | Make sure you assign a value to the required attribute that is specified in the error message. |
2110 | customer number <number> is incorrect | The number you need to enter is the "customer number" (a.k.a. "Postnummer" ) that DHL PackStation issues to customers as identification when they pick up their orders from a DHL pickup location. |
GET checkout
Status code | Message | Meaning |
---|---|---|
401 | Bad credentials |
The API key you specified in your request is invalid. There are three possible reasons for this error:
|
403 | Access denied |
The API secret you specified in your request is invalid. There are two possible reasons for this error:
|
404 | Reference not found |
Your webshop does not have a checkout session with the reference value that is used in the query string. Make sure you query with an existing checkout session reference. |
POST order
Status code | Message | Meaning |
---|---|---|
400 | The shop order with reference <reference> already exists | The order reference in your request already exists in your webshop. Make sure you give each order in your webshop a unique reference code. |
400 | Shipping option <identifier> not configured for webshop |
The shipping option you tried to save with an order either doesn't exist or isn't available for your webshop. The most likely reasons for this error are:
You will find a list of the shipping options configured for your webshop under Paazl Customer Support if you don't see a particular shipping option configured for your webshop. in your Paazl web app account. Contact |
422 | <attribute> is a required attribute | You have not given a value to one or more required POST order attributes. Consult the REST API reference to see which non-address attributes are required for a POST order request. |
DELETE order
Status code | Message | Meaning |
---|---|---|
400 | Order <reference> cannot be deleted because it has already been scanned. |
Once an order has been scanned, you can no longer delete it. Check your web app account under for a list of all your orders and their statuses.Note Orders in the web app overview with status "Scanned", "Delivery" or "Delivered" have all been scanned. |
404 | Order <reference> could not be found |
An order with the reference you specified does not exist in the Paazl database. Check your web app account under for a list of all the orders that you have saved to the Paazl database. |