getShopperSettings
get
/ccstore/v1/merchant/shopperSettings
Get global and site level shopper settings
Request
Supported Media Types
- application/json
Header Parameters
-
x-ccsite: string
the site id to retrieve site specific settings
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getShopperSettings_response
Type:
Show Source
object
-
deviceIdentifierDurationDays:
integer
The duration of device identifiers in days.
-
deviceIdentifierDurationDaysMaxVal:
integer
The maximum value of the duration of device identifiers in days.
-
deviceIdentifierDurationDaysMinVal:
integer
The minimum value of the duration of device identifiers in days.
-
enableB2CProfileStatusCheck:
boolean
Indicates whether the B2C user profile should be disabled based on the status of the active field.
-
enableProfileRegistrationEmailCheck:
boolean
true if profile Registration email check is enabled.
-
guestCheckoutEnabled:
boolean
Applies the authorization for anonymous shoppers to sign-in to complete checkout.
-
maxFailedAttempts:
integer
Maximum number of wrong password attempt allowed.
-
multiFactorAuthenticationEnabled:
boolean
Whether the known device multi-factor authentication is enabled.
-
passwordExpirationEnabled:
boolean
Applies the password expiration constraint.
-
passwordExpirationLength:
integer
number of days after which the current password of the shopper will automatically expire.
-
passwordPolicies:
object passwordPolicies
Constraints that must be satisfied by password.
-
selfRegistrationEnabled:
boolean
Set the flag to true if Self Registration is required.
-
sessionTimeoutEnabled:
boolean
Applies the session timeout length constraint.
-
sessionTimeoutLength:
integer
Timeout duration for all shopper sessions.
-
softLoginEnabled:
boolean
true if SoftLogin is enabled.
-
unlockInMinutes:
integer
The number of minutes after which account will be unlocked.
-
userAccountLockEnabled:
boolean
Whether user account locking on multiple failed attempts is enabled or not.
-
verificationCodeDurationMinutes:
integer
The duration of verification codes in minutes.
-
verificationCodeDurationMinutesMaxVal:
integer
The maximum value of the duration of verification codes in minutes.
-
verificationCodeDurationMinutesMinVal:
integer
The minimum value of the duration of verification codes in minutes.
Nested Schema : passwordPolicies
Type:
object
Constraints that must be satisfied by password.
Show Source
-
allowedSymbols:
string
List of symbols allowed in Password.
-
blockCommonPasswords:
boolean
Block the Use of Commonly Chosen Passwords and Weak Passphrases.
-
cannotUsePreviousPasswords:
boolean
Applies the previous password usage constraint.
-
cannotUseUsername:
boolean
Password must not be the same as their Username.
-
minPasswordLength:
integer
Minimum length of the password.
-
numberOfPreviousPasswords:
integer
password should not have been used as previous N passwords for the given shopper user.
-
useMinPasswordLength:
boolean
Applies the minimum password length constraint.
-
useMixedCase:
boolean
Applies the usage of capital letters in user password..
-
useNumber:
boolean
Password must include a number.
-
useSymbol:
boolean
Applies the usage of symbol in user password.
Example Response (application/json)
{
"guestCheckoutEnabled":true,
"verificationCodeDurationMinutesMinVal":1,
"userAccountLockEnabled":false,
"passwordExpirationEnabled":false,
"verificationCodeDurationMinutesMaxVal":1440,
"sessionTimeoutLength":15,
"unlockInMinutes":60,
"passwordExpirationLength":90,
"verificationCodeDurationMinutes":15,
"sessionTimeoutEnabled":true,
"selfRegistrationEnabled":false,
"deviceIdentifierDurationDays":60,
"multiFactorAuthenticationEnabled":true,
"enableB2CProfileStatusCheck":false,
"softLoginEnabled":true,
"enableProfileRegistrationEmailCheck":false,
"passwordPolicies":{
"useNumber":true,
"allowedSymbols":"~!@#$%^&*()_-+={}[]|:;<>,./?",
"numberOfPreviousPasswords":3,
"cannotUseUsername":true,
"useMinPasswordLength":true,
"minPasswordLength":8,
"useMixedCase":true,
"blockCommonPasswords":false,
"cannotUsePreviousPasswords":false,
"useSymbol":true
},
"maxFailedAttempts":6,
"deviceIdentifierDurationDaysMaxVal":365,
"deviceIdentifierDurationDaysMinVal":1
}
Default Response
The error response.
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code