Skip to content

DEVDOCS-6208: [update] add note for site domain tables #855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 39 additions & 3 deletions reference/channels.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ info:

A [Channel site](/docs/rest-management/channels/channel-site) refers to the domain associated with a channel.

> #### Note
> 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`.
## Resources

* [Sites and Routes API Reference](/docs/rest-management/sites)
Expand Down Expand Up @@ -467,7 +471,15 @@ paths:
summary: Upsert a Siteʼs Checkout URL
tags:
- Site Checkout URL
description: Creates or updates (upserts) a siteʼs checkout URL
description: |-
Creates or updates (upserts) a siteʼs checkout URL

<Callout type="info">
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`.
</Callout>
operationId: updateCheckoutUrl
parameters:
- $ref: '#/components/parameters/ContentType'
Expand Down Expand Up @@ -556,12 +568,20 @@ paths:
parameters:
- $ref: '#/components/parameters/Accept'
- $ref: '#/components/parameters/channel_id_path_param'

get:
summary: Get a Channel Site
description: |
Alias of `GET /sites?channel_id=channel_id`

Returns site data for the specified channel.

<Callout type="info">
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`.
</Callout>
operationId: getChannelSite
responses:
'200':
Expand All @@ -586,7 +606,15 @@ paths:
url: 'https://example.com/'
tags:
- Site
description: Updates a site for provided channel.
description: |-
Updates a site for provided channel.

<Callout type="info">
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`.
</Callout>
post:
responses:
'200':
Expand All @@ -606,7 +634,15 @@ paths:
channel_id: 123
tags:
- Site
description: Alias of POST `/sites`. Creates a site for provided channel.
description: |-
Alias of POST `/sites`. Creates a site for provided channel.

<Callout type="info">
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`.
</Callout>
delete:
responses:
'200':
Expand Down
7 changes: 7 additions & 0 deletions reference/sites.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ info:
description: |-
Create and manage [sites](#sites) and [routes](#routes) for [headless storefront](https://support.bigcommerce.com/s/article/The-Headless-Approach#what-mean) sales [channels](/docs/rest-management/channels).

<Callout type="info">
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`.
</Callout>

## [Sites](/docs/rest-management/sites)

Sites link [headless storefronts](/docs/storefront/headless) to sales [channels](/docs/rest-management/channels). To [create a site](/docs/rest-management/sites#create-a-site), send a `POST` request to `/stores/{{STORE_HASH}}/v3/sites`.
Expand Down