Skip to main content

Image

Image provides access to the images uploaded against products.

Image Properties​

PropertyExampleDescription
id"46748D..."The unique id for the image record
fk_product"1A3835..."The foreign key to the product
sourceURL"http://test.co.uk/test.jpg"The url for the image
type"Primary"The image type
code""The code of the image
codeType""Tye code type
note""A note for the image
detail{object}An object which can contain custom image detail
image_product{related entity}The related product record detail

Image Methods​

GET/api/image

Returns all image records for the current scope with all published fields.

POST*/api/image

Allows for the updating or creation of image records.

Example​

Example of a returned image entity with all fields
{
    "response": {
        "page": 1,
        "pageCount": 1,
        "recordsSent": 1,
        "recordsFound": 1,
        "image": [
            {
                "id": "46748DB542651743BA0BD1174AD868E1",
                "fk_product": "1A383540D5E0E143847BD0C6B47DE456",
                "sourceURL": "http://test.co.uk/test.jpg",
                "sequence": 0,
                "type": "Primary",
                "codeType": "",
                "code": "",
                "note": "",
                "detail": null,
                "image_product": {
                    "id": "1A383540D5E0E143847BD0C6B47DE456",
                    "fk_brand": "17076BDDE29E96478A3F1C8E711BF122",
                    "code": "7039",
                    "title": "Cropped frill shirt",
                    "category": "Tops",
                    "description": "Cropped shirt with frill hem",
                    "productBrand": "Tester",
                    "season": "AW20",
                    "origin": "China",
                    "composition": "100% Cotton",
                    "careInstructions": "Wash at 40\r",
                    "createdDate": "",
                    "status": "",
                    "detail": {
                        "importFile": "7F2EE4A8A4A7704F8F823F37343E08E4"
                    },
                    "commodityCode": "",
                    "product_brand": {
                        "__KEY": "17076BDDE29E96478A3F1C8E711BF122"
                    }
                }
            }
        ]
    }
}