| Table of Contents | ||||
|---|---|---|---|---|
|
General Discussion
Supplier
Apparel products that have multiple sizes per color typically have a set of images per color that apply to each size. To reduce the payload size and duplication of data across all sizes for a color, use the color field. The media API includes the productId without a partId and has the color field set to the official name for the color. When calling media for an individual part, only the relevant media for that part should be returned.
Include a classType with each image.
Provide only the largest image available and let distributors create optimized versions.
Provide a “primary” image for each part. So it’s easy for the correct image to be displayed by default.
Grouped product photos should not be associated with a part id. We typically see grouped product photos being associated with a part id making it difficult to associate the correct product photo with a particular part.
Provide a “blank” image of each part. This helps distributors create mockups.
Distributor
Do not use the Supplier repository as a CDN. Download media locally and this copy for internal use or on your website.
Leverage image resizing services / software to get media to the dimensions that are required (for example: ImageMagick, https://kraken.io/ , http://www.graphicsmagick.org/ )
Leverage the color field for color-sized based apparel when the color is known.
Media Content
Supplier Recommendations:
Grouped product photos should not be associated to a part ID
It is best to only have one unique high resolution image per image. Provide a pointer to the highest resolution that can be accessed via URL - this enables the consumer to resize the image to their needs and still keep the fidelity of the original image (ideally 1200x1200 pixels).
For products that have multiple color variants, it is important to have at least one image per color.
Field | Description | Required | Best Practice |
productId | The associated Product Id | YES | |
partId | The part Id associated to the product Id. | NO | |
url | The URL of the media location. Any valid URL can be returned including prefixes like http and ftp. | YES | |
mediaType | The type of media | YES | |
ClassTypeArray | An array of ClassType objects that classify of the media | YES | |
fileSize | The file size | NO | |
width | Width | NO | |
height | Height | NO | |
dpi | Dots per inch | NO | |
color | The color description | NO | |
DecorationArray | An array of decoration objects that describe the decorations associated with the media | NO | |
LocationArray | An array of location objects that describe the locations associated with the media | NO | |
description | Information about the media | NO | Don’t include product descriptions. Only describe the image. |
singlePart | Identifies whether the partId one to one corresponds with the image. (Use FALSE for group shots) | YES | |
changeTimeStamp | The date time since last change in UTC | NO |
Class Type
Supplier Recommendations:
Be sure to use the Primary Class Type (1006) to highlight the primary image for a product or part. You can also identify the primary image for both a blank and decorated image (please include both blank and decorated).
Although initially defined for video quality, the Class Types Standard definition (2000) and High definition (2001) can be useful when classifying large-size images.
Field | Description | Required | Best Practice |
classType | The classification of the media | YES | |
className | The classification short name | YES |
Decoration
Field | Description | Required | Best Practice |
decorationId | The decoration id associated with the media | YES | |
decorationName | The name of the decoration associated with the id | YES |
Location
Field | Description | Required | Best Practice |
locationId | The location id associated with the media | YES | |
locationName | The name of the location associated with the id | YES |