Brand

Brand provides access to the list of brands.

Brand Properties

Property	Example	Description
id	"F93AB6294DD7334DA0423C89E3D7C0B2"	Unique id of the brand store relation
code	"TEST"	The brand code.
name	"Test Brand"	The name of the brand.
detail	object	Contains details of how orders are delivered.
brand_company	{related entity}	Related company entity see Company
brand_brandStore	[related entities]	Collection of related stores that this brand is subscribed to. See brandStore resource.

Brand Methods

GET	/api/brand

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

Example

Example of a returned brand entity

{
    "response": {
        "page": 1,
        "pageCount": 1,
        "recordsSent": 2,
        "recordsFound": 2,
        "brand": [
            {
                "id": "252DF4B7194C8E4599CB0430920AFB5D",
                "code": "TEST",
                "name": "Test",
                "detail": {
                    "orderDelivery": "ilevel"
                },
                "brand_company": {
                    "id": "0B8A97B5ECB75D47BEC30206F24F8429",
                    "code": "Test",
                    "name": "Test Company",
                    "detail": {
                        "address": {
                            "line1": "38 Park Road North",
                            "line2": "",
                            "line3": "",
                            "town": "Bedford",
                            "county": "Bedfordshire",
                            "postcode": "MK41 7RH",
                            "countryCode": "GB"
                        },
                        "email": "help@test.co.uk",
                        "telephone": "+44(0)20 8961 2299",
                    },
                    "company_sponsor": {
                        "id": "9197BDF4B09F8543B4247E525EBD64A6",
                        "name": "Test",
                        "detail": null
                    }
                },
                "brand_brandStore": [
                    {
                        "id": "A0E87AE771BAC84DBA994FEC70537912",
                        "detail": {
                            "stockType": "inStock",
                            "adjustType": "Absolute",
                            "adjustValue": 0
                        },
                        "brandStore_store": {
                            "id": "5AEE4DB4C520B740ABA582528E1E8ABB",
                            "fk_host": "1DA1520A236D604187853C1469B22CC9",
                            "code": "BCMStore",
                            "name": "Test BigCommerce Web Store",
                            "address": {
                                "line1": "",
                                "line2": "",
                                "line3": "",
                                "town": "",
                                "county": "",
                                "postcode": "",
                                "countryCode": ""
                            },
                            "detail": {
                                "status": "active",
                                "credentials": {
                                    "url": "https://api.bigcommerce.com/stores/",
                                    "storeHash": "1cxrfddc9m",
                                    "key": "q8l6urafe1muwgiuchivzofckbz8fdq",
                                    "pass": "gxxuho9cxmb2zp5n8qvoq1wpn1x2tre",
                                    "version": "v2"
                                },
                                "source": "BIGCOMMERCE"
                            },
                            "web": true,
                            "store_host": {
                                "__KEY": "1DA1520A236D604187853C1469B22CC9"
                            }
                        },
                        "brandStore_brand": {
                            "__KEY": "252DF4B7194C8E4599CB0430920AFB5D"
                        },
                        "brandStore_warehouse": {
                            "__KEY": "1571945CAB99744086F9FDFC9D9332D5"
                        }
                    }
                ]
            }
        ]
    }
}