The Product Media Object

Product may have a mixture of photos, videos and 360 degree media items. 

Properties

Importing Media Files

Importing new files for image, video and frames properties may be done using one of the following methods:

• Content URI
  Upload files to the Media Library manually through the Evance admin panel, then reference their location using a Content URI. For example, uploading a file named my-image-name.jpg to the images/products subfolder in the Media Library is referenced as ~/content/images/products/my-image-name.jpg. Whilst this may be appropriate when importing Products via CSV, it may not be desirable for API integrations.

• External URLs
  With the exception of YouTube and Vimeo URLs for video content, Evance will import file data from external URLs (http or https) into the Media Library. The file will be placed in an directory in the Media Library, which is calculated based on the URL and the mime type of the file.

• Data URIs
  You can provide base64 encoded binary file data as a Data URI. Evance will calculate the directory within the Media Library based on the mime type of the file and the filename will be based on an md5 of the file contents.

When importing External URLs or Data URIs, you may want greater control over the resulting filename and location within the Media Library. Supply your data within an object consisting of src, filename and directory properties:

Example

The example below highlights how to specify both a filename and directory for a media image imported using a Data URI.

{
    "data": {
        "image": {
            "src": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg...",
            "filename": "my-image-name.png",
            "directory": "˜/content/images/products"
        }
    }
}

If the filename already exists within the directory supplied, the import may be ignored as Evance may assume the file already exists.

Sequencing Media Items

The position of media items is represented by the sequence property. When importing data you may adjust the sequence of media files by supplying either an integer (starting from 1) or a position object containing placement and id properties.

When supplying an integer, existing media items with a sequence greater than or equal to the sequence supplied will increment by one. If you supply a sequence number greater than the current number of media items, your media file will be positioned last and the appropriate sequence number will be recalculated and returned as part of the response.

Alternatively, you may supply a position object consisting of the following properties:

Example

The example below shows a request to position the media item before another media item with ID 1234.

{
    "data": {
        "sequence": {
            "placement": "before",
            "id": 1234
        }
    }
}