SEOshop Documentation

Lightspeed eCom PHP API client

We have constructed an easy to use PHP client that'll allow you to kickstart your new app or integration. Its super easy.

Please note that you are not required to use this client to connect to our API, or for building apps. It does however make it much easier. There are two kind of API keys: for apps (APP_KEY & APP_SECRET) and for single shops (api_key & api_secret). For authentication for apps in the App Store, please view the Installing an app tutorial.


You can install the client in a few different ways. We prefer that you install it through Composer as this will allow you to easily update to the most recent version. However this may not always be an option, therefor you can manually download the client or clone it from Github.

Install through Composer
Include the package in your composer.json file

    "require": {
        "seoshop/seoshop-php": "~1.7"

Install manually
Obtain the latest version of the Lightspeed eCom PHP API client. You can either pull it from our Github or download a zip file.

Clone the repository via Git

git clone

Download the client
WebshopappApiClient (WebshopappApiClient.php)

PHP example

include_once 'src/WebshopappApiClient.php';

//cluster_id is the location where the shop is hosted 

$api = new WebshopappApiClient('cluster_id', 'api_key', 'api_secret', 'en');

$shopInfo = $api->shop->get();

echo '<pre>';
echo '</pre>';
Was this article helpful? Yes No
One moment please
Thanks for your feedback.