(Perl) Lightspeed - Get All Products

Retrieve a list of all product objects from this shop.

For more information, see https://developers.lightspeedhq.com/ecom/endpoints/product/#get-all-products

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$http = chilkat::CkHttp->new();

# Implements the following CURL command:

# curl https://api.shoplightspeed.com/en/products.json \
#   -u {key}:{secret}

# 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 the correct cluster for your shop.  Here are the choices:
# eu1 https://api.webshopapp.com/en/
# us1 https://api.shoplightspeed.com/en/
$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://api.webshopapp.com/en/products.json",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

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

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

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

# {
#   "product": {
#     "id": 20967267,
#     "createdAt": "2019-05-28T15:25:46+00:00",
#     "updatedAt": "2019-05-28T17:16:16+00:00",
#     "isVisible": true,
#     "visibility": "visible",
#     "hasMatrix": false,
#     "data01": "",
#     "data02": "",
#     "data03": "",
#     "url": "lookin-sharp-tee",
#     "title": "Lookin' Sharp T-Shirt",
#     "fulltitle": "Lookin' Sharp T-Shirt",
#     "description": "Description of the Lookin' Sharp T-Shirt",
#     "content": "<p>Long Description of the Lookin' Sharp T-Shirt</p>",
#     "set": {
#       "id": 2785,
#       "createdAt": "2019-05-28T15:32:12+00:00",
#       "updatedAt": "2019-05-28T15:42:59+00:00",
#       "name": "Shirts",
#       "options": [
#         {
#           "id": 4626,
#           "sortOrder": 1,
#           "name": "Size",
#           "values": [
#             {
#               "id": 14045,
#               "sortOrder": 1,
#               "name": "S"
#             },
#             {
#               "id": 14046,
#               "sortOrder": 2,
#               "name": "M"
#             },
#             {
#               "id": 14047,
#               "sortOrder": 3,
#               "name": "L"
#             }
#           ]
#         }
#       ]
#     },
#     "brand": {
#       "resource": {
#         "id": 1171202,
#         "url": "brands/1171202",
#         "link": "https://api.shoplightspeed.com/us/brands/1171202.json"
#       }
#     },
#     "categories": {
#       "resource": {
#         "id": false,
#         "url": "categories/products?product=20967267",
#         "link": "https://api.shoplightspeed.com/us/categories/products.json?product=20967267"
#       }
#     },
#     "deliverydate": {
#       "resource": {
#         "id": 6488,
#         "url": "deliverydates/6488",
#         "link": "https://api.shoplightspeed.com/us/deliverydates/6488.json"
#       }
#     },
#     "image": {
#       "createdAt": "2019-05-28T15:25:46+00:00",
#       "updatedAt": "2019-05-28T15:25:46+00:00",
#       "extension": "jpg",
#       "size": 86649,
#       "title": "17x35x-jcfk-88na-udwd-5hck-z63u-img-16-e0aa4f57-f4",
#       "thumb": "https://cdn.shoplightspeed.com/shops/000001/files/14119398/50x50x2/17x35x-jcfk-88na-udwd-5hck-z63u-img-16-e0aa4f57-f4.jpg",
#       "src": "https://cdn.shoplightspeed.com/shops/000001/files/14119398/17x35x-jcfk-88na-udwd-5hck-z63u-img-16-e0aa4f57-f4.jpg"
#     },
#     "images": {
#       "resource": {
#         "id": false,
#         "url": "products/20967267/images",
#         "link": "https://api.shoplightspeed.com/us/products/20967267/images.json"
#       }
#     },
#     "relations": {
#       "resource": {
#         "id": false,
#         "url": "products/20967267/relations",
#         "link": "https://api.shoplightspeed.com/us/products/20967267/relations.json"
#       }
#     },
#     "metafields": {
#       "resource": {
#         "id": false,
#         "url": "products/20967267/metafields",
#         "link": "https://api.shoplightspeed.com/us/products/20967267/metafields.json"
#       }
#     },
#     "reviews": {
#       "resource": {
#         "id": false,
#         "url": "reviews?product=20967267",
#         "link": "https://api.shoplightspeed.com/us/reviews.json?product=20967267"
#       }
#     },
#     "type": false,
#     "attributes": {
#       "resource": {
#         "id": false,
#         "url": "products/20967267/attributes",
#         "link": "https://api.shoplightspeed.com/us/products/20967267/attributes.json"
#       }
#     },
#     "supplier": {
#       "resource": {
#         "id": 78794,
#         "url": "suppliers/78794",
#         "link": "https://api.shoplightspeed.com/us/suppliers/78794.json"
#       }
#     },
#     "tags": {
#       "resource": {
#         "id": false,
#         "url": "tags/products?product=20967267",
#         "link": "https://api.shoplightspeed.com/us/tags/products.json?product=20967267"
#       }
#     },
#     "variants": {
#       "resource": {
#         "id": false,
#         "url": "variants?product=20967267",
#         "link": "https://api.shoplightspeed.com/us/variants.json?product=20967267"
#       }
#     },
#     "movements": {
#       "resource": {
#         "id": false,
#         "url": "variants/movements?product=20967267",
#         "link": "https://api.shoplightspeed.com/us/variants/movements.json?product=20967267"
#       }
#     }
#   }
# }

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

