PrestaShop is an open source e-commerce platform written in PHP. PrestaShop enables merchants to create, configure and host an online e-commerce store.

Use Codat’s API with PrestaShop to securely connect to, retrieve, and view your customers’ commerce transactions. The following data can be accessed with the Codat API:

  • Company Info — details of a linked company, such as their address, phone number, and company registration.
  • Customers — details of customers who have placed orders with the company.
  • Orders — details of all orders received by a company, including payments, service charges, and refunds.
  • Payments — amounts reserved against the customer's funding source.
  • Products — details of the products a company has available in the system, including the price and quantity of those products, and product variants (where available).


Configuration Requirements

PrestaShop is not a SaaS solution. It is a software package hosted by the merchant (or a hosting provider on their behalf), along with an HTTP server to handle web traffic to the store front-end and the API.

To share their data, a merchant will be required to:

  1. Share their Webservice key (i.e. API key) and store URL
  2. Ensure the HTTP server is correctly configured to allow the API to be accessed


Possible Errors in Merchant Connection

Guidance for merchants on how to configure the PrestaShop Webservice is included within Link, as well as accessible from PrestaShop directly. However due to the wide range of possible PrestaShop installations and hosting combinations, merchants may encounter unforeseen issues depending on how they have chosen to host and configure PrestaShop. For example, some HTTP servers and PrestaShop installations default to stripping out authorisation headers when accessing the API.

Codat Link will test whether a connection has been successful by making a test call to the API. If this fails, the following message is displayed:

"Unable to verify Store URL and Webservice Key. Please ensure you have entered the correct details and that the store's Webservice is enabled."


A Note on Pulling Data

Resources available to the PrestaShop software instance from which data is being pulled may vary wildly between small merchants (potentially running the software on their laptop) and large enterprises (likely hosted on much more scalable infrastructure). At the time of pulling data, it is not possible for Codat to know what resources are available; As a result, Codat restricts the amount of data it fetches at any one time to minimize impact on instances with the least resources. The trade-off is longer pull times for all PrestaShop instances, even where resources might be available to pull data at a higher velocity.


Add-ons and plugins

PrestaShop is an open-source platform built for configurability. A large part of its success is its wide-ranging add-on library featuring contributions from third party developers. Codat strives to add support for major add-ons where possible, but clients should be aware that in some cases it will not be possible to successfully retrieve data from customers with unsupported add-ons.

Did this page help you?