Docs
Management API
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
    required

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

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

response

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
    required

Parameters

  • store_hash in path - string
  • 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: storefront_settings | social | carousel | domains | currencies | notifications

  • custom_app_sections
    array[object]

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

response

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
    required

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

Response

Body

object | application/json
  • data
    integer

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?