Skip to main content

Warehouse

Store provides access to the list of warehouses.

Warehouse Properties​

PropertyExampleDescription
id"157194..."Unique id of the warehouse
code"TESTWH"The warehouse code.
name"Test Warehouse"The name of the warehouse.
detailobjectContains custom details for the warehouse.
warehouse_company{related entity}Related company details.

Warehouse Methods​

GET/api/warehouse

Returns all warehouses for the current user scope with all published fields.

Example​

Example of a returned warehouse entity
{
    "response": {
        "page": 1,
        "pageCount": 1,
        "recordsSent": 1,
        "recordsFound": 1,
        "warehouse": [
            {
                "id": "1571945CAB99744086F9FDFC9D9332D5",
                "fk_company": "0B8A97B5ECB75D47BEC30206F24F8429",
                "code": "TESTWH",
                "name": "Test Warehouse",
                "detail": {},
                "warehouse_company": {
                    "id": "0B8A97B5ECB75D47BEC30206F24F8429",
                    "code": "TEST",
                    "name": "Test International",
                    "detail": {
                        "address": {
                            "line1": "13 Gorst Road",
                            "line2": "Park Royal",
                            "line3": "",
                            "town": "London",
                            "county": "",
                            "postcode": "NW10 6LA",
                            "countryCode": "GB"
                        },
                        "email": "tom@testco.uk.com",
                        "telephone": "+44(0)20 8555 555",
                    },
                    "fk_sponsor": "9197BDF4B09F8543B4247E525EBD64A6",
                    "company_sponsor": {
                        "__KEY": "9197BDF4B09F8543B4247E525EBD64A6"
                    }
                }
            }
        ]
    }
}