BigCommerce Docs

curl https://api.bigcommerce.com/stores/store_hash/v3/channels/1/channel-menus \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": {
    "bigcommerce_protected_app_sections": [
      "social",
      "carousel",
      "domains",
      "currencies",
      "notifications",
      "storefront_settings"
    ],
    "custom_app_sections": [
      {
        "title": "Overview",
        "query_path": "overview"
      },
      {
        "title": "Products",
        "query_path": "products"
      },
      {
        "title": "Campaigns",
        "query_path": "campaigns"
      },
      {
        "title": "Settings",
        "query_path": "settings"
      }
    ]
  },
  "meta": {}
}

Returns a list of control panel side navigation menus for a channel.

curl https://api.bigcommerce.com/stores/store_hash/v3/channels/1/channel-menus \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": {
    "bigcommerce_protected_app_sections": [
      "social",
      "carousel",
      "domains",
      "currencies",
      "notifications",
      "storefront_settings"
    ],
    "custom_app_sections": [
      {
        "title": "Overview",
        "query_path": "overview"
      },
      {
        "title": "Products",
        "query_path": "products"
      },
      {
        "title": "Campaigns",
        "query_path": "campaigns"
      },
      {
        "title": "Settings",
        "query_path": "settings"
      }
    ]
  },
  "meta": {}
}

UI Name

Permission

Parameter

Channel Listings

modify

store_channel_listings

Channel Listings

read-only

store_channel_listings_read_only

Channel Settings

modify

store_channel_settings

Channel Settings

read-only

store_channel_settings_read_only

Sites & Routes

modify

store_sites

Sites & Routes

read-only

store_sites_read_only

Header

Argument

Description

X-Auth-Token

access_token

For more about API accounts that generate access_tokens, see our Guide to API Accounts.

OAuth scopes

UI Name	Permission	Parameter
Channel Listings	modify	`store_channel_listings`
Channel Listings	read-only	`store_channel_listings_read_only`
Channel Settings	modify	`store_channel_settings`
Channel Settings	read-only	`store_channel_settings_read_only`
Sites & Routes	modify	`store_sites`
Sites & Routes	read-only	`store_sites_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

List Channel Menus

List Channel Menus

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Response

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Response

$	curl https://api.bigcommerce.com/stores/store_hash/v3/channels/1/channel-menus \
>	-H "Accept: application/json" \
>	-H "X-Auth-Token: <apiKey>"

1	{
2	"data": {
3	"bigcommerce_protected_app_sections": [
4	"social",
5	"carousel",
6	"domains",
7	"currencies",
8	"notifications",
9	"storefront_settings"
10	],
11	"custom_app_sections": [
12	{
13	"title": "Overview",
14	"query_path": "overview"
15	},
16	{
17	"title": "Products",
18	"query_path": "products"
19	},
20	{
21	"title": "Campaigns",
22	"query_path": "campaigns"
23	},
24	{
25	"title": "Settings",
26	"query_path": "settings"
27	}
28	]
29	},
30	"meta": {}
31	}