Channels
Upsert a Siteʼs Checkout URL
PUT /stores/{store_hash}/v3/channels/{channel_id}/site/checkout-url
Request
Creates or updates (upserts) a siteʼs checkout URL
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
urlstring
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
idinteger
The ID of the site.
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 to which this site is attached. Each site belongs to a single channel, and each channel can have either zero or more sites.
created_atstring
The date-time that this site was created, formatted as an RFC-3339 string.
Example: 2018-01-04T04:15:50.000Z
updated_atstring
The date-time that this site was last updated, formatted as an RFC-3339 string.
Example: 2018-01-04T04:15:50.000Z
ssl_statusstring
Indicates if a private/dedicated SSL is installed on this site, or if itʼs using shared SSL.
Allowed: dedicated | shared
urlsarray[object]
All URLs that belong to the site, including
primary
,canonical
, andcheckout
URLs.is_checkout_url_customizedboolean
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 /stores/{store_hash}/v3/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 headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- channel_id in path - integerrequired
The ID of a channel.
example
Response
OK. data
and meta
are empty objects.
Body
dataobject
metaobject
Response metadata.