Store

Store provides access to the list of stores.

Store Properties

Property	Example	Description
id	"F93AB6..."	Unique id of the store store relation
code	"BCMStore"	The store code.
name	"Test BigCommerce Web Store"	The name of the store.
address	object	Object containing address details for the store.
detail	object	Contains custom details for the store.
store_host	{related entity}	Related host details.
store_brandStore	[related entities]	Collection of related brands that are also in this store.

See brandStore resource.

Store Methods

GET	/api/store

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

Example

Example of a returned store entity

{
    "response": {
        "page": 1,
        "pageCount": 3,
        "recordsSent": 1,
        "recordsFound": 3,
        "store": [
            {
                "id": "5AEE4DB4C520B740ABA582528E1E8ABB",
                "fk_host": "1DA1520A236D604187853C1469B22CC9",
                "code": "BCMStore",
                "name": "Test BigCommerce Web Store",
                "address": {
                    "line1": "",
                    "line2": "",
                    "line3": "",
                    "town": "",
                    "county": "",
                    "postcode": "",
                    "countryCode": ""
                },
                "detail": {
                    "status": "active",
                    "source": "BIGCOMMERCE"
                },
                "web": true,
                "store_host": {
                    "id": "1DA1520A236D604187853C1469B22CC9",
                    "name": "Test Big Commerce",
                    "type": "BIGCOMMERCE",
                    "detail": {
                        "shipMethods": [
                            {
                                "host": "ROW - (10 - 12 working days)",
                                "wh": "YMINTMAIL"
                            },
                            {
                                "host": "European Delivery (7 - 10 working days)",
                                "wh": "YMINTEREU"
                            },
                            {
                                "host": "US Delivery* (10 - 12 working days)",
                                "wh": "YMINTERUS"
                            },
                            {
                                "host": "Canada Delivery* (10 - 12 working days)",
                                "wh": "YMINTERCAD"
                            },
                            {
                                "host": "UK* Premium Next Working Day Delivery",
                                "wh": "YMUK24HR"
                            },
                            {
                                "host": "UK* Premium Next Working Day Delivery. Only available on orders placed Mon - Fri before 3pm",
                                "wh": "YMUK24HR"
                            },
                            {
                                "host": "UK* Free Delivery on all orders over £50",
                                "wh": "YMUK48HR"
                            },
                            {
                                "host": "UK* Standard Delivery (2 - 3 working days)",
                                "wh": "YMUK48HR"
                            },
                            {
                                "host": "UK* Standard Delivery (3 - 5 working days)",
                                "wh": "YMUK48HR"
                            },
                            {
                                "host": "UK Mail Saturday",
                                "wh": "YMUKSAT"
                            },
                            {
                                "host": "Free Shipping",
                                "wh": "YMUK48HR"
                            },
                            {
                                "host": "None",
                                "wh": "GLOBALIZE"
                            }
                        ]
                    },
                    "code": "BCTEST"
                },
                "store_brandStore": [
                    {
                        "brandStore_brand": {
                            "id": "17076BDDE29E96478A3F1C8E711BF122",
                            "fk_company": "7AE1E6E5FAE546499B36C013916DDEEC",
                            "name": "i.LEVEL",
                            "detail": null,
                            "code": "ILEVEL",
                            "brand_company": {
                                "__KEY": "7AE1E6E5FAE546499B36C013916DDEEC"
                            }
                        },
                        "brandStore_sale": []
                    }
                ]
            }
        ]
    }
}