Skip to main content

Brand Store

Brand Store provides access to the list of store brand relations.

Brand Store Properties

PropertyExampleDescription
id"918742..."Unique id of the brandStore
fk_brand"3A74DB..."Foreign key to the brand
fk_store"208C12..."Foreign key to the store
fk_warehouse"3D0B10..."Foreign key to the warehouse
detailobjectContains custom details for the brandStore.
brandStore_brand{related entity}Related brand details.
brandStore_store{related entity}Related store details.
brandStore_warehouse{related entity}Related warehouse details.

Brand Store Methods

GET/api/brandStore

Returns all brand stores for the current user scope with all published fields.

Example

Example of a returned brandStore entity
{
"response": {
"page": 1,
"pageCount": 1,
"recordsSent": 1,
"recordsFound": 1,
"brandStore": [
{
"id": "9187429F6CEE564A99474E897AA60AAA",
"fk_brand": "3A74DB24AE629E4489FD4CA55057A80B",
"fk_store": "208C12FCA2785342B073EBAA2AC403E7",
"fk_warehouse": "3D0B10892DE9204C9767B7C423268D3B",
"detail": {
"stockType": "inStock",
"adjustType": "Absolute",
"adjustValue": 0
},
"brandStore_store": {
"id": "208C12FCA2785342B073EBAA2AC403E7",
"fk_host": "CED75EE08F4EB94AB12C476CF09A7464",
"code": "LABCM",
"name": "LA Fashion Big Commerce",
"address": {
"line1": "",
"line2": "",
"line3": "",
"town": "",
"county": "",
"postcode": "",
"countryCode": ""
},
"detail": {},
"web": true,
"status": "inactive",
"source": "BIGCOMMERCE"
},
"brandStore_brand": {
"id": "3A74DB24AE629E4489FD4CA55057A80B",
"fk_company": "178BF5A865D4AB45B3535B56F8EF66DC",
"name": "LA Fashion",
"detail": null,
"code": "LAFASHION"
},
"brandStore_warehouse": {
"id": "3D0B10892DE9204C9767B7C423268D3B",
"fk_company": "178BF5A865D4AB45B3535B56F8EF66DC",
"code": "Main",
"name": "LA Fashion Warehouse",
"detail": {}
}
}
]
}
}