updateClientConfiguration
put
/ccadmin/v1/merchant/clientConfiguration
Update the client configuration settings.
Request
Supported Media Types
- application/json
Root Schema : saveClientConfiguration_request
Type:
Show Source
object
-
createOrderForLoggedInAtCheckout(optional):
boolean
Flag to create an order when a user logs in the checkout page.
-
includeOrderDetailsInShippingMethodsPayload(optional):
boolean
Flag to indicate whether Order Information to be passed in request to Shipping Methods.
-
prioritizedLoading(optional):
boolean
Flag to indicate whether prioritized loading is enabled.
-
skipLoadingProductTypes(optional):
boolean
Flag to skip loading all the product types in page data.
-
useEnhancedSearch(optional):
boolean
Flag to indicate whether enhanced search endpoint is enabled.
Example:
{
"includeOrderDetailsInShippingMethodsPayload":true,
"skipLoadingProductTypes":false,
"createOrderForLoggedInAtCheckout":false,
"prioritizedLoading":true,
"useEnhancedSearch":true
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : saveClientConfiguration_response
Type:
Show Source
object
-
createOrderForLoggedInAtCheckout(optional):
boolean
Flag to create an order when a user logs in the checkout page.
-
includeOrderDetailsInShippingMethodsPayload(optional):
boolean
Flag to indicate whether Order Information to be passed in request to Shipping Methods.
-
prioritizedLoading(optional):
boolean
Flag to indicate whether prioritized loading is enabled.
-
skipLoadingProductTypes(optional):
boolean
Flag to skip loading all the product types in page data.
-
useEnhancedSearch(optional):
boolean
Flag to indicate whether enhanced search endpoint is enabled.
Example Response (application/json)
{
"includeOrderDetailsInShippingMethodsPayload":false,
"skipLoadingProductTypes":false,
"createOrderForLoggedInAtCheckout":false,
"prioritizedLoading":false,
"useEnhancedSearch":false
}
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|
|------------------|------------------|
|13001|Validation errors were found in the input.|
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