Jump to

• Request
• Response

updateCloudConfiguration

put

/ccadmin/v1/merchant/cloudConfiguration

Update Cloud Configuration. Updates any writable cloud configuration properties. Currently the only writable property is strictExtraPropertiesValidation, which can be set to false to enable a backwards compatability in which extra properties are sometimes ignored.

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateCloudConfiguration_request

Type: object

Show Source

• allowReturnOnPartiallyFulfilledOrder(optional): boolean
  If true, enable returns on partially fulfilled orders.
• enableDefaultSortForListProducts(optional): boolean
  Enables sort by id for non leaf categories for the list products endpoint when no sort param is sent
• excludeAddressList(optional): boolean
  Flag to exclude addresses apart from listAddresses and listProfileAddresses endpoints. This should be set to true when there are large number of addresses in an account or profile
• excludeDynamicContentFromMetadataCatalog(optional): string
  This setting allows you to exclude some of the dynamic content from Swagger. This is helpful when Swagger size grows to a large size and is not manageable, especially when the number of price lists or custom properties is large. It accepts a comma-separated value of property names that are to be excluded from Swagger. Valid values are: "price" to exclude price groups and volume price details; "product" to exclude Product and SKU variant and specification details; "all" to exclude all dynamic content including custom properties for all entities; or null (default) to include everything. Note that values can be combined in CSV format.
• includeFilteredSkusForProductAndSkuEndpoints(optional): boolean
  When set to true, list/get products and skus endpoints include filtered skus property in the response.
• strictExtraPropertiesValidation(optional): boolean
  If false, enables less strict unknown extra properties detection as a backwards compatability mode. A true value enforces checkes for unknown extra properties consistently.
• useOrderSubmittedDateForTax(optional): boolean
  Enables use of order submitted date for tax calculation. Flag is useful in returns and exchanges

{
    "properties":{
        "excludeAddressList":{
            "description":"Flag to exclude addresses apart from listAddresses and listProfileAddresses endpoints. This should be set to true when there are large number of addresses in an account or profile",
            "type":"boolean"
        },
        "includeFilteredSkusForProductAndSkuEndpoints":{
            "description":"When set to true, list/get products and skus endpoints include filtered skus property in the response.",
            "type":"boolean"
        },
        "enableDefaultSortForListProducts":{
            "description":"Enables sort by id for non leaf categories for the list products endpoint when no sort param is sent",
            "type":"boolean"
        },
        "excludeDynamicContentFromMetadataCatalog":{
            "description":"This setting allows you to exclude some of the dynamic content from Swagger. This is helpful when Swagger size grows to a large size and is not manageable, especially when the number of price lists or custom properties is large. It accepts a comma-separated value of property names that are to be excluded from Swagger. Valid values are: \"price\" to exclude price groups and volume price details; \"product\" to exclude Product and SKU variant and specification details; \"all\" to exclude all dynamic content including custom properties for all entities; or null (default) to include everything. Note that values can be combined in CSV format.",
            "type":"string"
        },
        "strictExtraPropertiesValidation":{
            "description":"If false, enables less strict unknown extra properties detection as a backwards compatability mode. A true value enforces checkes for unknown extra properties consistently.",
            "type":"boolean"
        },
        "allowReturnOnPartiallyFulfilledOrder":{
            "description":"If true, enable returns on partially fulfilled orders.",
            "type":"boolean"
        },
        "useOrderSubmittedDateForTax":{
            "description":"Enables use of order submitted date for tax calculation. Flag is useful in returns and exchanges",
            "type":"boolean"
        }
    },
    "example":{
        "includeFilteredSkusForProductAndSkuEndpoints":false,
        "fallbackShippingEnabled":true
    }
}

Example:

