Upsert Siteʼs Checkout URL

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/channels/:channel_id/site/checkout-url

PUT

/stores/:store_hash/v3/channels/:channel_id/site/checkout-url

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/channels/1/site/checkout-url \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": 1,
  "url": "https://kittens.mybigcommerce.com/",
  "channel_id": 1,
  "created_at": "2018-01-04T04:15:50.000Z",
  "updated_at": "2018-01-04T04:15:50.000Z",
  "urls": [
    {
      "url": "https://kittens.mybigcommerce.com",
      "type": "primary",
      "created_at": "2022-03-22T13:08:59Z",
      "updated_at": "2022-03-22T13:08:59Z"
    },
    {
      "url": "https://store-abc.store.bcdev",
      "type": "canonical",
      "created_at": "2022-03-22T13:08:59Z",
      "updated_at": "2022-03-22T13:08:59Z"
    },
    {
      "url": "https://checkout.kittens.mybigcommerce.com",
      "type": "checkout",
      "created_at": "2022-03-23T10:21:11Z",
      "updated_at": "2022-03-29T13:44:22Z"
    }
  ],
  "is_checkout_url_customized": true
}

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

For the “urls” object, we no longer modify the www prefix of the primary URL. The API returns URLs exactly as the customer enters them, similar to the “url” field.

If the customer saves a URL with www, the API returns it with www.
If the customer saves a URL without www, the API returns it without www.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Channel Listings	modify	`store_channel_listings`
Channel Listings	read-only	`store_channel_listings_read_only`
Channel Settings	modify	`store_channel_settings`
Channel Settings	read-only	`store_channel_settings_read_only`
Sites & Routes	modify	`store_sites`
Sites & Routes	read-only	`store_sites_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

channel_idlongRequired

The ID of a channel.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

urlstringOptionalformat: "uri"

Unique site checkout URL. It must be valid and a sub-domain of the primary channel URL. Note: The API will change all URLs using the HTTP protocol to HTTPS.

Response

idintegerOptional

The ID of the site.

urlstringOptional

The fully qualified URL (including host and scheme) where this site is hosted. All URLs generated for this site will be appended to this.

channel_idintegerOptional

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_atdatetimeOptional

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

updated_atdatetimeOptional

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

ssl_statusenumOptional

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

Allowed values:

urlslist of objectsOptional

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

is_checkout_url_customizedbooleanOptional

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

Errors

422

Unprocessable Entity Error