ProductImage_Add

Adds an image to a product and, optionally, assigns it an image type. Point it at an image file that’s already on the server, or send the image as base64 data and it creates the file for you.

Before you begin#

• The API token needs ProductImage_Add, either assigned directly under Functions or through a group. See Create an API token.
• Requests must be signed if the token requires it. See Make a signed request with HMAC.
• You need the product’s ID, code or SKU, and the ImageType_ID of the image type to assign. ImageTypeList_Load_Query lists the image types.

Example requests#

Add an image that’s on the server#

Adds the image file at graphics/00000001/logo-min.png to product 1 as image type 1.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "ProductImage_Add",
    "Product_ID": 1,
    "Filepath": "graphics/00000001/logo-min.png",
    "ImageType_ID": 1
}

Add a base64 encoded image#

Creates the image file at Filepath from the base64 data in Image_Data, then adds it to the product.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "ProductImage_Add",
    "Product_ID": 1,
    "Filepath": "graphics/00000001/NEW.jpg",
    "ImageType_ID": 1,
    "Image_Data": "ADD_BASE64_IMAGE_HERE"
}

Request parameters#

Example response#

{
    "success": 1
}

Response parameters#

Error responses#

Related functions#

Try in Postman#

In the Miva: JSON API: Authenticated collection, open Products > ProductImage_Add. See Set Up Postman.