post

/channels

Creates a Channel.

Required Fields

  • type
  • platform
  • name

Usage Notes

Type & platform combination must be a valid pair:

Platform Accepted Type
square pos
vend pos
clover pos
facebook marketplace,marketing
amazon marketplace
ebay marketplace
wordpress storefront
drupal storefont
acquia storefront
bloomreach storefront
deity storefront
google_shopping marketing
custom storefront, pos, marketing, marketplace

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Body

1 Example
Schema
object
type
string
1 validation + required
name
string

Name of the channel as it will appear to merchants in BC

required
external_id
string

Associated ID within a system / platform outside of BC.

is_enabled
boolean

Determines whether the channel is enabled on a store. In order to disable a channel, set is_enabled to false.

This results in the channel not showing in the ‘Products’ section of the BC control panel.

2 validations
platform
string
1 validation
status
string
1 validation

Responses

1 Example
Schema
object
data
object
meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token