Skip to main content

Type Alias: PrepareCartImage()

PrepareCartImage = (base64, cartId, cartItemId) => Promise<string | null>

Function

Prepares an image for inclusion in a cart item.

This method uploads a product image (provided as a base64 string) to storage and returns a reference path that can be used when adding items to the cart. The image serves as a visual representation of the specific configuration being ordered.

Cart images improve the shopping experience by providing visual confirmation of selected products in the cart, order confirmation emails, and order history.

Parameters​

base64​

string

Base64-encoded image data

cartId​

string

ID of the cart the image will be associated with

cartItemId​

string

ID of the specific cart item the image represents

Returns​

Promise<string | null>

A promise resolving to the storage path of the uploaded image, or null if unsuccessful

Example​

// Create an image of the current configuration for a cart item
window.mimeeqApp.utils.takeScreenshot('jpg', 800)
  .then(async (imageBase64) => {
    const imagePath = await window.mimeeqApp.actions.prepareCartImage(
      imageBase64,
      'cart_123',
      'item_456'
    );

    // Add the item to cart with the prepared image
    addToCartWithImage(imagePath);
  });