$productId = $jResp->IntOf("product.id");
$productCreatedAt = $jResp->stringOf("product.createdAt");
$productUpdatedAt = $jResp->stringOf("product.updatedAt");
$productIsVisible = $jResp->BoolOf("product.isVisible");
$productVisibility = $jResp->stringOf("product.visibility");
$productHasMatrix = $jResp->BoolOf("product.hasMatrix");
$productData01 = $jResp->stringOf("product.data01");
$productData02 = $jResp->stringOf("product.data02");
$productData03 = $jResp->stringOf("product.data03");
$productUrl = $jResp->stringOf("product.url");
$productTitle = $jResp->stringOf("product.title");
$productFulltitle = $jResp->stringOf("product.fulltitle");
$productDescription = $jResp->stringOf("product.description");
$productContent = $jResp->stringOf("product.content");
$productSetId = $jResp->IntOf("product.set.id");
$productSetCreatedAt = $jResp->stringOf("product.set.createdAt");
$productSetUpdatedAt = $jResp->stringOf("product.set.updatedAt");
$productSetName = $jResp->stringOf("product.set.name");
$productBrandResourceId = $jResp->IntOf("product.brand.resource.id");
$productBrandResourceUrl = $jResp->stringOf("product.brand.resource.url");
$productBrandResourceLink = $jResp->stringOf("product.brand.resource.link");
$productCategoriesResourceId = $jResp->BoolOf("product.categories.resource.id");
$productCategoriesResourceUrl = $jResp->stringOf("product.categories.resource.url");
$productCategoriesResourceLink = $jResp->stringOf("product.categories.resource.link");
$productDeliverydateResourceId = $jResp->IntOf("product.deliverydate.resource.id");
$productDeliverydateResourceUrl = $jResp->stringOf("product.deliverydate.resource.url");
$productDeliverydateResourceLink = $jResp->stringOf("product.deliverydate.resource.link");
$productImageCreatedAt = $jResp->stringOf("product.image.createdAt");
$productImageUpdatedAt = $jResp->stringOf("product.image.updatedAt");
$productImageExtension = $jResp->stringOf("product.image.extension");
$productImageSize = $jResp->IntOf("product.image.size");
$productImageTitle = $jResp->stringOf("product.image.title");
$productImageThumb = $jResp->stringOf("product.image.thumb");
$productImageSrc = $jResp->stringOf("product.image.src");
$productImagesResourceId = $jResp->BoolOf("product.images.resource.id");
$productImagesResourceUrl = $jResp->stringOf("product.images.resource.url");
$productImagesResourceLink = $jResp->stringOf("product.images.resource.link");
$productRelationsResourceId = $jResp->BoolOf("product.relations.resource.id");
$productRelationsResourceUrl = $jResp->stringOf("product.relations.resource.url");
$productRelationsResourceLink = $jResp->stringOf("product.relations.resource.link");
$productMetafieldsResourceId = $jResp->BoolOf("product.metafields.resource.id");
$productMetafieldsResourceUrl = $jResp->stringOf("product.metafields.resource.url");
$productMetafieldsResourceLink = $jResp->stringOf("product.metafields.resource.link");
$productReviewsResourceId = $jResp->BoolOf("product.reviews.resource.id");
$productReviewsResourceUrl = $jResp->stringOf("product.reviews.resource.url");
$productReviewsResourceLink = $jResp->stringOf("product.reviews.resource.link");
$productType = $jResp->BoolOf("product.type");
$productAttributesResourceId = $jResp->BoolOf("product.attributes.resource.id");
$productAttributesResourceUrl = $jResp->stringOf("product.attributes.resource.url");
$productAttributesResourceLink = $jResp->stringOf("product.attributes.resource.link");
$productSupplierResourceId = $jResp->IntOf("product.supplier.resource.id");
$productSupplierResourceUrl = $jResp->stringOf("product.supplier.resource.url");
$productSupplierResourceLink = $jResp->stringOf("product.supplier.resource.link");
$productTagsResourceId = $jResp->BoolOf("product.tags.resource.id");
$productTagsResourceUrl = $jResp->stringOf("product.tags.resource.url");
$productTagsResourceLink = $jResp->stringOf("product.tags.resource.link");
$productVariantsResourceId = $jResp->BoolOf("product.variants.resource.id");
$productVariantsResourceUrl = $jResp->stringOf("product.variants.resource.url");
$productVariantsResourceLink = $jResp->stringOf("product.variants.resource.link");
$productMovementsResourceId = $jResp->BoolOf("product.movements.resource.id");
$productMovementsResourceUrl = $jResp->stringOf("product.movements.resource.url");
$productMovementsResourceLink = $jResp->stringOf("product.movements.resource.link");
$i = 0;
$count_i = $jResp->SizeOfArray("product.set.options");
while ($i < $count_i) {
    $jResp->put_I($i);
    $id = $jResp->IntOf("product.set.options[i].id");
    $sortOrder = $jResp->IntOf("product.set.options[i].sortOrder");
    $name = $jResp->stringOf("product.set.options[i].name");
    $j = 0;
    $count_j = $jResp->SizeOfArray("product.set.options[i].values");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $id = $jResp->IntOf("product.set.options[i].values[j].id");
        $sortOrder = $jResp->IntOf("product.set.options[i].values[j].sortOrder");
        $name = $jResp->stringOf("product.set.options[i].values[j].name");
        $j = $j + 1;
    }

    $i = $i + 1;
}