Properties
| Name | Type | Description |
|---|---|---|
| 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. |
| 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](https://www.ietf.org/rfc/rfc3339.txt) string. |
| updated_at | string | The date-time that this site was last updated, formatted as an [RFC-3339](https://www.ietf.org/rfc/rfc3339.txt) string. |
| ssl_status | string | Indicates if a private/dedicated SSL is installed on this site, or if itʼs using shared SSL. |
| urls | array | 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. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Site",
"title": "Site",
"type": "object",
"properties": {
"id": {
"description": "The ID of the site.",
"type": "integer"
},
"url": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "The date-time that this site was created, formatted as an [RFC-3339](https://www.ietf.org/rfc/rfc3339.txt) string.",
"example": "2018-01-04T04:15:50.000Z",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The date-time that this site was last updated, formatted as an [RFC-3339](https://www.ietf.org/rfc/rfc3339.txt) string.",
"example": "2018-01-04T04:15:50.000Z",
"format": "date-time"
},
"ssl_status": {
"type": "string",
"enum": [
"dedicated",
"shared"
],
"description": "Indicates if a private/dedicated SSL is installed on this site, or if it\u02bcs using shared SSL."
},
"urls": {
"type": "array",
"description": "All URLs that belong to the site, including `primary`, `canonical`, and `checkout` URLs.",
"items": {
"$ref": "#/components/schemas/Url"
}
},
"is_checkout_url_customized": {
"type": "boolean",
"description": "Indicates whether the channel uses a custom checkout domain. When `false`, the checkout domain falls back to the default channel\u2019s primary URL."
}
}
}