{
    "includeFilteredSkusForProductAndSkuEndpoints":false,
    "fallbackShippingEnabled":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getCloudConfiguration_response

Type: object

Show Source

• allowReturnOnPartiallyFulfilledOrder(optional): boolean
  Tells whether returns on partially fulfilled orders is enabled
• clientConfiguration(optional): object clientConfiguration
  The configurations object that holds the client settings
• enableDefaultSortForListProducts(optional): boolean
  Enables sort by id for non leaf categories for the list products endpoint when no sort param is sent
• enableMaxLevelCheck(optional): boolean
  Enable max level check for getCollection endpoint. This flag would either turn max level check on/off for the endpoint with default value as false
• excludeAddressList(optional): boolean
  Flag to exclude addresses apart from listAddresses and listProfileAddresses endpoints. This should be set to true when there are large number of addresses in an account or profile
• excludeDynamicContentFromMetadataCatalog(optional): string
  This setting allows you to exclude some of the dynamic content from Swagger. This is helpful when Swagger size grows to a large size and is not manageable, especially when the number of price lists or custom properties is large. It accepts a comma-separated value of property names that are to be excluded from Swagger. Valid values are: "price" to exclude price groups and volume price details; "product" to exclude Product and SKU variant and specification details; "all" to exclude all dynamic content including custom properties for all entities; or null (default) to include everything. Note that values can be combined in CSV format.
• includeFilteredSkusForProductAndSkuEndpoints(optional): boolean
  When set to true, list/get products and skus endpoints include filtered skus property in the response.
• isAgentAppEnabled(optional): boolean
  Tells whether agent application is enabled or not.
• isB2BEnabled(optional): boolean
  Tells whether b2b is enabled.
• isShowTaxSummaryEnabled(optional): boolean
  Tells whether Displaying Tax Summary is enabled or not.
• optimizeRelatedProductsForListProductsEndpoint(optional): boolean
  Flag to exclude few properties like parentCategories, parentCategory etc from relatedProducts in listProducts Response
• optimizeRelatedProductsForPageEndpoint(optional): boolean
  Flag to exclude few properties like parentCategories, parentCategory etc from relatedProducts in pageEndpoint Response
• strictExtraPropertiesValidation(optional): boolean
  If false, enables less strict unknown extra-properties detection as a backwards compatability mode.
• useOrderSubmittedDateForTax(optional): boolean
  Enables use of order submitted date for tax calculation. Flag is useful in returns and exchanges

{
    "properties":{
        "isShowTaxSummaryEnabled":{
            "description":"Tells whether Displaying Tax Summary is enabled or not.",
            "type":"boolean"
        },
        "excludeAddressList":{
            "description":"Flag to exclude addresses apart from listAddresses and listProfileAddresses endpoints. This should be set to true when there are large number of addresses in an account or profile",
            "type":"boolean"
        },
        "isB2BEnabled":{
            "description":"Tells whether b2b is enabled.",
            "type":"boolean"
        },
        "includeFilteredSkusForProductAndSkuEndpoints":{
            "description":"When set to true, list/get products and skus endpoints include filtered skus property in the response.",
            "type":"boolean"
        },
        "optimizeRelatedProductsForPageEndpoint":{
            "description":"Flag to exclude few properties like parentCategories, parentCategory etc from relatedProducts in pageEndpoint Response",
            "type":"boolean"
        },
        "clientConfiguration":{
            "description":"The configurations object that holds the client settings",
            "type":"object",
            "properties":{
                "includeOrderDetailsInShippingMethodsPayload":{
                    "description":"Flag that indicates if the Complete Order payload should be passed to Shipping Methods API",
                    "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"
                }
            }
        },
        "optimizeRelatedProductsForListProductsEndpoint":{
            "description":"Flag to exclude few properties like parentCategories, parentCategory etc from relatedProducts in listProducts Response",
            "type":"boolean"
        },
        "excludeDynamicContentFromMetadataCatalog":{
            "description":"This setting allows you to exclude some of the dynamic content from Swagger. This is helpful when Swagger size grows to a large size and is not manageable, especially when the number of price lists or custom properties is large. It accepts a comma-separated value of property names that are to be excluded from Swagger. Valid values are: \"price\" to exclude price groups and volume price details; \"product\" to exclude Product and SKU variant and specification details; \"all\" to exclude all dynamic content including custom properties for all entities; or null (default) to include everything. Note that values can be combined in CSV format.",
            "type":"string"
        },
        "strictExtraPropertiesValidation":{
            "description":"If false, enables less strict unknown extra-properties detection as a backwards compatability mode.",
            "type":"boolean"
        },
        "allowReturnOnPartiallyFulfilledOrder":{
            "description":"Tells whether returns on partially fulfilled orders is enabled",
            "type":"boolean"
        },
        "isAgentAppEnabled":{
            "description":"Tells whether agent application is enabled or not.",
            "type":"boolean"
        },
        "enableMaxLevelCheck":{
            "description":"Enable max level check for getCollection endpoint. This flag would either turn max level check on/off for the endpoint with default value as false",
            "type":"boolean"
        },
        "enableDefaultSortForListProducts":{
            "description":"Enables sort by id for non leaf categories for the list products endpoint when no sort param is sent",
            "type":"boolean"
        },
        "useOrderSubmittedDateForTax":{
            "description":"Enables use of order submitted date for tax calculation. Flag is useful in returns and exchanges",
            "type":"boolean"
        }
    }
}

Nested Schema : clientConfiguration

Type: object

The configurations object that holds the client settings

Show Source

• createOrderForLoggedInAtCheckout(optional): boolean
  Flag to create an order when a user logs in the checkout page.
• includeOrderDetailsInShippingMethodsPayload(optional): boolean
  Flag that indicates if the Complete Order payload should be passed to Shipping Methods API
• 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.

{
    "description":"The configurations object that holds the client settings",
    "type":"object",
    "properties":{
        "includeOrderDetailsInShippingMethodsPayload":{
            "description":"Flag that indicates if the Complete Order payload should be passed to Shipping Methods API",
            "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)

{
    "isShowTaxSummaryEnabled":true,
    "excludeAddressList":false,
    "isB2BEnabled":false,
    "includeFilteredSkusForProductAndSkuEndpoints":false,
    "optimizeRelatedProductsForPageEndpoint":false,
    "clientConfiguration":{
        "includeOrderDetailsInShippingMethodsPayload":false,
        "skipLoadingProductTypes":false,
        "createOrderForLoggedInAtCheckout":false,
        "prioritizedLoading":false,
        "useEnhancedSearch":false
    },
    "optimizeRelatedProductsForListProductsEndpoint":false,
    "excludeDynamicContentFromMetadataCatalog":null,
    "strictExtraPropertiesValidation":true,
    "allowReturnOnPartiallyFulfilledOrder":false,
    "isAgentAppEnabled":true,
    "enableMaxLevelCheck":false,
    "enableDefaultSortForListProducts":false,
    "globalCORSConfiguration":{
        "allowAllOriginsURIs":{
            "/ccstoreui/v1/products":"GET",
            "/ccstore/v1/products":"GET"
        }
    },
    "useOrderSubmittedDateForTax":true
}

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| |------------------|------------------| |30012|Could not get site {0}|

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