Site
Get a Channel Site
GET https://api.bigcommerce.com/stores/{store_hash}/v3/channels/{channel_id}/siteRequest
Alias of GET /sites?channel_id=channel_id
Returns site data for the specified channel.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- channel_id in path - integerrequiredThe ID of a channel.
example
curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/channels/[channel_id]/site' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
Response
Body
object | application/json
dataobject
Update a Channel Site
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/channels/{channel_id}/siteRequest
Updates a site for provided channel.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- channel_id in path - integerrequiredThe ID of a channel.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
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
{
"url": "string"
}
Response
Body
object | application/json
dataobject
Create a Channel Site
POST https://api.bigcommerce.com/stores/{store_hash}/v3/channels/{channel_id}/siteRequest
Alias of POST
/sites
. Creates a site for provided channel.Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- channel_id in path - integerrequiredThe ID of a channel.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
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: https://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
{
"url": "https://kittens.mybigcommerce.com/",
"channel_id": 0
}
Response
Body
object | application/json
dataobject
Delete a Channel Site
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/channels/{channel_id}/siteRequest
Deletes the Channelʼs site.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- channel_id in path - integerrequiredThe ID of a channel.
example
curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/channels/[channel_id]/site' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
Response
Body
object | application/json
example
{}
Did you find what you were looking for?