Skip to main content

Stock

Stock provides access to the stock data.

Stock Properties​

PropertyExampleDescription
id"C8F0D5..."The unique id for the stock record
fk_warehouse"325EAC..."The foreign key to the related warehouse
fk_variant"E8B21D..."The foreign key to the related variant
inStock3The currently in stock quantity
demand0The sort order for the size within the SKU
supply0Barcode for the item (usually EAN)
lastUpdate"2020-08-05T12:27:08"The last date the stock record was updated
stock_warehouse{related entity}The related warehouse record
stock_variant{related entity}The related variant record

See brandStore resource.

Stock Methods​

GET/api/stock

Returns all stock records for the current user scope with all published fields.

Example​

Example of a returned stock entity
{
    "response": {
        "page": 1,
        "pageCount": 1,
        "recordsSent": 1,
        "recordsFound": 1,
        "stock": [
            {
                "id": "C8F0D5C87583194FB8E2DE1EF5D4170E",
                "fk_warehouse": "325EACF57C0EF2429F620E85612D7694",
                "fk_variant": "E8B21D73AE5BFB48B4A395CE11F9270C",
                "inStock": 1,
                "demand": 0,
                "supply": 0,
                "lastUpdate": "2020-08-05T12:27:08",
                "stock_warehouse": {
                    "id": "325EACF57C0EF2429F620E85612D7694",
                    "fk_company": "7AE1E6E5FAE546499B36C013916DDEEC",
                    "code": "Main",
                    "name": "Main Warehouse",
                    "detail": null,
                    "warehouse_company": {
                        "__KEY": "7AE1E6E5FAE546499B36C013916DDEEC"
                    }
                },
                "stock_variant": {
                    "id": "E8B21D73AE5BFB48B4A395CE11F9270C",
                    "fk_product": "7F1F51F350490A41BE5E705C66180E34",
                    "code": "7042792    B",
                    "barcode": "5051829215354",
                    "colour": "Cream/Navy Broken Stripe",
                    "sequence": 2,
                    "size": "S",
                    "detail": {
                        "rrp": 36,
                        "price": 28,
                        "importFile": "7F2EE4A8A4A7704F8F823F37343E08E4"
                    },
                    "vatable": false,
                    "rrp": 36,
                    "variant_product": {
                        "id": "7F1F51F350490A41BE5E705C66180E34",
                        "fk_brand": "17076BDDE29E96478A3F1C8E711BF122",
                        "code": "7042",
                        "title": "Long skirt",
                        "category": "Skirts",
                        "description": "Long summer skirt in various colours",
                        "productBrand": "Tester",
                        "season": "AW20",
                        "origin": "China",
                        "composition": "100% Cotton",
                        "careInstructions": "Wash at 40\r",
                        "createdDate": "",
                        "status": "",
                        "detail": {
                            "importFile": "7F2EE4A8A4A7704F8F823F37343E08E4"
                        },
                        "commodityCode": "",
                        "product_brand": {
                            "id": "17076BDDE29E96478A3F1C8E711BF122",
                            "fk_company": "7AE1E6E5FAE546499B36C013916DDEEC",
                            "name": "i.LEVEL",
                            "detail": null,
                            "code": "ILEVEL",
                            "brand_company": {
                                "__KEY": "7AE1E6E5FAE546499B36C013916DDEEC"
                            }
                        }
                    }
                }
            }
        ]
    }
}