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

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

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

Response

Success

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