Docs
Management API
Site

Site

Get a Channel Site

GET /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

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

Update a Channel Site

PUT /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

object | application/json
  • url
    string

    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

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

Create a Channel Site

POST /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

object | application/json
  • url
    string

    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_id
    integer

    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

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

Delete a Channel Site

DELETE /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.

example

Response

Body

object | application/json

    example

    Did you find what you were looking for?