Skip to main content

Product

The Product resource returns the products and variants for the current scope. Products are always assigned to a Brand and will have at least one variant. Products may also have related Image records.

Product Properties​

PropertyExampleDescription
id"B83B86..."The unique id for the product
fk_brand"252DF4..."Forein key to the brand the product was uploaded for
code"ACC001"Product code
title"MINI SHOULDER BAG"Product title
category"ACC BAGS"The product category
description"MINI SHOULDER BAG"The product description
productBrand"Classic"The brand for the product
season"SS20"Season code
origin"CN"Country of origin. This should be the 2 character ISO country code
composition"100% Leather"Size range
careInstructions"Wipe only"Care instructions for the product
createdDate"2020-09-04T10:16:06"The date the product was originally created
status"New"The status of the product
detail{}Object containing any custom field values
commodityCode""The harmonised code for the product. Used for overseas shipping.
commodityDescription""The customs commodity description for the product. Used for overseas shipping.
product_brand{related entity}The related brand for which the product was uploaded
product_image[related entities]The related images for the product
product_variant[related entities]The related variants for the product

Product Methods​

Example of a returned product resource with all fields and related data (see example below).

GET/api/product

Returns all products in the system with all published fields.

POST/api/product

Allows for the posting of new products with related Variant and Image (in url format only) data.

Example​

Example of a returned product entity 
    "response": {
        "page": 1,
        "pageCount": 1,
        "recordsSent": 1,
        "recordsFound": 1,
        "product": [
            {
                "id": "B83B860F329AED4AAB35DFC2C8FD6264",
                "fk_brand": "252DF4B7194C8E4599CB0430920AFB5D",
                "code": "ACC001",
                "title": "MINI SHOULDER BAG",
                "category": "ACC BAGS",
                "description": "",
                "productBrand": "BRAND ACCESSORIES",
                "season": "SS20",
                "origin": "CHINA",
                "composition": "100% Leather",
                "careInstructions": "Wipe only",
                "commodityCode": "",
                "commodityDescription": "",
                "createdDate": "2020-09-04T10:16:06",
                "status": "New",
                "detail": null,
                "product_brand": {
                    "id": "252DF4B7194C8E4599CB0430920AFB5D",
                    "fk_company": "0B8A97B5ECB75D47BEC30206F24F8429",
                    "name": "Test",
                    "detail": {
                        "orderDelivery": "ilevel"
                    },
                    "code": "TEST",
                    "brand_company": {
                        "__KEY": "0B8A97B5ECB75D47BEC30206F24F8429"
                    }
                },
                "product_image": [],
                "product_variant": [
                    {
                        "id": "0A5EEDAF16F8D54486AB2AD7474B3994",
                        "fk_product": "B83B860F329AED4AAB35DFC2C8FD6264",
                        "code": "ACC001018__A",
                        "barcode": "5052011221399",
                        "colour": "Black",
                        "sequence": 1,
                        "size": "ONE",
                        "detail": null,
                        "vatable": false,
                        "rrp": 0,
                        "variant_product": {
                            "__KEY": "B83B860F329AED4AAB35DFC2C8FD6264"
                        }
                    },
                    {
                        "id": "798B05FC021E97438307EE8DF86B1676",
                        "fk_product": "B83B860F329AED4AAB35DFC2C8FD6264",
                        "code": "ACC001017__A",
                        "barcode": "5052011221405",
                        "colour": "Brown",
                        "sequence": 1,
                        "size": "ONE",
                        "detail": null,
                        "vatable": false,
                        "rrp": 0,
                        "variant_product": {
                            "__KEY": "B83B860F329AED4AAB35DFC2C8FD6264"
                        }
                    },
                    {
                        "id": "5E4366A3F2CD204E923420EBFECC5FB3",
                        "fk_product": "B83B860F329AED4AAB35DFC2C8FD6264",
                        "code": "ACC001207__A",
                        "barcode": "5052011221412",
                        "colour": "Multi",
                        "sequence": 1,
                        "size": "ONE",
                        "detail": null,
                        "vatable": false,
                        "rrp": 0,
                        "variant_product": {
                            "__KEY": "B83B860F329AED4AAB35DFC2C8FD6264"
                        }
                    }
                ]
            }
        ]
    }
}