Docs
Management API
Channels
Menus

Menus

Get Channel Menus

GET /channels/{channel_id}/channel-menus

Request

Returns list of Control Panel side navigation menus for a channel.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • channel_id in path - integer
    required
    The ID of a channel.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/channels/[channel_id]/channel-menus' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

response

{
"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": {}
}

Create Channel Menus

POST /channels/{channel_id}/channel-menus

Request

Creates or replaces list of control panel side navigation menus for a channel.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • channel_id in path - integer
    required
    The ID of a channel.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • bigcommerce_protected_app_sections    array[string]

    List of channel-specific control panel menu navigation items and corresponding settings pages an app developer can choose to enable for the subject channel. Protected settings override any settings set in those UI sections at the storewide level. Learn more in the Building Storefront Channels tutorial.

    Allowed: overview | storefront_settings | localization | carousel | script_manager | currencies | payments | checkout | domains | notifications | social | pages | data_solutions

  • custom_app_sections    array[object]

Create Channel Menus

{
"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"
}
]
}

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

response

{
"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": {}
}

Delete Channel Menus

DELETE /channels/{channel_id}/channel-menus

Request

Deletes control panel side navigation menus for a channel.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • channel_id in path - integer
    required
    The ID of a channel.

example

curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/channels/[channel_id]/channel-menus' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

  • data    integer

  • meta    object

    Response metadata.

example

{
"data": 0,
"meta": {}
}
Did you find what you were looking for?
Get a Channel ListingGet Channel Menus