(PHP Extension) Lightspeed - Upload an Image

Create (uploads) a new product image.

For more information, see https://developers.lightspeedhq.com/ecom/endpoints/productimage/#post-create-a-new-image

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Implements the following CURL command:

// curl   -u API_KEY:API_SECRET \
//     -H "Content-Type: application/json" \
//     -X POST \
//     -d '{
//   "productImage": {
//     "attachment": "base64-encoded-contents",
//     "filename": "the-filename-with-extension-goes-here.jpg"
//   }
// }' \
// "https://api.webshopapp.com/en/products/product_id/images.json"

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

$http->put_Login('API_KEY');
$http->put_Password('API_SECRET');

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "productImage": {
//     "attachment": "base64-encoded-contents",
//     "filename": "the-filename-with-extension-goes-here.jpg"
//   }
// }

$bdImage = new CkBinData();
$success = $bdImage->LoadFile('qa_data/jpg/starfish.jpg');
if ($success == false) {
    print 'Failed to load image file.' . "\n";
    exit;
}

$json = new CkJsonObject();
$json->UpdateString('productImage.attachment',$bdImage->getEncoded('base64'));
$json->UpdateString('productImage.filename','starfish.jpg');

$http->SetRequestHeader('Content-Type','application/json');

// The product ID in the URL is "112265200".
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://api.webshopapp.com/en/products/112265200/images.json','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "productImage": {
//     "id": 13362569,
//     "sortOrder": 3,
//     "createdAt": "2019-06-06T14:52:07+00:00",
//     "updatedAt": "2019-06-06T14:52:07+00:00",
//     "extension": "png",
//     "size": 8016,
//     "title": "logo",
//     "thumb": "https://cdn.shoplightspeed.com/shops/000001/files/14271562/50x50x2/logo.png",
//     "src": "https://cdn.shoplightspeed.com/shops/000001/files/14271562/logo.png"
//   }
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

$productImageId = $jResp->IntOf('productImage.id');
$productImageSortOrder = $jResp->IntOf('productImage.sortOrder');
$productImageCreatedAt = $jResp->stringOf('productImage.createdAt');
$productImageUpdatedAt = $jResp->stringOf('productImage.updatedAt');
$productImageExtension = $jResp->stringOf('productImage.extension');
$productImageSize = $jResp->IntOf('productImage.size');
$productImageTitle = $jResp->stringOf('productImage.title');
$productImageThumb = $jResp->stringOf('productImage.thumb');
$productImageSrc = $jResp->stringOf('productImage.src');

?>