{"openapi":"3.1.0","info":{"title":"Admin Management: Settings","version":"1.0.0"},"paths":{"/stores/{store_hash}/v3/settings/analytics":{"get":{"operationId":"getAnalyticsProviders","summary":"List Web Analytics Providers","description":"Returns a list of web analytics providers.","tags":["analytics"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Analytics_getAnalyticsProviders_Response_200"}}}}}}},"/stores/{store_hash}/v3/settings/analytics/{id}":{"get":{"operationId":"getAnalyticsProvider","summary":"Get Web Analytics Provider","description":"Returns a single web analytics provider data for a default channel.","tags":["analytics"],"parameters":[{"name":"id","in":"path","description":"Web Analytics Provider ID.","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsProvider"}}}},"400":{"description":"Bad request. Authentication Required.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse400"}}}},"404":{"description":"The requested resource was not found. Please specify valid Web Analytics Provider ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse404"}}}}}},"put":{"operationId":"updateAnalyticsProvider","summary":"Update Web Analytics Provider","description":"Updates a single web analytics provider data for a default channel.","tags":["analytics"],"parameters":[{"name":"id","in":"path","description":"Web Analytics Provider ID.","required":true,"schema":{"type":"integer"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsProvider"}}}},"400":{"description":"Bad request. Authentication Required.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse400"}}}},"404":{"description":"The requested resource was not found. Please specify valid Web Analytics Provider ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse404"}}}},"409":{"description":"Web Analytics Provider was in conflict with another Web Analytics Provider. This can be caused by duplicated unique values (such as ID).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse409"}}}},"422":{"description":"Web Analytics Provider data was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse422"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"data_tag_enabled":{"type":"boolean"},"enabled":{"type":"boolean"},"is_oauth_connected":{"description":"Any type"},"name":{"type":"string"},"version":{"type":"number","format":"double"}}}}}}}},"/stores/{store_hash}/v3/settings/catalog":{"get":{"operationId":"getSettingsCatalog","summary":"Get Catalog Settings","description":"Returns catalog settings.\n\n - Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.","tags":["catalog"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK. `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalog_getSettingsCatalog_Response_200"}}}}}},"put":{"operationId":"updateSettingsCatalog","summary":"Update Catalog Settings","description":"Updates catalog settings.\n\n - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied with `null` value in order to delete overrides per channel.","tags":["catalog"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK. `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalog_updateSettingsCatalog_Response_200"}}}}},"requestBody":{"description":"null set for a particular field removes override on a channel level and means inheritance from a global level","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSettings"}}}}}},"/stores/{store_hash}/v3/settings/email-statuses":{"get":{"operationId":"getSettingsEmailStatuses","summary":"Get Transactional Email Settings","description":"Get global transactional email settings or channel specific overrides by `channel_id`.","tags":["emailStatuses"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email Statuses_getSettingsEmailStatuses_Response_200"}}}}}},"put":{"operationId":"updateSettingsEmailStatuses","summary":"Update Transactional Email Settings","description":"Update global transactional email settings or create channel specific overrides by `channel_id`.","tags":["emailStatuses"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email Statuses_updateSettingsEmailStatuses_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnabledTransactionalEmails"}}}}}},"/stores/{store_hash}/v3/settings/favicon/image":{"post":{"operationId":"createSettingsFaviconImage","summary":"Create Favicon Image","description":"Uploads an image file to use as the storefront favicon. Supported MIME types include GIF, JPEG, and PNG. \n\n  - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only.\n  - The uploaded image can be up to 10 MB. Larger files result in an error.","tags":["faviconImage"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"204":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"422":{"description":"Failed to save!","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"FaviconFile":{"type":"string","format":"binary"}}}}}}}},"/stores/{store_hash}/v3/settings/inventory":{"get":{"operationId":"getSettingsInventory","summary":"Get Inventory Settings","description":"Get Inventory Settings","tags":["inventory"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory_getSettingsInventory_Response_200"}}}},"422":{"description":"Provided settings could not be applied for some reason - detailed errors in the response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"operationId":"updateSettingsInventory","summary":"Update Inventory Settings","description":"Update inventory settings","tags":["inventory"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory_updateSettingsInventory_Response_200"}}}}},"requestBody":{"description":"null set for a particular field removes override on a channel level and means inheritance from a global level","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventorySettings"}}}}}},"/stores/{store_hash}/v3/settings/inventory/notifications":{"get":{"operationId":"getSettingsInventoryNotifications","summary":"Get Inventory Notifications Settings","description":"Returns inventory notification settings. \n* `channel_id` can be used as a query parameter to get inventory notification settings per channel. If omitted, you will interact with the global settings only.","tags":["inventoryNotifications"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK. `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory Notifications_getSettingsInventoryNotifications_Response_200"}}}}}},"put":{"operationId":"updateSettingsInventoryNotifications","summary":"Update Inventory Notifications Settings","description":"Updates inventory notification settings. \n* `channel_id` can be used as a query parameter to get inventory notification settings per channel. If omitted, you will interact with the global settings only. \n* Supplying `null` settings values per channel will delete overrides per given channel and values will be inherited from global level. \n* Partial updates are not supported within the given endpoint. In order to delete overrides per channel, `null` should be supplied for all the settings within the given endpoint.","tags":["inventoryNotifications"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory Notifications_updateSettingsInventoryNotifications_Response_200"}}}}},"requestBody":{"description":"null set for a particular field removes override on a channel level and means inheritance from a global level","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryNotificationsSettings"}}}}}},"/stores/{store_hash}/v3/settings/logo":{"get":{"operationId":"getSettingsLogo","summary":"Get Store Logo Settings","description":"Returns store logo settings.\n\n - Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.","tags":["logo"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Logo_getSettingsLogo_Response_200"}}}}}},"put":{"operationId":"updateSettingsLogo","summary":"Update Store Logo Settings","description":"Updates the logo type and logo text for a textual logo. To upload new images, use the dedicated image POST endpoints.\n\n - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied with `null` value in order to delete overrides per channel.","tags":["logo"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Logo_updateSettingsLogo_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogoSettingsUpdate"}}}}}},"/stores/{store_hash}/v3/settings/logo/image":{"post":{"operationId":"createSettingsLogoImage","summary":"Create Logo Image","description":"Uploads an image file to use as the storefront logo. Supported MIME types include GIF, JPEG, and PNG. \n\n - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only.","tags":["logoImage"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"204":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"LogoFile":{"type":"string","format":"binary"}}}}}}}},"/stores/{store_hash}/v3/settings/search/filters":{"get":{"operationId":"getSettingsEnabledSearchFilters","summary":"List Enabled Filters","description":"Returns a list of enabled default [Product Filtering](https://support.bigcommerce.com/s/article/Product-Filtering-Settings) filters. These filters will be used if a store does not have contextual overrides.","tags":["searchFilters"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Search Filters_getSettingsEnabledSearchFilters_Response_200"}}}}}},"put":{"operationId":"updateSettingsEnabledSearchFilters","summary":"Update Enabled Filters","description":"Updates enabled default [Product Filtering](https://support.bigcommerce.com/s/article/Product-Filtering-Settings) filters.","tags":["searchFilters"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Search Filters_updateSettingsEnabledSearchFilters_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfiguredFilters"}}}}}},"/stores/{store_hash}/v3/settings/search/filters/available":{"get":{"operationId":"getSettingsAvailableFilters","summary":"List Available Filters","description":"Returns a list of filters available to power [Product Filtering](https://support.bigcommerce.com/s/article/Product-Filtering-Settings).","tags":["searchFilters"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Narrows the list of available filters based on channel ID. Only products currently assigned to the given Channel will be considered.","required":false,"schema":{"type":"integer"}},{"name":"category_id","in":"query","description":"Narrows the list of available filters based on category ID. You can display settings to show products from the provided category, subcategories only, or both the category and its child categories.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Search Filters_getSettingsAvailableFilters_Response_200"}}}}}}},"/stores/{store_hash}/v3/settings/search/filters/contexts":{"get":{"operationId":"getSettingsFiltersContexts","summary":"List Contextual Filters","description":"Returns a list of contextual filters enabled for a particular channel or category.\n\n**Usage Notes**\n\nContextual filters allow you to configure the enabled filters per channel or category, so that shoppers can filter by the most relevant criteria.\n\nThe order of the returned filters will match the sort order of the filters on the storefront.","tags":["searchFilters"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Only return contextual overrides related to a particular Channel.","required":false,"schema":{"type":"integer"}},{"name":"category_id","in":"query","description":"Only return contextual overrides related to a particular Category.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Search Filters_getSettingsFiltersContexts_Response_200"}}}}}},"put":{"operationId":"upsertSettingsFiltersContexts","summary":"Upsert Contextual Filters","description":"Upserts contextual filters for a particular channel or category.\n\n**Usage Notes**\n\nContextual filters allow you to configure the enabled filters per channel or category, so that shoppers can filter by the most relevant criteria.\n\nYou can change the order of the filters on the live site by changing the order of the filters you send.","tags":["searchFilters"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Search Filters_upsertSettingsFiltersContexts_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguredFiltersOverride"}}}}}}},"/stores/{store_hash}/v3/settings/store/locale":{"get":{"operationId":"getSettingsLocale","summary":"Get Locale Settings","description":"Returns global locale settings.\n\nFor stores with Catalyst channels, the `shopper_language_selection_method` field is deprecated. Using this endpoint on those stores will return a warning about the deprecation. For additional information, refer to [Locale Configuration](/developer/docs/admin/store-configuration/settings/locales-configuration).","tags":["storeLocale"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store Locale_getSettingsLocale_Response_200"}}}}}},"put":{"operationId":"updateSettingsLocale","summary":"Update Locale Settings","description":"Updates global locale settings.\n\nFor stores with Catalyst channels, the `shopper_language_selection_method` field is deprecated. Using this endpoint on those stores will return a warning about the deprecation. For additional information, refer to [Locale Configuration](/developer/docs/admin/store-configuration/settings/locales-configuration).","tags":["storeLocale"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store Locale_updateSettingsLocale_Response_200"}}}},"422":{"description":"Provided settings could not be applied for some reason - detailed errors in the response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locale"}}}}}},"/stores/{store_hash}/v3/settings/store/profile":{"get":{"operationId":"getSettingsStoreProfile","summary":"Get Store Profile Settings","description":"Returns store profile settings.\n\n - Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.","tags":["storeProfile"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK. `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store Profile_getSettingsStoreProfile_Response_200"}}}}}},"put":{"operationId":"updateSettingsStoreProfile","summary":"Update Store Profile Settings","description":"Updates store profile settings.\n\n - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied with `null` value in order to delete overrides per channel.","tags":["storeProfile"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store Profile_updateSettingsStoreProfile_Response_200"}}}},"422":{"description":"Provided settings could not be applied for some reason - detailed errors in the response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreProfile"}}}}}},"/stores/{store_hash}/v3/settings/storefront/category":{"get":{"operationId":"getSettingsStorefrontCategory","summary":"Get Storefront Category Settings","description":"Returns category settings.\n\n - Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.","tags":["storefrontCategory"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK. `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Category_getSettingsStorefrontCategory_Response_200"}}}}}},"put":{"operationId":"updateSettingsStorefrontCategory","summary":"Update Storefront Category Settings","description":"Updates category settings.\n\n - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied with `null` value in order to delete overrides per channel.","tags":["storefrontCategory"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Category_updateSettingsStorefrontCategory_Response_200"}}}},"422":{"description":"`422 Unprocessable Entity` Provided settings could not be applied for some reason - detailed errors in the response.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSettingsStorefrontCategoryRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCategorySettings"}}}}}},"/stores/{store_hash}/v3/settings/storefront/product":{"get":{"operationId":"getSettingsStorefrontProduct","summary":"Get Storefront Product Settings","description":"Returns product settings.\n\n - Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.","tags":["storefrontProduct"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK. `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Product_getSettingsStorefrontProduct_Response_200"}}}}}},"put":{"operationId":"updateSettingsStorefrontProduct","summary":"Update Storefront Product Settings","description":"Updates product settings.\n\n - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied with `null` value in order to delete overrides per channel.","tags":["storefrontProduct"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK. `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Product_updateSettingsStorefrontProduct_Response_200"}}}},"422":{"description":"`422 Unprocessable Entity` Provided settings could not be applied for some reason - detailed errors in the response.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSettingsStorefrontProductRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontProductSettings"}}}}}},"/stores/{store_hash}/v3/settings/storefront/robotstxt":{"get":{"operationId":"getSettingsRobotsTxt","summary":"Get Robots.txt Settings","description":"Returns Robots.txt settings.\n\n - Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.","tags":["storefrontRobotstxt"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Robotstxt_getSettingsRobotsTxt_Response_200"}}}}}},"put":{"operationId":"updateSettingsRobotsTxt","summary":"Update Robots.txt Settings","description":"Updates Robots.txt settings.\n\n - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied with `null` value in order to delete overrides per channel.","tags":["storefrontRobotstxt"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Robotstxt_updateSettingsRobotsTxt_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RobotsTxtSettings"}}}}}},"/stores/{store_hash}/v3/settings/storefront/search":{"get":{"operationId":"getSettingsStorefrontSearch","summary":"Get Storefront Search Settings","description":"Returns search settings.\n\n - Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.","tags":["storefrontSearch"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Search_getSettingsStorefrontSearch_Response_200"}}}}}},"put":{"operationId":"updateSettingsStorefrontSearch","summary":"Update Storefront Search Settings","description":"Updates search settings.\n\n - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied with `null` value in order to delete overrides per channel.","tags":["storefrontSearch"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Search_updateSettingsStorefrontSearch_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontSearchSettings"}}}}}},"/stores/{store_hash}/v3/settings/storefront/security":{"get":{"operationId":"getSettingsStorefrontSecurity","summary":"Get Storefront Security Settings","description":"Returns security settings.\n\n - Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.","tags":["storefrontSecurity"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Security_getSettingsStorefrontSecurity_Response_200"}}}}}},"put":{"operationId":"updateSettingsStorefrontSecurity","summary":"Update Storefront Security Settings","description":"Updates security settings.\n\n - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied with `null` value in order to delete overrides per channel.","tags":["storefrontSecurity"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Security_updateSettingsStorefrontSecurity_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontSecuritySettings"}}}}}},"/stores/{store_hash}/v3/settings/storefront/seo":{"get":{"operationId":"getSettingsStorefrontSeo","summary":"Get Storefront SEO Settings","description":"Returns SEO settings.\n\n - Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.","tags":["storefrontSeo"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront SEO_getSettingsStorefrontSeo_Response_200"}}}}}},"put":{"operationId":"updateSettingsStorefrontSeo","summary":"Update Storefront SEO Settings","description":"Updates SEO settings.\n\n - You can use `channel_id` as a query parameter to update channel-specific settings. If omitted, you will only interact with the global settings. \n \n - You can use `channel_id` in the request body of a headless channel of this endpoint to control the `www_redirect` settings for the headless channel's unique checkout URL.\n\n - `null` should be supplied to delete overrides per given channel and to inherit values from a global level. ","tags":["storefrontSeo"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront SEO_updateSettingsStorefrontSeo_Response_200"}}}},"422":{"description":"`422 Unprocessable Entity` Provided settings could not be applied for some reason - detailed errors in the response.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSettingsStorefrontSeoRequestUnprocessableEntityError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEOSettings"}}}}}},"/stores/{store_hash}/v3/settings/storefront/status":{"get":{"operationId":"getSettingsStorefrontStatus","summary":"Get Storefront Status","description":"Returns storefront status-related settings. \n\n - Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.","tags":["storefrontStatus"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Status_getSettingsStorefrontStatus_Response_200"}}}}}},"put":{"operationId":"updateSettingsStorefrontStatus","summary":"Update Storefront Status","description":"Updates storefront status-related settings.\n\n - Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only. \n\n - `null` should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied with `null` value in order to delete overrides per channel.","tags":["storefrontStatus"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storefront Status_updateSettingsStorefrontStatus_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontStatus"}}}}}},"/stores/{store_hash}/v3/settings/store/units-of-measurement":{"get":{"operationId":"getSettingsMeasurementUnits","summary":"Get Units of Measurement Settings","description":"Get settings for [units of measurements](https://support.bigcommerce.com/s/article/Store-Settings?language=en_US#physical).","tags":["unitsOfMeasurement"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. When you request channel-level settings, `null` indicates that a channel does not have overrides.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Units of Measurement_getSettingsMeasurementUnits_Response_200"}}}},"422":{"description":"The provided settings could not be applied. See detailed errors in the response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"operationId":"updateSettingsMeasurementUnits","summary":"Update Units of Measurement Settings","description":"Update settings for [units of measurements](https://support.bigcommerce.com/s/article/Store-Settings?language=en_US#physical).\n\nThe endpoint does not support partial updates. Provide all fields to update global or channel-level settings.\n\nCreate channel-level settings, or overrides for a channel, using the `channel_id`  query parameter. \n\nTo delete overrides for a channel, supply `null` as a value for all fields. A channel then inherits global values.\n\nThe endpoint does not support 'null' as a value for global-level settings.","tags":["unitsOfMeasurement"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.","required":false,"schema":{"type":"integer"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. When you request channel-level settings, `null` indicates that a channel does not have overrides.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Units of Measurement_updateSettingsMeasurementUnits_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeasurementUnitsSettings"}}}}}}},"servers":[{"url":"https://api.bigcommerce.com","description":"https://api.bigcommerce.com"}],"components":{"schemas":{"AnalyticsProvider":{"type":"object","properties":{"id":{"type":"integer","description":"Web Analytics Provider ID."},"channel_id":{"type":"integer","description":"Channels ID"},"name":{"type":"string","description":"Web Analytics Provider title."},"code":{"type":"string","description":"Web Analytics Provider code."},"enabled":{"type":"boolean","description":"Flag indicates if Web Analytics Provider is enabled or not."},"data_tag_enabled":{"type":"boolean"},"version":{"type":"number","format":"double"},"api_secret":{"type":"string"}},"title":"AnalyticsProvider"},"AnalyticsProviders":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsProvider"},"title":"AnalyticsProviders"},"MetaOpen":{"type":"object","properties":{},"description":"Response metadata.","title":"MetaOpen"},"Analytics_getAnalyticsProviders_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AnalyticsProviders"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Analytics_getAnalyticsProviders_Response_200"},"Error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code"],"description":"A standard error object.","title":"Error"},"ErrorResponse400":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Error"}},"title":"ErrorResponse400"},"ErrorResponse404":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Error"}},"title":"ErrorResponse404"},"ErrorResponse409":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Error"}},"title":"ErrorResponse409"},"ErrorResponse422":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Error"}},"title":"ErrorResponse422"},"CatalogSettings":{"type":"object","properties":{"auto_approve_reviews":{"type":"boolean"},"enable_product_comparisons":{"type":"boolean"}},"title":"CatalogSettings"},"Catalog_getSettingsCatalog_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CatalogSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Catalog_getSettingsCatalog_Response_200"},"Catalog_updateSettingsCatalog_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CatalogSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Catalog_updateSettingsCatalog_Response_200"},"EnabledTransactionalEmails":{"type":"object","properties":{"abandoned_cart_email":{"type":"boolean"},"account_details_changed_email":{"type":"boolean"},"combined_order_status_email":{"type":"boolean"},"create_account_email":{"type":"boolean"},"create_guest_account_email":{"type":"boolean"},"gift_certificate_email":{"type":"boolean"},"invoice_email":{"type":"boolean"},"order_message_notification_email":{"type":"boolean"},"product_review_email":{"type":"boolean"},"return_confirmation_email":{"type":"boolean"},"return_statuschange_email":{"type":"boolean"}},"title":"EnabledTransactionalEmails"},"Email Statuses_getSettingsEmailStatuses_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EnabledTransactionalEmails"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Email Statuses_getSettingsEmailStatuses_Response_200"},"Email Statuses_updateSettingsEmailStatuses_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EnabledTransactionalEmails"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Email Statuses_updateSettingsEmailStatuses_Response_200"},"InventorySettingsProductOutOfStockBehavior":{"type":"string","enum":["do_nothing","hide_product","hide_product_and_accessible","hide_product_and_redirect"],"description":"Describes storefront behavior when product is out of stock.","title":"InventorySettingsProductOutOfStockBehavior"},"InventorySettingsOptionOutOfStockBehavior":{"type":"string","enum":["do_nothing","hide_option","label_option"],"description":"Describes storefront behavior when variant is out of stock.","title":"InventorySettingsOptionOutOfStockBehavior"},"InventorySettingsUpdateStockBehavior":{"type":"string","enum":["order_placed","order_completed_or_shipped"],"description":"Describes when stock levels are updated.\n\nGlobal settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/developer/docs/integrations/webhooks/event-reference#products), [SKU](/developer/docs/integrations/webhooks/event-reference#skus), and [inventory](/developer/docs/integrations/webhooks/event-reference/inventory-and-location-events#inventory) webhooks.  ","title":"InventorySettingsUpdateStockBehavior"},"InventorySettingsStockLevelDisplay":{"type":"string","enum":["dont_show","show","show_when_low"],"description":"Describes whether a storefront displays stock levels.","title":"InventorySettingsStockLevelDisplay"},"InventorySettings":{"type":"object","properties":{"product_out_of_stock_behavior":{"$ref":"#/components/schemas/InventorySettingsProductOutOfStockBehavior","description":"Describes storefront behavior when product is out of stock."},"option_out_of_stock_behavior":{"$ref":"#/components/schemas/InventorySettingsOptionOutOfStockBehavior","description":"Describes storefront behavior when variant is out of stock."},"update_stock_behavior":{"$ref":"#/components/schemas/InventorySettingsUpdateStockBehavior","description":"Describes when stock levels are updated.\n\nGlobal settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/developer/docs/integrations/webhooks/event-reference#products), [SKU](/developer/docs/integrations/webhooks/event-reference#skus), and [inventory](/developer/docs/integrations/webhooks/event-reference/inventory-and-location-events#inventory) webhooks.  "},"edit_order_stock_adjustment":{"type":"boolean","description":"Describes whether stock levels automatically adjust when you edit an order.\n\nGlobal settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/developer/docs/integrations/webhooks/event-reference#products), [SKU](/developer/docs/integrations/webhooks/event-reference#skus), and [inventory](/developer/docs/integrations/webhooks/event-reference/inventory-and-location-events#inventory) webhooks.  "},"refund_order_stock_adjustment":{"type":"boolean","description":"Describes whether stock levels automatically adjust when you refund or cancel an order.\n\nGlobal settings apply when inventory changes through a [manual order](https://support.bigcommerce.com/s/article/Creating-a-Manual-Order?language=en_US). Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including [product](/developer/docs/integrations/webhooks/event-reference#products), [SKU](/developer/docs/integrations/webhooks/event-reference#skus), and [inventory](/developer/docs/integrations/webhooks/event-reference/inventory-and-location-events#inventory) webhooks.  "},"stock_level_display":{"$ref":"#/components/schemas/InventorySettingsStockLevelDisplay","description":"Describes whether a storefront displays stock levels."},"default_out_of_stock_message":{"type":"string","description":"Out of stock message displayed to shoppers."},"hide_in_product_filtering":{"type":"boolean","description":"Describes whether an option is hidden in product filtering. Applies when `option_out_of_stock_behavior` is set to `label_option`. "},"show_pre_order_stock_levels":{"type":"boolean","default":false,"description":"Describes whether pre-order stock levels are shown."},"show_out_of_stock_message":{"type":"boolean","default":false,"description":"Describes whether out-of-stock messages are shown on product listing pages."}},"title":"InventorySettings"},"Inventory_getSettingsInventory_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InventorySettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Inventory_getSettingsInventory_Response_200"},"DetailedErrors":{"type":"object","properties":{},"title":"DetailedErrors"},"ErrorResponse":{"type":"object","properties":{"instance":{"type":"string"},"status":{"type":"integer","description":"The HTTP status code.\n"},"title":{"type":"string","description":"The error title describing the particular error.\n"},"type":{"type":"string"},"errors":{"$ref":"#/components/schemas/DetailedErrors"}},"title":"ErrorResponse"},"Inventory_updateSettingsInventory_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InventorySettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Inventory_updateSettingsInventory_Response_200"},"InventoryNotificationsSettings":{"type":"object","properties":{"low_stock_notification_address":{"type":"array","items":{"type":"string"}},"out_of_stock_notification_address":{"type":"array","items":{"type":"string"}}},"title":"InventoryNotificationsSettings"},"Inventory Notifications_getSettingsInventoryNotifications_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InventoryNotificationsSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Inventory Notifications_getSettingsInventoryNotifications_Response_200"},"Inventory Notifications_updateSettingsInventoryNotifications_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Inventory Notifications_updateSettingsInventoryNotifications_Response_200"},"LogoSettingsType":{"type":"string","enum":["image","text"],"title":"LogoSettingsType"},"LogoSettings":{"type":"object","properties":{"favicon_url":{"type":"string"},"logo_image_url":{"type":"string"},"logo_text":{"type":"string"},"type":{"$ref":"#/components/schemas/LogoSettingsType"}},"title":"LogoSettings"},"Logo_getSettingsLogo_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LogoSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Logo_getSettingsLogo_Response_200"},"LogoSettingsUpdateType":{"type":"string","enum":["image","text"],"title":"LogoSettingsUpdateType"},"LogoSettingsUpdate":{"type":"object","properties":{"logo_text":{"type":"string"},"type":{"$ref":"#/components/schemas/LogoSettingsUpdateType"}},"title":"LogoSettingsUpdate"},"Logo_updateSettingsLogo_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LogoSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Logo_updateSettingsLogo_Response_200"},"EnabledProductFilterItemsToShow":{"type":"string","enum":["5","10","15"],"title":"EnabledProductFilterItemsToShow"},"EnabledProductFilterSortBy":{"type":"string","enum":["alpha","option_values","item_count"],"title":"EnabledProductFilterSortBy"},"EnabledProductFilterType":{"type":"string","enum":["product"],"title":"EnabledProductFilterType"},"EnabledProductFilter":{"type":"object","properties":{"collapsed_by_default":{"type":"boolean"},"display_name":{"type":"string"},"display_product_count":{"type":"boolean"},"id":{"type":"string","description":"The ID of the filter."},"is_enabled":{"type":"boolean"},"items_to_show":{"$ref":"#/components/schemas/EnabledProductFilterItemsToShow"},"sort_by":{"$ref":"#/components/schemas/EnabledProductFilterSortBy"},"type":{"$ref":"#/components/schemas/EnabledProductFilterType"}},"description":"A filter that uses product options and custom field data.","title":"EnabledProductFilter"},"EnabledPriceFilterType":{"type":"string","enum":["price"],"title":"EnabledPriceFilterType"},"EnabledPriceFilter":{"type":"object","properties":{"collapsed_by_default":{"type":"boolean"},"display_name":{"type":"string"},"id":{"type":"string","description":"The ID of the filter."},"is_enabled":{"type":"boolean"},"type":{"$ref":"#/components/schemas/EnabledPriceFilterType"}},"description":"A filter based on the product’s price, shown as a price range on the storefront.","title":"EnabledPriceFilter"},"EnabledCategoryFilterItemsToShow":{"type":"string","enum":["5","10","15"],"title":"EnabledCategoryFilterItemsToShow"},"EnabledCategoryFilterType":{"type":"string","enum":["category"],"title":"EnabledCategoryFilterType"},"EnabledCategoryFilter":{"type":"object","properties":{"collapsed_by_default":{"type":"boolean"},"display_name":{"type":"string"},"display_product_count":{"type":"boolean"},"id":{"type":"string","description":"The ID of the filter."},"is_enabled":{"type":"boolean"},"items_to_show":{"$ref":"#/components/schemas/EnabledCategoryFilterItemsToShow"},"type":{"$ref":"#/components/schemas/EnabledCategoryFilterType"}},"description":"A storefront filter for product category","title":"EnabledCategoryFilter"},"EnabledBrandFilterItemsToShow":{"type":"string","enum":["5","10","15"],"title":"EnabledBrandFilterItemsToShow"},"EnabledBrandFilterSortBy":{"type":"string","enum":["alpha","item_count"],"title":"EnabledBrandFilterSortBy"},"EnabledBrandFilterType":{"type":"string","enum":["brand"],"title":"EnabledBrandFilterType"},"EnabledBrandFilter":{"type":"object","properties":{"collapsed_by_default":{"type":"boolean"},"display_name":{"type":"string"},"display_product_count":{"type":"boolean"},"id":{"type":"string","description":"The ID of the filter."},"is_enabled":{"type":"boolean"},"items_to_show":{"$ref":"#/components/schemas/EnabledBrandFilterItemsToShow"},"sort_by":{"$ref":"#/components/schemas/EnabledBrandFilterSortBy"},"type":{"$ref":"#/components/schemas/EnabledBrandFilterType"}},"description":"A storefront filter for product brand","title":"EnabledBrandFilter"},"EnabledRatingFilterType":{"type":"string","enum":["rating"],"title":"EnabledRatingFilterType"},"EnabledRatingFilter":{"type":"object","properties":{"collapsed_by_default":{"type":"boolean"},"display_name":{"type":"string"},"id":{"type":"string","description":"The ID of the filter."},"is_enabled":{"type":"boolean"},"type":{"$ref":"#/components/schemas/EnabledRatingFilterType"}},"description":"A filter based on product review ratings.","title":"EnabledRatingFilter"},"EnabledMiscFilterType":{"type":"string","enum":["other"],"title":"EnabledMiscFilterType"},"EnabledMiscFilter":{"type":"object","properties":{"collapsed_by_default":{"type":"boolean"},"display_name":{"type":"string"},"display_product_count":{"type":"boolean"},"id":{"type":"string","description":"The ID of the filter."},"is_enabled":{"type":"boolean"},"show_free_shipping_filter":{"type":"boolean"},"show_in_stock_filter":{"type":"boolean"},"show_is_featured_filter":{"type":"boolean"},"show_product_count":{"type":"boolean"},"type":{"$ref":"#/components/schemas/EnabledMiscFilterType"}},"description":"Miscellaneous filters which appear as a group.","title":"EnabledMiscFilter"},"ConfiguredFilter":{"oneOf":[{"$ref":"#/components/schemas/EnabledProductFilter"},{"$ref":"#/components/schemas/EnabledPriceFilter"},{"$ref":"#/components/schemas/EnabledCategoryFilter"},{"$ref":"#/components/schemas/EnabledBrandFilter"},{"$ref":"#/components/schemas/EnabledRatingFilter"},{"$ref":"#/components/schemas/EnabledMiscFilter"}],"title":"ConfiguredFilter"},"ConfiguredFilters":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguredFilter"},"title":"ConfiguredFilters"},"Search Filters_getSettingsEnabledSearchFilters_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConfiguredFilters"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Search Filters_getSettingsEnabledSearchFilters_Response_200"},"Search Filters_updateSettingsEnabledSearchFilters_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConfiguredFilters"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Search Filters_updateSettingsEnabledSearchFilters_Response_200"},"AvailableNormalFilterType":{"type":"string","enum":["category","brand","rating","product"],"title":"AvailableNormalFilterType"},"AvailableNormalFilter":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"product_count":{"type":"integer"},"type":{"$ref":"#/components/schemas/AvailableNormalFilterType"}},"title":"AvailableNormalFilter"},"AvailablePriceFilterType":{"type":"string","enum":["price"],"title":"AvailablePriceFilterType"},"AvailablePriceFilter":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price_range_max":{"type":"number","format":"double"},"price_range_min":{"type":"number","format":"double"},"type":{"$ref":"#/components/schemas/AvailablePriceFilterType"}},"title":"AvailablePriceFilter"},"AvailableOtherFilterType":{"type":"string","enum":["other"],"title":"AvailableOtherFilterType"},"AvailableOtherFilter":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/AvailableOtherFilterType"}},"title":"AvailableOtherFilter"},"AvailableFilter":{"oneOf":[{"$ref":"#/components/schemas/AvailableNormalFilter"},{"$ref":"#/components/schemas/AvailablePriceFilter"},{"$ref":"#/components/schemas/AvailableOtherFilter"}],"title":"AvailableFilter"},"Search Filters_getSettingsAvailableFilters_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AvailableFilter"}},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Search Filters_getSettingsAvailableFilters_Response_200"},"SearchFilterOverrideContextIdentifier":{"type":"object","properties":{"category_id":{"type":"integer"},"channel_id":{"type":"integer"}},"title":"SearchFilterOverrideContextIdentifier"},"ConfiguredFiltersOverride":{"type":"object","properties":{"context":{"$ref":"#/components/schemas/SearchFilterOverrideContextIdentifier"},"data":{"$ref":"#/components/schemas/ConfiguredFilters"}},"description":"A new set of enabled Product Filtering filters which should display in a particular context, such as on a particular Channel, or while viewing a particular Category. Array order indicates the display order on the storefront.","title":"ConfiguredFiltersOverride"},"MetaPaginationObjectPaginationLinks":{"type":"object","properties":{"current":{"type":"string"},"next":{"type":"string"}},"title":"MetaPaginationObjectPaginationLinks"},"MetaPaginationObjectPagination":{"type":"object","properties":{"count":{"type":"integer"},"current_page":{"type":"integer"},"links":{"$ref":"#/components/schemas/MetaPaginationObjectPaginationLinks"},"per_page":{"type":"integer"},"total":{"type":"integer"},"total_pages":{"type":"integer"}},"title":"MetaPaginationObjectPagination"},"MetaPaginationObject":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/MetaPaginationObjectPagination"}},"title":"MetaPaginationObject"},"Search Filters_getSettingsFiltersContexts_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguredFiltersOverride"}},"meta":{"$ref":"#/components/schemas/MetaPaginationObject"}},"title":"Search Filters_getSettingsFiltersContexts_Response_200"},"Search Filters_upsertSettingsFiltersContexts_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguredFiltersOverride"}},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Search Filters_upsertSettingsFiltersContexts_Response_200"},"LocaleShopperLanguageSelectionMethod":{"type":"string","enum":["browser","default_shopper_language"],"default":"default_shopper_language","description":"Determines whether to display the storefront content in the shopperʼs browser language or the shopperʼs selected default language.\n\nAvailable values:\n* `browser` - language updates automatically based on the shopper browser language. Multiple languages are supported.\n* `default_shopper_language` - content is displayed in a single language based on the set `default_shopper_language`. Only the selected language is supported.","title":"LocaleShopperLanguageSelectionMethod"},"Locale":{"type":"object","properties":{"default_shopper_language":{"type":"string","default":"en"},"shopper_language_selection_method":{"$ref":"#/components/schemas/LocaleShopperLanguageSelectionMethod","default":"default_shopper_language","description":"Determines whether to display the storefront content in the shopperʼs browser language or the shopperʼs selected default language.\n\nAvailable values:\n* `browser` - language updates automatically based on the shopper browser language. Multiple languages are supported.\n* `default_shopper_language` - content is displayed in a single language based on the set `default_shopper_language`. Only the selected language is supported."},"store_country":{"type":"string","default":"United States"}},"required":["default_shopper_language"],"description":"The basic locale settings for a store, used to give shopper information about languages, countries, etc.","title":"Locale"},"Store Locale_getSettingsLocale_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Locale"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Store Locale_getSettingsLocale_Response_200"},"Store Locale_updateSettingsLocale_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Locale"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Store Locale_updateSettingsLocale_Response_200"},"AddressTypeEnumValues":{"type":"string","enum":["Home Office","Commercial Office","Retail","Warehouse"],"default":"Home Office","description":"Only supports manipulation on a global level.","title":"AddressTypeEnumValues"},"StoreProfile":{"type":"object","properties":{"store_address":{"type":"string"},"store_address_type":{"$ref":"#/components/schemas/AddressTypeEnumValues","default":"Home Office"},"store_email":{"type":"string"},"store_name":{"type":"string"},"store_phone":{"type":"string"}},"description":"The basic profile settings for a store, used to give the shopper information about the business from which they are purchasing.","title":"StoreProfile"},"Store Profile_getSettingsStoreProfile_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StoreProfile"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Store Profile_getSettingsStoreProfile_Response_200"},"Store Profile_updateSettingsStoreProfile_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StoreProfile"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Store Profile_updateSettingsStoreProfile_Response_200"},"ProductSortEnumValues":{"type":"string","enum":["featured","bestselling","newest","alphaasc","alphadesc","pricedesc","priceasc","avgcustomerreview","relevance"],"default":"bestselling","description":"The available sorts for PLP pages.","title":"ProductSortEnumValues"},"CategoryListingModeEnumValues":{"type":"string","enum":["current_category_only","child_categories","child_categories_if_category_empty"],"title":"CategoryListingModeEnumValues"},"StorefrontCategorySettings":{"type":"object","properties":{"category_tree_depth":{"type":"integer"},"default_product_sort":{"$ref":"#/components/schemas/ProductSortEnumValues","default":"bestselling"},"listing_mode":{"$ref":"#/components/schemas/CategoryListingModeEnumValues"}},"title":"StorefrontCategorySettings"},"Storefront Category_getSettingsStorefrontCategory_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StorefrontCategorySettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Category_getSettingsStorefrontCategory_Response_200"},"Storefront Category_updateSettingsStorefrontCategory_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StorefrontCategorySettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Category_updateSettingsStorefrontCategory_Response_200"},"SettingsStorefrontCategoryPutResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{"":{"type":"string"}},"title":"SettingsStorefrontCategoryPutResponsesContentApplicationJsonSchemaErrors"},"UpdateSettingsStorefrontCategoryRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/SettingsStorefrontCategoryPutResponsesContentApplicationJsonSchemaErrors"},"status":{"type":"number","format":"double"},"title":{"type":"string"},"type":{"type":"string"}},"title":"UpdateSettingsStorefrontCategoryRequestUnprocessableEntityError"},"StorefrontProductSettingsShowBreadcrumbsProductPages":{"type":"string","enum":["show_one","show_none"],"title":"StorefrontProductSettingsShowBreadcrumbsProductPages"},"StorefrontProductSettings":{"type":"object","properties":{"show_product_price":{"type":"boolean","description":"Determines the visibility of the product price.\n"},"show_product_sku":{"type":"boolean","description":"Determines the visibility of the product SKU.\n"},"show_product_weight":{"type":"boolean","description":"Determines the visibility of the productʼs weight.\n"},"show_product_brand":{"type":"boolean","description":"Determines the visibility of the productʼs brand.\n"},"show_product_shipping":{"type":"boolean","description":"Determines the visibility of the productʼs shipping option.\n"},"show_product_rating":{"type":"boolean","description":"Determines the visibility of the productʼs rating.\n"},"show_add_to_cart_link":{"type":"boolean","description":"Determines the visibility of the Add to Cart link.\n"},"default_preorder_message":{"type":"string","description":"The productʼs pre-order message. If undefined, the message defaults to the storewide setting.\n"},"show_breadcrumbs_product_pages":{"$ref":"#/components/schemas/StorefrontProductSettingsShowBreadcrumbsProductPages"},"show_add_to_cart_qty_box":{"type":"boolean","description":"Determines the visibility of the Add to Cart quantity setting.\n"},"show_add_to_wishlist":{"type":"boolean","description":"Determines the visibility of the Add to Wishlist setting.\n"},"hide_price_from_guests":{"type":"boolean","description":"Determines the visibility of the price.\n"}},"title":"StorefrontProductSettings"},"Storefront Product_getSettingsStorefrontProduct_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StorefrontProductSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Product_getSettingsStorefrontProduct_Response_200"},"Storefront Product_updateSettingsStorefrontProduct_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StorefrontProductSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Product_updateSettingsStorefrontProduct_Response_200"},"SettingsStorefrontProductPutResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{"":{"type":"string"}},"title":"SettingsStorefrontProductPutResponsesContentApplicationJsonSchemaErrors"},"UpdateSettingsStorefrontProductRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/SettingsStorefrontProductPutResponsesContentApplicationJsonSchemaErrors"},"status":{"type":"number","format":"double"},"title":{"type":"string"},"type":{"type":"string"}},"title":"UpdateSettingsStorefrontProductRequestUnprocessableEntityError"},"RobotsTxtSettings":{"type":"object","properties":{"robots_txt_ssl":{"type":"string"}},"title":"RobotsTxtSettings"},"Storefront Robotstxt_getSettingsRobotsTxt_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RobotsTxtSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Robotstxt_getSettingsRobotsTxt_Response_200"},"Storefront Robotstxt_updateSettingsRobotsTxt_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RobotsTxtSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Robotstxt_updateSettingsRobotsTxt_Response_200"},"ContentSortEnumValues":{"type":"string","enum":["relevance","alphaasc","alphadesc"],"default":"relevance","title":"ContentSortEnumValues"},"StorefrontSearchSettings":{"type":"object","properties":{"content_product_sort":{"$ref":"#/components/schemas/ContentSortEnumValues"},"default_product_sort":{"$ref":"#/components/schemas/ProductSortEnumValues"},"product_filtering_enabled":{"type":"boolean","description":"Controls whether Product Filtering feature is active on the storefront. Only supports manipulation on a global level."},"search_suggest":{"type":"boolean"}},"required":["content_product_sort","default_product_sort","product_filtering_enabled","search_suggest"],"title":"StorefrontSearchSettings"},"Storefront Search_getSettingsStorefrontSearch_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StorefrontSearchSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Search_getSettingsStorefrontSearch_Response_200"},"Storefront Search_updateSettingsStorefrontSearch_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StorefrontSearchSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Search_updateSettingsStorefrontSearch_Response_200"},"StorefrontSecuritySettingsCspHeader":{"type":"object","properties":{"enabled":{"type":"boolean"},"header_value":{"type":"string"}},"title":"StorefrontSecuritySettingsCspHeader"},"HSTSMaxAgeEnumValues":{"type":"string","enum":["zero_seconds","five_minutes","one_year"],"title":"HSTSMaxAgeEnumValues"},"StorefrontSecuritySettingsHsts":{"type":"object","properties":{"enabled":{"type":"boolean"},"include_preload":{"type":"boolean"},"include_subdomains":{"type":"boolean"},"max_age":{"$ref":"#/components/schemas/HSTSMaxAgeEnumValues"}},"title":"StorefrontSecuritySettingsHsts"},"StorefrontSecuritySettingsXFrameOptionsHeaderSetting":{"type":"string","enum":["deny","same_origin","allow_from_url"],"title":"StorefrontSecuritySettingsXFrameOptionsHeaderSetting"},"StorefrontSecuritySettingsXFrameOptionsHeader":{"type":"object","properties":{"allowed_url":{"type":"string"},"enabled":{"type":"boolean"},"setting":{"$ref":"#/components/schemas/StorefrontSecuritySettingsXFrameOptionsHeaderSetting"}},"title":"StorefrontSecuritySettingsXFrameOptionsHeader"},"StorefrontSecuritySettings":{"type":"object","properties":{"csp_header":{"$ref":"#/components/schemas/StorefrontSecuritySettingsCspHeader"},"hsts":{"$ref":"#/components/schemas/StorefrontSecuritySettingsHsts"},"sitewide_https_enabled":{"type":"boolean"},"x_frame_options_header":{"$ref":"#/components/schemas/StorefrontSecuritySettingsXFrameOptionsHeader"}},"title":"StorefrontSecuritySettings"},"Storefront Security_getSettingsStorefrontSecurity_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StorefrontSecuritySettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Security_getSettingsStorefrontSecurity_Response_200"},"Storefront Security_updateSettingsStorefrontSecurity_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StorefrontSecuritySettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Security_updateSettingsStorefrontSecurity_Response_200"},"SeoSettingsWwwRedirect":{"type":"string","enum":["www","no-www","none"],"title":"SeoSettingsWwwRedirect"},"SEOSettings":{"type":"object","properties":{"meta_description":{"type":"string"},"meta_keywords":{"type":"string"},"page_title":{"type":"string"},"www_redirect":{"$ref":"#/components/schemas/SeoSettingsWwwRedirect"}},"title":"SEOSettings"},"Storefront SEO_getSettingsStorefrontSeo_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SEOSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront SEO_getSettingsStorefrontSeo_Response_200"},"Storefront SEO_updateSettingsStorefrontSeo_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SEOSettings"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront SEO_updateSettingsStorefrontSeo_Response_200"},"SettingsStorefrontSeoPutResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{"":{"type":"string"}},"title":"SettingsStorefrontSeoPutResponsesContentApplicationJsonSchemaErrors"},"UpdateSettingsStorefrontSeoRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/SettingsStorefrontSeoPutResponsesContentApplicationJsonSchemaErrors"},"status":{"type":"number","format":"double"},"title":{"type":"string"},"type":{"type":"string"}},"title":"UpdateSettingsStorefrontSeoRequestUnprocessableEntityError"},"StorefrontStatus":{"type":"object","properties":{"down_for_maintenance_message":{"type":"string"},"prelaunch_message":{"type":"string"},"prelaunch_password":{"type":"string","description":"A read-only value representing the auto-generated storefront password."}},"title":"StorefrontStatus"},"Storefront Status_getSettingsStorefrontStatus_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StorefrontStatus"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Status_getSettingsStorefrontStatus_Response_200"},"Storefront Status_updateSettingsStorefrontStatus_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/StorefrontStatus"},"meta":{"$ref":"#/components/schemas/MetaOpen"}},"title":"Storefront Status_updateSettingsStorefrontStatus_Response_200"},"MeasurementUnitsSettingsWeightMeasurement":{"type":"string","enum":["LBS","Ounces","KGS","Grams","Tonnes"],"title":"MeasurementUnitsSettingsWeightMeasurement"},"MeasurementUnitsSettingsLengthMeasurement":{"type":"string","enum":["Inches","Centimeters"],"title":"MeasurementUnitsSettingsLengthMeasurement"},"MeasurementUnitsSettingsFactoringDimension":{"type":"string","enum":["depth","height","width"],"title":"MeasurementUnitsSettingsFactoringDimension"},"MeasurementUnitsSettings":{"type":"object","properties":{"weight_measurement":{"$ref":"#/components/schemas/MeasurementUnitsSettingsWeightMeasurement"},"length_measurement":{"$ref":"#/components/schemas/MeasurementUnitsSettingsLengthMeasurement"},"decimal_token":{"type":"string"},"thousands_token":{"type":"string"},"decimal_places":{"type":"integer"},"factoring_dimension":{"$ref":"#/components/schemas/MeasurementUnitsSettingsFactoringDimension"}},"title":"MeasurementUnitsSettings"},"SettingsStoreUnitsOfMeasurementGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{},"title":"SettingsStoreUnitsOfMeasurementGetResponsesContentApplicationJsonSchemaMeta"},"Units of Measurement_getSettingsMeasurementUnits_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MeasurementUnitsSettings"},"meta":{"$ref":"#/components/schemas/SettingsStoreUnitsOfMeasurementGetResponsesContentApplicationJsonSchemaMeta"}},"title":"Units of Measurement_getSettingsMeasurementUnits_Response_200"},"SettingsStoreUnitsOfMeasurementPutResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{},"title":"SettingsStoreUnitsOfMeasurementPutResponsesContentApplicationJsonSchemaMeta"},"Units of Measurement_updateSettingsMeasurementUnits_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MeasurementUnitsSettings"},"meta":{"$ref":"#/components/schemas/SettingsStoreUnitsOfMeasurementPutResponsesContentApplicationJsonSchemaMeta"}},"title":"Units of Measurement_updateSettingsMeasurementUnits_Response_200"}},"securitySchemes":{"X-Auth-Token":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Information & Settings | modify | `store_v2_information` |\n|  Information & Settings | read-only | `store_v2_information_read_only` |\n\nNOTE:  Analytics endpoints require the Content (`store_v2_content` and `store_v2_content_read_only`) OAuth scope.\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes)."}}}}