lightspeedhq/ls-ecom-guzzle

A Guzzle HTTP Client extension for Lightspeed eCommerce

v1.0.1 2017-10-02 13:19 UTC

Requires

• php: >=5.6
• guzzlehttp/guzzle: ~6.0

MIT

• Michael Carey
• James Ratcliffe

• rest
• ecommerce
• api
• Guzzle
• pos
• lightspeed

README

The class is an extension of the Guzzle 6 PHP HTTP Client for use with the Lightspeed eCommerce API.

It works the same way as the standard Guzzle Client, but takes care of rate limiting.

This package was created for demonstration purposes and comes with no waranty.

Installation

Use this commmand to install with Composer:

$ composer require lightspeedhq/ls-ecom-guzzle:~1.0

Alternatively, you can add these lines to your composer.json file:

    "require": {
        "lightspeedhq/ls-ecom-guzzle": "~1.0"
    }

Usage Example

<?php

require 'vendor/autoload.php';
use LightspeedHQ\Ecom\EcomClient;

$cluster = 'us1';     // eu1 or us1
$language = 'us';     // Shop language
$key = 'xxxx';        // API key
$secret = 'xxxx';     // API secret

$client = new EcomClient($cluster, $language, $key, $secret);

// GET request with some URL paramters.
$query = ['since_id', 1];
$response = $client->get('customers', ['query' => $query]);
$customers = json_decode($response->getBody(), true)['customers'];
echo '<pre>';
echo '<h3>GET Test</h3>';
var_dump($customers[0]);
echo '</pre>';

// POST request to create a discount code
$payload = [
    'discount' => [
        'discount' => 5,
        'isActive' => true,
        'minumumAmount' => 50,
        'applyTo' => 'productscategories',
        'endDate' => '2018-01-01',
        'type' => 'percentage',
        'code' => '5PERCENT',
        'startDate' => '2017-01-01',
        'usageLimit' => 9999,
    ]
];
$response = $client->post('discounts', ['json' => $payload]);
echo '<h3>POST Test</h3>';
echo '<pre>';
var_dump(json_decode($response->getBody(), true));
echo '</pre>';