Channels
Get a Channel Site
GET /stores/{store_hash}/v3/channels/{channel_id}/site
Request
Alias of GET /sites?channel_id=channel_id
Returns site data for the specified 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.
Update a Channel Site
PUT /stores/{store_hash}/v3/channels/{channel_id}/site
Request
Updates a site for provided 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
urlstring
The Fully Qualified URL (including host and scheme) where this site is hosted. All URLs generated for this site will be appended to this.
example
Response
Body
dataobject
metaobject
Response metadata.
Create a Channel Site
POST /stores/{store_hash}/v3/channels/{channel_id}/site
Request
Alias of POST /sites
. Creates a site for provided 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
urlstring
The Fully Qualified URL (including host and scheme) where this site is hosted. All URLs generated for this site will be appended to this.
Example: http://kittens.mybigcommerce.com/
channel_idinteger
The channel this site is attached to. Each site belongs to a single channel, and each channel can have either zero or one sites.
example
Response
Body
dataobject
metaobject
Response metadata.
Delete a Channel Site
DELETE /stores/{store_hash}/v3/channels/{channel_id}/site
Request
Deletes the Channelʼs site.
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.