Media assets
The SupplierXM product API gives you access to three different types of media assets:
- Images
- Documents
- Recipes
Images
SupplierXM handles five different image formats: JPEG, PNG, GIF, TIFF, and WEBP formats.
Images sent by manufacturers are downloaded and stored on our side. We also ensure that an image is not present more than once by checking the image itself thanks to a cyclical redundancy check. If the image is new, it is simply added to the image list.
For every product image added, we generate different exportable image formats with different resolutions so you can use the resolution that works best for you. We generate the following resolutions:
- 1024x1024
- 512x512
- 256x256
- 128x128
- 64x64
To limit image size, all exportable images are converted to JPG format.
Image attributes
You can find images attributes at Attributes documentation
If you push data to SupplierXM, you should at least provide the URL of the image to download in the field
url
. See the Upload assets section for more information.This
url
is the unique identifier for image & document medias.
Mapping between SupplierXM and GS1 image attributes
As an official GDSN data pool, SupplierXM retrieves product images sent via GDSN.
You will find below all information regarding the ways SupplierXM integrates GS1 attributes.
GDSN attributes
Currently, the only types of referenced files sent through GDSN that are integrated in SupplierXM are the product images (referencedFileTypeCode
== PRODUCT_IMAGE, MOBILE_DEVICE_IMAGE, OUT_OF_PACKAGE_IMAGE).
For every product image sent through GDSN, SupplierXM integrates the following fields:
GDSN attributes | SupplierXM attributes |
---|---|
fileEffectiveEndDateTime | pictureEffectiveEndDate |
fileEffectiveStartDateTime | pictureEffectiveStartDate |
uniformResourceIdentifier | uniformResourceIdentifierOrigin |
canFilesBeEdited | canFilesBeEdited |
isFileBackgroundTransparent | isFileBackgroundTransparent |
verticalCameraAngleCode | pictureAngleVerticalCode |
isPrimaryFile | isPackshot |
GS1 image file name
If compliant with GS1 standard, SupplierXM automatically retrieves attributes from the image file name (when exchanged through GDSN)
For example, the following attributes will be deduced from an image file imported on SupplierXM from GDSN and whose image file name is '03046920000048_D1L1_001.png
digit position | example | SupplierXM attribute | GS1 value | SupplierXM value |
---|---|---|---|---|
16th | D | fileTypeCode | See page 63 for the labels . A C Z B D E F M H L T J K N Q R S U 3DR L1 L2 L3 L4 L5 L6 L7 L8 L9 L10 N/A | See the doc for the labels. Filter on "unit type"="Picture" and search for "fileTypeCode" 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
17th | 1 | productFaceCode | 0 - Not applicable 1 - Front 2 - Left 3 - Top 7 - Back 8 - Right 9 - Bottom | 6 "0 - Not applicable" 0 "1 - Front" 1 "2 - Left side" 2 "3 - Top" 3 "7 - Back" 4 "8 - Right side" 5 "9 - Bottom" |
18th | L | pictureAngleHorizontalCode | See page 63 for the labels . L C R N | See the doc for the labels. Filter on "unit type"="Picture" and search for "pictureAngleHorizontalCode" 0 1 2 3 |
19th | 1 | fileContentTypeCode | See bottom page 63 and page 64 for the labels and definitions 0 1 D K UNKNOWN A B C E F G H J L M Clean Not used: 1 -> 5 ARTWORK -> 16 | See the doc for the labels. Filter on "unit type"="Picture" and search for "fileContentTypeCode" 0 1 2 3 4 6 7 8 9 10 11 12 13 14 15 17 Not used: 5 16 |
20st-22rd | 001 | sequenceNumber |
Documents
Another media asset type you can access through our API is documents.
Accepted mime types
We currently only accept a restricted type (based on MIME) of documents :
- application/pdf
- application/zip
- application/postscript
- application/vnd.ms-excel
- application/vnd.ms-office
- application/vnd.ms-word
- application/vnd.ms-powerpoint
- application/msword
- application/msexcel
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.presentationml.presentation
- application/csv
- text/csv
- text/html
- text/plain
- text/rtf
Document attributes
Here are only described the main attributes you will find on your documents. More fields can be set here depending on your organization's configuration.
"documents": [
{
"tags": ["my_tag"],
"fileType": "application/pdf",
"url": "https://smedia.alkemics.com/product/document/hash.pdf",
"uniformResourceIdentifier": "https://smedia.alkemics.com/product/document/hash.pdf",
"fileName": "GTIN_L1_s01.pdf",
"documentLanguageList": [
{
"documentLanguageCode": {
"code": "fra",
"description": "French",
"label": "French"
}
}
],
"contentDescriptionText": [
{
"expressedIn": {
"code": "fra-FR",
"description": "French",
"label": "French",
"normalizedCode": "fr"
},
"data": "document fr"
}
],
"fileSize": 271169,
"documentTypeCode": {
"code": "CERTIFICATION",
"description": "Document which contains a special certification by a third party (e.g. International Food Standard [IFS], QS-Approval Mark for meat product, sausage, fruit, vegetables and potatoes or bio audits).",
"label": "Certification (assets)"
},
"documentTitleText": [
{
"expressedIn": {
"code": "fra-FR",
"description": "French",
"label": "French",
"normalizedCode": "fr"
},
"data": "document"
}
],
"scope": "public",
"createdAt": "2020-04-09T11:53:33",
"updatedAt": "2020-04-09T11:53:33"
}
]
Recipes
The last type of media asset you can access through our API are recipes.
"enriched_contents": [
{
"content": " example",
"updatedAt": "2017-02-20T15:30:56.772634",
"type": 1,
"createdAt": "2017-02-17T15:30:56.772487",
"title": " example"
}
]
A recipe is an enriched content asset whose type is 'Recipe' (code = 1).
Recipe mandatory attributes
content
: Recipe content stored as a formatted text in the attributecontent
. Format is done via HTML tags.title
: Recipe title. No formatting possible.type
: 1 -> Identify the enriched content type for recipes. It's the only available one for the moment.
Updated 8 months ago