API Documentation - Image Metadata
Find out how brands and retailers can benefit from automated fashion e-commerce imagery
The API can be used for:
Data Import
Push Events
Image Storage
Image Padding
Image Resize
Image File Format
Introduction
Looklet offers the export of image metadata as JSON sidecar files together with the final images. This standard image metadata will include the fields listed in the table below.
The sidecar JSON files will be named the same as the image file (but with the .json extension) and will be stored at the same destination as the exported image.
Data fields:
Example: Look image metadata without personal information
Exported image: ABCD-1234_1_1.jpg
Sidecar file: ABCD-1234_1_1.json
{
"itemId": 1234,
"externalId": "ABCD-1234",
"studio": "Studio 1",
"designer": "DesignerName",
"category": "Blouse",
"batches": [
"example-batch1",
"example-batch2"
],
"colorLabel": "GREEN",
"exportType": "LOOK",
"pose": "Elena",
"angle": "Front",
"imageName": "ABCD-1234_1_1",
"model": {
"id": 1234,
"variantId": 3456,
"modelName": "Elena E1",
"modelExpiry": "2024-12-31",
"modelExpiryTimestamp": 1697625200000,
"modelLicenseNotes": "Print: Yes\nShoot Date: October 4, 2019\nUsage shall start 6 months from the shoot date"
},
"scene": {
"id": 1234,
"variantId": 4567
},
"stylingItems": [
{
"itemId": 1255,
"variantId": 12551,
"externalId": "DEF-456",
"studio": "Studio 1",
"designer": "DesignerName",
"category": "Pants",
"batches": [
"example-batch1",
"example-batch2"
],
"createdBy": {
"timestamp": 1510669991846
},
"customProperties": {
"CustomDate1": "2020-06-20",
"CustomDate2": "2020-12-31",
"CustomNumber1": "105",
"CustomNumber2": "20",
"CustomBoolean1": "True",
"CustomBoolean2": "False",
"CustomString1": "Custom String Here",
"CustomString2": ""
}
},
{
"itemId": 1431,
"variantId": 14311,
"externalId": "GHI-789",
"studio": "Studio 1",
"designer": "DesignerName",
"category": "Shoes",
"batches": [
"example-batch1",
"example-batch2"
],
"createdBy": {
"timestamp": 1566920909148
},
"customProperties": {
"CustomDate1": "2020-03-20",
"CustomDate2": "2020-10-31",
"CustomNumber1": "1050",
"CustomNumber2": "15.5",
"CustomBoolean1": "True",
"CustomBoolean2": "False",
"CustomString1": "Custom String Here",
"CustomString2": ""
}
}
],
"createdBy": {
"timestamp": 1566920909148
},
"exportedBy": {
"timestamp": 1567094931323
},
"customProperties": {
"CustomDate1": "2020-01-20",
"CustomDate2": "2020-12-31",
"CustomNumber1": "105",
"CustomNumber2": "3.14",
"CustomBoolean1": "True",
"CustomBoolean2": "False",
"CustomString1": "Custom String Here",
"CustomString2": ""
},
"comments": [
{
"timestamp": 1456996672,
"comment": "Comment text"
}
]
}
Example: Display image metadata with personal information
Exported image: ABCD-1234_display_1.png
Sidecar file: ABCD-1234_display_1.json
{
"itemId": 1234,
"externalId": "ABCD-1234",
"studio": "Studio 1",
"designer": "DesignerName",
"category": "Dress",
"batches": [
"example-batch1",
"example-batch2"
],
"colorLabel": "GREEN",
"exportType": "GHOST",
"pose": "Elena",
"imageName": "ABCD-1234_display_1",
"createdBy": {
"name": "John Doe",
"email": "john@doe.com",
"timestamp": 1566920909148
},
"exportedBy": {
"name": "John Doe",
"email": "john@doe.com",
"timestamp": 1567094931323
},
"customProperties": {
"CustomDate1": "2020-01-20",
"CustomDate2": "2020-12-31",
"CustomNumber1": "105",
"CustomNumber2": "3.14",
"CustomBoolean1": "True",
"CustomBoolean2": "False",
"CustomString1": "Custom String Here",
"CustomString2": ""
},
"comments": [
{
"createdBy": {
"name": "John Doe",
"email": "john@doe.com"
},
"timestamp": 1456996672,
"comment": "Comment text"
}
]
}