Skip to main content

Host Variant

Host Variant provides access to host specific product variants. Variants are connected to Host Products and represent the colour and size variations of the Host Product. There will always be at least one variant for a Host Product. Host instances of variants can have different colour and size names from the original variant due to host mapping requirements.

Host Variant Properties​

PropertyExampleDescription
id"21990B..."Unique id of the order
fk_hostProduct"AFB765..."Foreign key to the related product
fk_variant"26F4AC..."Foreign key to the related product
code"ACC001018__A"The variants code
hostReference"5052011221399"The host reference (if applicable) for the variant
hostColour"Black"Variant colour
hostSize"ONE"Variant size.
currentPrice20The current selling price in the host this is the primary price. For more detail use the priceChange and price resources
detail{}Object containing any custom variant properties
hostVariant_variant{related entity}The related variant detail
hostVariant_hostProduct{related entity}The related hostProduct detail

Host Variant Methods​

GET/api/hostVariant

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

Example​

Example of a returned variant entity
{
    "response": {
        "page": 1,
        "pageCount": 1,
        "recordsSent": 1,
        "recordsFound": 1,
        "hostVariant": [
            {
                "id": "21990BB05B04424CA577B2DFD09C184E",
                "fk_hostProduct": "AFB765C68637F04384B64895935325C0",
                "fk_variant": "26F4ACA9CF60B84A8F9ABE5D9DA1E5A2",
                "hostSize": "L",
                "hostColour": "Cream/Navy Broken Stripe",
                "status": 2,
                "hostReference": "51892",
                "currentPrice": 0,
                "detail": {},
                "hostVariant_variant": {
                    "id": "26F4ACA9CF60B84A8F9ABE5D9DA1E5A2",
                    "fk_product": "1A383540D5E0E143847BD0C6B47DE456",
                    "code": "7039792    D",
                    "barcode": "5051829215330",
                    "colour": "Cream/Navy Broken Stripe",
                    "sequence": 4,
                    "size": "L",
                    "detail": {
                        "rrp": 35,
                        "price": 27,
                        "importFile": "7F2EE4A8A4A7704F8F823F37343E08E4"
                    },
                    "vatable": false,
                    "rrp": 0
                },
                "hostVariant_hostProduct": {
                    "id": "AFB765C68637F04384B64895935325C0",
                    "fk_store": "5AEE4DB4C520B740ABA582528E1E8ABB",
                    "fk_product": "1A383540D5E0E143847BD0C6B47DE456",
                    "name": "Cropped frill shirt",
                    "status": "Uploaded",
                    "createdDate": "2020-07-17T14:37:56",
                    "validatedDate": "2020-08-28T15:26:51",
                    "sentToHostDate": "2020-09-01T09:39:30",
                    "discontinueDate": "",
                    "detail": {
                        "webDescription": "Web description?",
                        "images": [
                            {
                                "sourceURL": "http://cdn.yumi.co.uk/filestore/3/5/1/3/9_504fa8cb81831fd/35139scr_15b6e98ceae5e03.jpg?v=2020-07-07+13%3A43%3A52",
                                "type": "SECONDARY",
                                "code": "Cream/Navy Broken Stripe",
                                "codeType": "COLOUR",
                                "variants": [
                                    "21990BB05B04424CA577B2DFD09C184E",
                                    "4855E089BA833740851821EAAABEE514",
                                    "89979BF07440AC45B00CD9BB783E4B6C",
                                    "98101F0E910E364E82FEBA7BFDE10A6A"
                                ]
                            },
                            {
                                "sourceURL": "http://cdn.yumi.co.uk/filestore/3/5/1/1/8_680122a44a89df0/35118scr_8d518e3c5cead59.jpg?v=2020-07-07+13%3A27%3A42",
                                "type": "PRIMARY",
                                "code": "7039",
                                "codeType": "COLOUR",
                                "variants": [],
                                "note": ""
                            },
                            {
                                "sourceURL": "https://dev.ilevelconnect.co.uk/brandImages/17076BDDE29E96478A3F1C8E711BF122/BB55DC9437001A44A3F21E0DA56A40A4_blue_dress.jpg",
                                "type": "SECONDARY",
                                "code": "7039",
                                "codeType": "COLOUR",
                                "variants": [],
                                "note": "aaa"
                            },
                            {
                                "sourceURL": "http://cdn.yumi.co.uk/filestore/3/5/1/3/9_504fa8cb81831fd/35139scr_15b6e98ceae5e03.jpg?v=2020-07-07+13%3A43%3A52",
                                "type": "SWATCH",
                                "code": "7039",
                                "codeType": "COLOUR",
                                "variants": []
                            }
                        ],
                        "colourBreakdown": [
                            {
                                "colour": "Cream/Navy Broken Stripe",
                                "webDescription": "Cropped shirt with frill hem",
                                "approved": true
                            }
                        ],
                        "categories": [
                            {
                                "id": 26,
                                "value": "New In"
                            },
                            {
                                "id": 36,
                                "value": "Tops"
                            }
                        ],
                        "searchKeywords": [
                            {
                                "id": 1,
                                "value": "Testing Keyword",
                                "uid": "1",
                                "boundindex": 0,
                                "uniqueid": "1620-22-16-30-182425",
                                "visibleindex": 0
                            }
                        ],
                        "featured": true,
                        "availability": "Avail",
                        "warranty": "Warranty",
                        "width": 10,
                        "height": 15,
                        "depth": 20,
                        "weight": 5
                    },
                    "hostReference": ""
                }
            }
        ]
    }
}