Jump to

• Request
• Response

updateClientConfiguration

put

/ccadmin/v1/merchant/clientConfiguration

Update the client configuration settings.

Request

Supported Media Types

• application/json

Body ()

Root Schema : saveClientConfiguration_request

Type: object

Show Source

• 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.

{
    "properties":{
        "includeOrderDetailsInShippingMethodsPayload":{
            "description":"Flag to indicate whether Order Information to be passed in request to Shipping Methods.",
            "type":"boolean"
        },
        "skipLoadingProductTypes":{
            "description":"Flag to skip loading all the product types in page data.",
            "type":"boolean"
        },
        "createOrderForLoggedInAtCheckout":{
            "description":"Flag to create an order when a user logs in the checkout page.",
            "type":"boolean"
        },
        "prioritizedLoading":{
            "description":"Flag to indicate whether prioritized loading is enabled.",
            "type":"boolean"
        },
        "useEnhancedSearch":{
            "description":"Flag to indicate whether enhanced search endpoint is enabled.",
            "type":"boolean"
        }
    },
    "example":{
        "includeOrderDetailsInShippingMethodsPayload":true,
        "skipLoadingProductTypes":false,
        "createOrderForLoggedInAtCheckout":false,
        "prioritizedLoading":true,
        "useEnhancedSearch":true
    }
}

Example:

{
    "includeOrderDetailsInShippingMethodsPayload":true,
    "skipLoadingProductTypes":false,
    "createOrderForLoggedInAtCheckout":false,
    "prioritizedLoading":true,
    "useEnhancedSearch":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : saveClientConfiguration_response

Type: object

Show Source

• 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.

{
    "properties":{
        "includeOrderDetailsInShippingMethodsPayload":{
            "description":"Flag to indicate whether Order Information to be passed in request to Shipping Methods.",
            "type":"boolean"
        },
        "skipLoadingProductTypes":{
            "description":"Flag to skip loading all the product types in page data.",
            "type":"boolean"
        },
        "createOrderForLoggedInAtCheckout":{
            "description":"Flag to create an order when a user logs in the checkout page.",
            "type":"boolean"
        },
        "prioritizedLoading":{
            "description":"Flag to indicate whether prioritized loading is enabled.",
            "type":"boolean"
        },
        "useEnhancedSearch":{
            "description":"Flag to indicate whether enhanced search endpoint is enabled.",
            "type":"boolean"
        }
    }
}

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.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top