Component: PHOTOS
Abstract
This component allows retrieving photo metadata as well as setting selected properties for already uploaded photos. Note that this component doesn’t allow uploading any new photos but allows deleting already existing photos. Please use a separate photo upload endpoint to upload new photo(s) to an existing experience product.
Values for this component are provisioned via ExperienceComponentsDto.photos which is an array of PhotoDtos.
Photos are optional. Make sure a complete list of photos is sent on update as omitting records will lead to photo deletion.
Note: if a product is a box, own photos or those of parent product will be served, depending on box settings.
Attributes of PhotoDto
Attribute JSON path | Data type | Mandatory | Settable | Notes |
id | long | ✓ | ID of this photo object | |
originalUrl | string | URL of the photo, if original image is to be retrieved. Derived files are meant to use different URLs which provide near-instant access to transformed (resized, cropped, etc.) invariants. Note that this
attribute is read only - one can not create nor update the URL using the same endpoint which creates or updates photo metadata as file upload handling is done separately. Passing the same value is OK | ||
url | string | The URL to use for the end user. Typically this is the URL given by the CDN provider. Make sure that this URL is never cached as it may change without further notice. The property can only be retrieved and never set | ||
caption | string | ✓ | Caption for this photo | |
alternateText | string | ✓ | Text for visually impaired users | |
height | int | Height of this picture, in pixels (if available) | ||
width | int | Width of this picture, in pixels (if available) |
Did this answer your question?
😞
😐
🤩