Setup

Configure BigCommerce channel

Sets up a TakeShape project for a specific BigCommerce channel. Creates the project if needed, configures API keys, and installs BigCommerce scripts and pages.

post/bigcommerce/channels

Request

  • Base URL
    https://api.takeshape.io
  • Auth
    HTTP bearer

Request body

channelIdnumber required

BigCommerce channel ID

channelNamestring required

BigCommerce channel name

Example request

{
  "channelId": 1,
  "channelName": "My Storefront"
}

Response

List of channels with configuration status

idnumber required

Channel ID

namestring required

Channel name

typestring required

Channel type

platformstring required

Channel platform

statusstring required

Channel status

isEnabledboolean required

Whether the channel is enabled

isConfiguredboolean required

Whether the channel has a TakeShape project configured

siteUrlstring uri

Channel site URL if available

projectIdstring

TakeShape project ID if configured

tokenstring

API token for the TakeShape project if configured

Changes

No recorded changes to this operation across all 1 revision of this API.