Skip to main content
PUT
/
commerce
/
settings
/
general
Error
A valid request URL is required to generate request examples
{
  "isMozuWebSite": true,
  "websiteName": "<string>",
  "customCdnHostName": "<string>",
  "missingImageSubstitute": "<string>",
  "cacheSettings": {
    "cdnCacheBustKey": "<string>"
  },
  "templateSiteId": 123,
  "siteTimeZone": "<string>",
  "siteTimeFormat": "<string>",
  "senderEmailAddress": "<string>",
  "senderEmailAlias": "<string>",
  "replyToEmailAddress": "<string>",
  "bccEmailAddress": "<string>",
  "favIconPath": "<string>",
  "favIconMobilePath": "<string>",
  "logoText": "<string>",
  "logoPath": "<string>",
  "theme": "<string>",
  "mobileTheme": "<string>",
  "tabletTheme": "<string>",
  "googleAnalyticsCode": "<string>",
  "isGoogleAnalyticsEnabled": true,
  "isGoogleAnalyticsEcommerceEnabled": true,
  "isWishlistCreationEnabled": true,
  "isMultishipEnabled": true,
  "isAddressValidationEnabled": true,
  "allowInvalidAddresses": true,
  "is2FAAlwaysRequired": true,
  "is2FARequiredOnFingerprintChange": true,
  "is2FARequiredOnRegionChange": true,
  "isEmailOtpLoginAllowed": true,
  "taxableTerritories": [
    {
      "countryCode": "<string>",
      "stateOrProvinceCode": "<string>",
      "isShippingTaxable": true
    }
  ],
  "supressedEmailTransactions": {
    "backInStock": true,
    "orderChanged": true,
    "orderShipped": true,
    "itemSubstituted": true,
    "orderFulfillmentDetailsChanged": true,
    "shopperLoginCreated": true,
    "shopperPasswordReset": true,
    "returnCreated": true,
    "returnAuthorized": true,
    "returnUpdated": true,
    "returnRejected": true,
    "returnCancelled": true,
    "returnClosed": true,
    "refundCreated": true,
    "storeCreditCreated": true,
    "storeCreditUpdated": true,
    "giftCardCreated": true,
    "orderCancellation": true,
    "orderCancellationFailed": true,
    "backorder": true,
    "shipmentConfirmation": true,
    "orderPickupReady": true,
    "orderPickupReminder": true,
    "shipmentBackorderDateChanged": true,
    "shipmentItemCanceled": true,
    "shipmentAssigned": true,
    "transferShipmentCreated": true,
    "transferShipmentShipped": true,
    "partialPickupReady": true,
    "transferShipmentCreatedByFulfiller": true,
    "intransitConfirmation": true,
    "curbsideReady": true,
    "partialCurbsideReady": true,
    "gatewayGiftCardCreated": true,
    "customerIntransit": true,
    "customerAtCurbside": true,
    "accountDenied": true,
    "accountInactive": true,
    "accountCreated": true,
    "quoteInReview": true,
    "quoteReadyForCheckout": true,
    "quoteExpired": true,
    "deliveryDateUpdated": true,
    "readyForDelivery": true,
    "subscriptionActivated": true,
    "subscriptionPaused": true,
    "subscriptionErrored": true,
    "subscriptionCancelled": true,
    "subscriptionFrequencyUpdated": true,
    "subscriptionOrderedNow": true,
    "subscriptionNextOrderDateUpdated": true,
    "subscriptionPaymentUpdated": true,
    "subscriptionShippingInfoUpdated": true,
    "subscriptionItemAdded": true,
    "subscriptionItemsCancelled": true,
    "subscriptionSkipped": true,
    "subscriptionItemQuantityUpdated": true,
    "subscriptionOrderReminder": true,
    "subscriptionPauseLimitReminder": true,
    "subscriptionPausedReminder": true,
    "substitutionPaymentRequired": true,
    "digitalItemFulfilled": true,
    "orderItemsCanceled": true,
    "otpForLogin": true
  },
  "emailTransactionsOnlyOnRequest": {
    "backInStock": true,
    "orderChanged": true,
    "orderShipped": true,
    "itemSubstituted": true,
    "orderFulfillmentDetailsChanged": true,
    "shopperLoginCreated": true,
    "shopperPasswordReset": true,
    "returnCreated": true,
    "returnAuthorized": true,
    "returnUpdated": true,
    "returnRejected": true,
    "returnCancelled": true,
    "returnClosed": true,
    "refundCreated": true,
    "storeCreditCreated": true,
    "storeCreditUpdated": true,
    "giftCardCreated": true,
    "orderCancellation": true,
    "orderCancellationFailed": true,
    "backorder": true,
    "shipmentConfirmation": true,
    "orderPickupReady": true,
    "orderPickupReminder": true,
    "shipmentBackorderDateChanged": true,
    "shipmentItemCanceled": true,
    "shipmentAssigned": true,
    "transferShipmentCreated": true,
    "transferShipmentShipped": true,
    "partialPickupReady": true,
    "transferShipmentCreatedByFulfiller": true,
    "intransitConfirmation": true,
    "curbsideReady": true,
    "partialCurbsideReady": true,
    "gatewayGiftCardCreated": true,
    "customerIntransit": true,
    "customerAtCurbside": true,
    "accountDenied": true,
    "accountInactive": true,
    "accountCreated": true,
    "quoteInReview": true,
    "quoteReadyForCheckout": true,
    "quoteExpired": true,
    "deliveryDateUpdated": true,
    "readyForDelivery": true,
    "subscriptionActivated": true,
    "subscriptionPaused": true,
    "subscriptionErrored": true,
    "subscriptionCancelled": true,
    "subscriptionFrequencyUpdated": true,
    "subscriptionOrderedNow": true,
    "subscriptionNextOrderDateUpdated": true,
    "subscriptionPaymentUpdated": true,
    "subscriptionShippingInfoUpdated": true,
    "subscriptionItemAdded": true,
    "subscriptionItemsCancelled": true,
    "subscriptionSkipped": true,
    "subscriptionItemQuantityUpdated": true,
    "subscriptionOrderReminder": true,
    "subscriptionPauseLimitReminder": true,
    "subscriptionPausedReminder": true,
    "substitutionPaymentRequired": true,
    "digitalItemFulfilled": true,
    "orderItemsCanceled": true,
    "otpForLogin": true
  },
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "viewAuthorizations": {
    "requireAuthForLive": true,
    "requireAuthForPending": true,
    "enforceSitewideSSL": true
  },
  "customRoutes": {
    "mappings": {},
    "validators": {},
    "routes": [
      {
        "template": "<string>",
        "defaults": {},
        "internalRoute": "<string>",
        "functionId": "<string>",
        "mappings": {},
        "canonical": true,
        "validators": {},
        "urlScheme": "<string>"
      }
    ]
  },
  "emailTypes": [
    {
      "id": "<string>",
      "senderEmailAddressOverride": "<string>",
      "senderEmailAliasOverride": "<string>",
      "replyToEmailAddressOverride": "<string>",
      "bccEmailAddressOverride": "<string>"
    }
  ],
  "supressedSmsTransactions": {
    "shipmentItemCanceled": true,
    "shipmentAssigned": true,
    "customerIntransit": true,
    "customerAtCurbside": true,
    "intransitConfirmation": true,
    "shipmentFulfilled": true,
    "orderConfirmation": true,
    "curbsideReady": true,
    "storeItemsCanceled": true,
    "optOutAcknowledgement": true,
    "orderPickupReady": true,
    "orderPickupReminder": true,
    "customerAtStore": true
  },
  "smsTypes": [
    {
      "id": "<string>"
    }
  ],
  "reCaptchaSettings": {
    "siteKey": "<string>",
    "validScore": 123,
    "secret": "<string>",
    "actions": [
      "<string>"
    ]
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

Properties of the updated general settings. Required properties: WebsiteName, SiteTimeZone, SiteTimeFormat, SenderEmailAddress, and ReplyEmailAddress.

isMozuWebSite
boolean
websiteName
string | null
customCdnHostName
string | null
missingImageSubstitute
string | null
cacheSettings
object
templateSiteId
integer<int32> | null
siteTimeZone
string | null
siteTimeFormat
string | null
senderEmailAddress
string | null
senderEmailAlias
string | null
replyToEmailAddress
string | null
bccEmailAddress
string | null
favIconPath
string | null
favIconMobilePath
string | null
logoText
string | null
logoPath
string | null
theme
string | null
mobileTheme
string | null
tabletTheme
string | null
googleAnalyticsCode
string | null
isGoogleAnalyticsEnabled
boolean | null
isGoogleAnalyticsEcommerceEnabled
boolean | null
isWishlistCreationEnabled
boolean | null
isMultishipEnabled
boolean | null
isAddressValidationEnabled
boolean | null
allowInvalidAddresses
boolean | null
is2FAAlwaysRequired
boolean | null
is2FARequiredOnFingerprintChange
boolean | null
is2FARequiredOnRegionChange
boolean | null
isEmailOtpLoginAllowed
boolean | null
taxableTerritories
object[] | null
supressedEmailTransactions
object
emailTransactionsOnlyOnRequest
object
auditInfo
object
viewAuthorizations
object
customRoutes
object
emailTypes
object[] | null
supressedSmsTransactions
object
smsTypes
object[] | null
reCaptchaSettings
object

Response

Success

isMozuWebSite
boolean
websiteName
string | null
customCdnHostName
string | null
missingImageSubstitute
string | null
cacheSettings
object
templateSiteId
integer<int32> | null
siteTimeZone
string | null
siteTimeFormat
string | null
senderEmailAddress
string | null
senderEmailAlias
string | null
replyToEmailAddress
string | null
bccEmailAddress
string | null
favIconPath
string | null
favIconMobilePath
string | null
logoText
string | null
logoPath
string | null
theme
string | null
mobileTheme
string | null
tabletTheme
string | null
googleAnalyticsCode
string | null
isGoogleAnalyticsEnabled
boolean | null
isGoogleAnalyticsEcommerceEnabled
boolean | null
isWishlistCreationEnabled
boolean | null
isMultishipEnabled
boolean | null
isAddressValidationEnabled
boolean | null
allowInvalidAddresses
boolean | null
is2FAAlwaysRequired
boolean | null
is2FARequiredOnFingerprintChange
boolean | null
is2FARequiredOnRegionChange
boolean | null
isEmailOtpLoginAllowed
boolean | null
taxableTerritories
object[] | null
supressedEmailTransactions
object
emailTransactionsOnlyOnRequest
object
auditInfo
object
viewAuthorizations
object
customRoutes
object
emailTypes
object[] | null
supressedSmsTransactions
object
smsTypes
object[] | null
reCaptchaSettings
object