Docs
Management API
Site Checkout URL

Site Checkout URL

Upsert a Siteʼs Checkout URL

PUT /channels/{channel_id}/site/checkout-url

Request

Creates or updates (upserts) a siteʼs checkout URL

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

    Unique site checkout URL. Must be valid and a sub-domain of primary channel URL.

    Example: https://checkout.kittens.mybigcommerce.com

example

Response

OK

Body

object | application/json
  • id
    integer

    The ID of the site.

  • 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 to which this site is attached. Each site belongs to a single channel, and each channel can have either zero or more sites.

  • created_at
    string

    The date-time that this site was created, formatted as an RFC-3339 string.

    Example: 2018-01-04T04:15:50.000Z

  • updated_at
    string

    The date-time that this site was last updated, formatted as an RFC-3339 string.

    Example: 2018-01-04T04:15:50.000Z

  • ssl_status
    string

    Indicates if a private/dedicated SSL is installed on this site, or if itʼs using shared SSL.

    Allowed: dedicated | shared

  • urls
    array[object]

    All URLs that belong to the site, including primary, canonical, and checkout URLs.

  • is_checkout_url_customized
    boolean

    Indicates whether the channel uses a custom checkout domain. When false, the checkout domain falls back to the default channel’s primary URL.

example

Delete a Siteʼs Checkout URL

DELETE /channels/{channel_id}/site/checkout-url

Request

Deletes a siteʼs checkout URL. After deletion, a shared checkout URL is used.

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

OK. data and meta are empty objects.

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?