saveAdminConfiguration
put
/ccadmin/v1/merchant/adminConfiguration
Save Admin Configuration. Saves the admin configurable properties and gets back the saved data.
Request
Supported Media Types
- application/json
Root Schema : saveAdminConfiguration_request
Type:
Show Source
object
-
allowedOriginMethods(optional):
object allowedOriginMethods
Additional Properties Allowed: additionalPropertiesMap of hostname (key) and the allowed http methods (values) for that host.
-
sessionTimeout(optional):
integer
Tells how long the before the session times out in the admin application in minutes (3-120).
-
sortByPriceEnabled(optional):
boolean
Flag to signify whether sorting by price is enabled in this environment.
-
sortByPriceProductLimit(optional):
integer
Maximum number of total products for which the sort by price feature should be available.
-
supportVersion1Catalogs(optional):
boolean
Set to true to enable legacy (version 1) catalog support in the system.
Example:
{
"sortByPriceEnabled":true,
"supportVersion1Catalogs":true,
"allowedOriginMethods":{
"https://somemoresecurehost":"GET",
"https://someHost:9080":"GET,PUT,DELETE,POST,OPTIONS"
},
"sessionTimeout":15,
"sortByPriceProductLimit":200000
}
Nested Schema : allowedOriginMethods
Type:
object
Additional Properties Allowed
Show Source
Map of hostname (key) and the allowed http methods (values) for that host.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : saveAdminConfiguration_response
Type:
Show Source
object
-
allowedOriginMethods(optional):
object allowedOriginMethods
Additional Properties Allowed: additionalPropertiesMap of hostname (key) and the allowed http methods (values) for that host.
-
sessionTimeout(optional):
integer
Tells how long the before the session times out in the admin application.
-
sortByPriceEnabled(optional):
boolean
Flag to signify whether sorting by price is enabled in this environment.
-
sortByPriceProductLimit(optional):
integer
Maximum number of total products for which the sort by price feature should be available.
-
supportVersion1Catalogs(optional):
boolean
If true then legacy (version 1) catalog is supported in the system.
Nested Schema : allowedOriginMethods
Type:
object
Additional Properties Allowed
Show Source
Map of hostname (key) and the allowed http methods (values) for that host.
Example Response (application/json)
{
"sortByPriceEnabled":true,
"supportVersion1Catalogs":false,
"allowedOriginMethods":{
"https://somemoresecurehost":"GET",
"https://someHost:9080":"GET,PUT,DELETE,POST,OPTIONS"
},
"sessionTimeout":15,
"sortByPriceProductLimit":20000
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|96009|A problem occurred when saving the data.|
|160023|An internal error occurred while processing input request.|
|20145|Unable to disable v1 catalog support because there are un-deleted v1 catalogs in the system.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
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(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code