(JavaScript) 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

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var 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.Login = "API_KEY";
http.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"
//   }
// }

var bdImage = new CkBinData();
success = bdImage.LoadFile("qa_data/jpg/starfish.jpg");
if (success == false) {
    console.log("Failed to load image file.");
    return;
}

var 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".
var resp = new CkHttpResponse();
success = http.HttpJson("POST","https://api.webshopapp.com/en/products/112265200/images.json",json,"application/json",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("Failed.");
    return;
}

// 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

var productImageId = jResp.IntOf("productImage.id");
var productImageSortOrder = jResp.IntOf("productImage.sortOrder");
var productImageCreatedAt = jResp.StringOf("productImage.createdAt");
var productImageUpdatedAt = jResp.StringOf("productImage.updatedAt");
var productImageExtension = jResp.StringOf("productImage.extension");
var productImageSize = jResp.IntOf("productImage.size");
var productImageTitle = jResp.StringOf("productImage.title");
var productImageThumb = jResp.StringOf("productImage.thumb");
var productImageSrc = jResp.StringOf("productImage.src");