Channels
Get Channel Menus
GET /stores/{store_hash}/v3/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
dataobject
metaobject
Response metadata.
response
Create Channel Menus
POST /stores/{store_hash}/v3/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
bigcommerce_protected_app_sectionsarray[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.
custom_app_sectionsarray[object]
Response
Body
dataobject
metaobject
Response metadata.
response
Delete Channel Menus
DELETE /stores/{store_hash}/v3/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
datainteger
metaobject
Response metadata.