commerce/settings/general
Define global site settings such as the site name, shipping and email addresses, and logo images. Block undesirable IP addresses using this resource.
JSON Example
GeneralSettings Properties
Property | Description |
---|---|
allowInvalidAddresses |
type: bool If true, the site allows entry of addresses not verified by an address validation service. |
auditInfo |
type: auditInfo Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. |
auditInfo |
type: string Identifier of the user that created the object. System created and read only. |
auditInfo |
type: DateTime The date and time in UTC format set when the object was created. |
auditInfo |
type: string Identifier of the user that updated the entity most recently. |
auditInfo |
type: DateTime The date and time in UTC format the object was updated most recently. |
bccEmailAddress |
type: string An email address to blind carbon copy anytime an automatic email is sent from Kibo eCommerce to a shopper. Note: This setting is default for all email templates. To override this setting for a specific email template, edit the emailTypes array. |
cacheSettings |
type: cacheSettings Settings related to the CDN cache. |
cacheSettings |
type: string A random string value appended to the URLs of CDN content. When a user clicks the Bust Cache button in Admin, the random number in the URL forces the cache to point to the latest version of the CDN content. |
customCdnHostName |
type: string Custom override of the default subdomain for CDN-hosted content. For example, for SEO reasons you may prefer that the subdomain for your CDN content be cdn.yourSite.com instead of the default subdomain, which might be something like cdn-tp1.mozu.com. |
customRoutes |
type: customRouteSettings Site-level settings for custom routing, which allows you to use your own custom URL patterns for common Kibo eCommerce pages. |
customRouteSettings |
type: System.String,Mozu.SiteSettings.General.Contracts.General.Routing.Mapping The mappings configured for the site. Mappings allow you to map the values of URL parameters to other JSON variables or to Kibo eCommerce objects such as facet values. |
customRouteSettings |
type: list of route The routes configured for the site. Routes contain all the information necessary to match incoming URLs to a specific page in Kibo eCommerce. |
customRouteSettings |
type: bool When true, specifies that the route is a canonical route. |
customRouteSettings |
type: System.String,System.Object An array of key-value pairs that provide default values for required route parameters. |
customRouteSettings |
type: string For Arc.js routes, specifies the Arc.js function name to create a route to. For example: "internalRoute": "Arcjs",
|
customRouteSettings |
type: string Specifies the internal route to use for a particular URL template. For example, the "ProductDetails" internal route routes matching URLs to a product page. |
customRouteSettings |
type: System.String,System.String[] The list of mappings that a particular route uses. |
customRouteSettings |
type: string Specifies the pattern of URL constants, variables, and segments that result in a match for a particular route. |
customRouteSettings |
type: string Specifies whether a custom route uses an http or https protocol. This allows you to set encryption on a route generated from a non-secure request, or vice-versa. |
customRouteSettings |
type: System.String,System.String[] Specifies the validators that a particular route uses. |
customRouteSettings |
type: System.String,Mozu.SiteSettings.General.Contracts.General.Routing.Validator The validators configured for a site. Validators require that URL parameters meet certain conditions before Kibo eCommerce considers the template a match. |
emailTransactionsOnlyOnRequest |
type: emailTransactionSettings Set this property to true to disable automatically sending order confirmation emails after an order is submitted. If you enable this property, order confirmation emails are triggered only by the ResendOrderConfirmationEmail API operation or a Resend Order Confirmation Email event (which can be triggered by an Admin user). |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool There is no corresponding template for this in the Core theme. |
emailTransactionSettings |
type: bool This controls "email/product-return-received" in the Core theme. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTypes |
type: list of emailTypeSetting A collection of overrides that allow you to apply unique email settings to the email template(s) of your choice. |
emailTypeSetting |
type: string Overwrites the Bcc email address for the given template. |
emailTypeSetting |
type: string Unique identifier of the source property, such as a catalog, discount, order, or email template. For a product field it will be the name of the field. For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID. For a product attribute it will be the Attribute FQN. For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366 For email templates, the ID must be one of the following values:
|
emailTypeSetting |
type: string Overwrites the Reply-to email address for the given template. |
emailTypeSetting |
type: string Overwrites the Sender email address for the given template. |
emailTypeSetting |
type: string Overwrites the Sender email alias for the given template. |
favIconMobilePath |
type: string The physical directory path or URL where the mobile favicon image file is stored. The favicon icon is generally 57x57 pixels. The icon appears on a mobile website or on the mobile device's OS Home. |
favIconPath |
type: string The physical directory path or URL where the mobile favicon image file is stored. The favicon icon is generally 16x16 pixels. The icon appears on a a browser tab as the website's mini logo or on a browser address bar, or next to the page name in a list of bookmarks. |
googleAnalyticsCode |
type: string The Google Analytics code associated with a particular store. This could be the web tracking code. |
isAddressValidationEnabled |
type: bool If true, a service to verify addresses as valid is enabled for the site. |
isGoogleAnalyticsEcommerceEnabled |
type: bool If true, the Google analytics for eCommerce is enabled for this site. If false, the analytics are not enabled. |
isGoogleAnalyticsEnabled |
type: bool If true, enable Google analytics for this site. If false, analytics are not enabled. |
isMozuWebSite |
type: bool If true, this site represents a Kibo eCommerce-hosted web storefront. |
isMultishipEnabled |
type: bool True if the site supports shipping to multiple addresses within one order. |
isWishlistCreationEnabled |
type: bool If true, shoppers on this site can create customer wish lists. |
logoPath |
type: string The physical directory path or URL where the website logo is stored. |
logoText |
type: string The tagline or text that appears when hovering over the site logo. |
missingImageSubstitute |
type: string Assigns an image to render in place of broken images and unspecified product images (and unspecified category images, if your theme developer has enabled category images). Specified by the name or ID of the CMS image within files@mozu. |
mobileTheme |
type: string The name of the theme to use when viewing this website on a mobile device. |
replyToEmailAddress |
type: string The email shoppers should use to reply to an automatically-generated email. Note: This setting is default for all email templates. To override this setting for a specific email template, edit the emailTypes array. |
senderEmailAddress |
type: string Email address to set up so that shoppers and users browsing the site can use to contact the merchant. Note: This setting is default for all email templates. To override this setting for a specific email template, edit the emailTypes array. |
senderEmailAlias |
type: string An alternate name for the sender email. For example, if your sender email is support@yourCompany.com, you might want to use an alias of Customer Support. Note: This setting is default for all email templates. To override this setting for a specific email template, edit the emailTypes array. |
siteTimeFormat |
type: string Choose a format to use on the site: 12-hour (hh:mm:ss tt) or 24-hour format (HH:mm:ss). |
siteTimeZone |
type: string Choose the time zone to use for the site. |
supressedEmailTransactions |
type: emailTransactionSettings Supressed emails. Setting any of these to 'true' will block Kibo eCommerce from sending that email and an event will be published instead. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool There is no corresponding template for this in the Core theme. |
emailTransactionSettings |
type: bool This controls "email/product-return-received" in the Core theme. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
emailTransactionSettings |
type: bool A flag that determines if an email is sent to a shopper account when the described condition is met. |
tabletTheme |
type: string The name of the theme to use when viewing the website on a mobile device. |
taxableTerritories |
type: list of taxableTerritory The territories configured for the site that are subject to sales tax. |
taxableTerritory |
type: string The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. |
taxableTerritory |
type: bool If true, all shipping charges for this territory are subject to sales tax. |
taxableTerritory |
type: string State or Provice Code |
templateSiteId |
type: int Unique identifier of the tenant site that site uses to render content for the shopper. For example, if this site represents a third-party sales channel such as Amazon but the company wants to send shopper emails, this value represents the Kibo eCommerce-hosted web storefront site that maintains this content. |
theme |
type: string The name of the theme used on the storefront. |
viewAuthorizations |
type: viewAuthorizations A collection of authorizations that control access to viewing the pending and live sites. |
viewAuthorizations |
type: bool Specifies whether to enable secure communication across your entire site, using the SSL (Secure Socket Layer) security protocol. Every page on your site will display as an HTTPS page and contain an SSL certificate. Note: Before enabling this feature:
|
viewAuthorizations |
type: bool Require log in to view live storefront site. |
viewAuthorizations |
type: bool Require log in to view pending storefront site. |
websiteName |
type: string The name of the website to display on the storefront with no spaces. |
Operations
Operation Name | Request URI | Description |
---|---|---|
GetGeneralSettings | GET %3fresponseFields%3d%7bresponseFields%7d |
Retrieve a site's general global settings. |
UpdateGeneralSettings | PUT %3fresponseFields%3d%7bresponseFields%7d |
Updates a site's general global settings. |