This is an old documentation. Go to the latest Customer's Canvas docs

getAllItems Method


  • getAllItems(options?: object ) : Promise < Item [] >
  • Lists all design elements in the product.

        // If we have successfully obtained the product.
        .then(async function(product) {
            // Get the item list.
            const items = await product.getAllItems({includeMockup: false});
            console.log("The product contains " + items.length + " design elements");


    • Optional options: object

      Additional parameters.

      • includeMockup: boolean

        Allows you to include mockup items in the resulting array. The default value is true.

    Returns Promise < Item [] >

    An array of elements from all product pages.