Jump to

• Request
• Response

updateCloudConfiguration

put

/ccadmin/v1/merchant/cloudConfiguration

Update Cloud Configuration. Updates any writable cloud configuration properties.

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateCloudConfiguration_request

Type: object

Show Source

• allowReturnOnPartiallyFulfilledOrder: boolean
  If true, enable returns on partially fulfilled orders.
• directEditEventProcessingIntervalSeconds: integer
  The delay with which direct editing changes appear on Storefront. The property can take a value between 0 and 60. It is only used when at least one of the direct edit features is enabled.
• enableCustomOrganizationId: boolean
  Flag is used for create organization endpoint. Indicates whether an organization should be created with the specific id provided in the input or not
• enableDefaultSortForListProducts: boolean
  Enables sort by id for non leaf categories for the list products endpoint when no sort param is sent
• enablePciCompliance: boolean
  Enables PCI compliance.
• enablePurchaseListItemCustomPropertiesAsKeys: boolean
  Flag is used for purchase list end point. Tells us whether to use purchase list line items custom properties as unique keys or not
• excludeAddressList: 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: 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.
• includeDiscountInfoInOrderResponse: boolean
  If true, include discount information in responses which return order objects.
• includeFilteredSkusForProductAndSkuEndpoints: boolean
  When set to true, list/get products and skus endpoints include filtered skus property in the response.
• strictExtraPropertiesValidation: boolean
  If false, enables less strict unknown extra properties detection as a backwards compatibility mode. A true value enforces checks for unknown extra properties consistently.
• useOrderSubmittedDateForTax: 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"
        },
        "enablePciCompliance":{
            "description":"Enables PCI compliance.",
            "type":"boolean"
        },
        "includeFilteredSkusForProductAndSkuEndpoints":{
            "description":"When set to true, list/get products and skus endpoints include filtered skus property in the response.",
            "type":"boolean"
        },
        "directEditEventProcessingIntervalSeconds":{
            "description":"The delay with which direct editing changes appear on Storefront. The property can take a value between 0 and 60. It is only used when at least one of the direct edit features is enabled.",
            "type":"integer"
        },
        "enableCustomOrganizationId":{
            "description":"Flag is used for create organization endpoint. Indicates whether an organization should be created with the specific id provided in the input or not",
            "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"
        },
        "includeDiscountInfoInOrderResponse":{
            "description":"If true, include discount information in responses which return order objects.",
            "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 compatibility mode. A true value enforces checks for unknown extra properties consistently.",
            "type":"boolean"
        },
        "allowReturnOnPartiallyFulfilledOrder":{
            "description":"If true, enable returns on partially fulfilled orders.",
            "type":"boolean"
        },
        "enablePurchaseListItemCustomPropertiesAsKeys":{
            "description":"Flag is used for purchase list end point. Tells us whether to use purchase list line items custom properties as unique keys or not",
            "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,
        "directEditEventProcessingIntervalSeconds":10,
        "fallbackShippingEnabled":true
    }
}

Example:

{
    "includeFilteredSkusForProductAndSkuEndpoints":false,
    "directEditEventProcessingIntervalSeconds":10,
    "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: boolean
  Tells whether returns on partially fulfilled orders is enabled
• clientConfiguration: object clientConfiguration
  Merchant Client configuration.
• defaultCatalog: object defaultCatalog
  Default Catalog
• enableCustomOrganizationId: boolean
  Flag is used for create organization endpoint. Indicates whether an organization should be created with the specific id provided in the input or not
• enableDefaultSortForListProducts: boolean
  Enables sort by id for non leaf categories for the list products endpoint when no sort param is sent
• enablePciCompliance: boolean
  Tells whether PCI compliance is enabled.
• enablePurchaseListItemCustomPropertiesAsKeys: boolean
  Flag is used for purchase list end point. Tells us whether to use purchase list line items custom properties as unique keys or not
• excludeAddressList: 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
• isAgentAppEnabled: boolean
  Tells whether agent application is enabled or not.
• isB2BEnabled: boolean
  Tells whether b2b is enabled.
• isShowTaxSummaryEnabled: boolean
  Tells whether Displaying Tax Summary is enabled or not.
• masterCatalogId: string
  Master catalog id
• strictExtraPropertiesValidation: boolean
  If false, enables less strict unknown extra-properties detection as a backwards compatability mode.
• useOrderSubmittedDateForTax: 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"
        },
        "enableCustomOrganizationId":{
            "description":"Flag is used for create organization endpoint. Indicates whether an organization should be created with the specific id provided in the input or not",
            "type":"boolean"
        },
        "clientConfiguration":{
            "description":"Merchant Client configuration.",
            "type":"object",
            "properties":{
                "includeOrderDetailsInShippingMethodsPayload":{
                    "description":"If true, the order details are to be included in the payload for listShippingMethod endpoint request.",
                    "type":"boolean"
                },
                "createOrderForLoggedInAtCheckout":{
                    "description":"Flag to create an order when a user logs in the checkout page.",
                    "type":"boolean"
                }
            }
        },
        "masterCatalogId":{
            "description":"Master catalog id",
            "type":"string"
        },
        "defaultCatalog":{
            "description":"Default Catalog",
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"Default catalog display name",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"Repository id of the default catalog",
                    "type":"string"
                }
            }
        },
        "allowReturnOnPartiallyFulfilledOrder":{
            "description":"Tells whether returns on partially fulfilled orders is enabled",
            "type":"boolean"
        },
        "strictExtraPropertiesValidation":{
            "description":"If false, enables less strict unknown extra-properties detection as a backwards compatability mode.",
            "type":"boolean"
        },
        "enablePurchaseListItemCustomPropertiesAsKeys":{
            "description":"Flag is used for purchase list end point. Tells us whether to use purchase list line items custom properties as unique keys or not",
            "type":"boolean"
        },
        "enablePciCompliance":{
            "description":"Tells whether PCI compliance is enabled.",
            "type":"boolean"
        },
        "isAgentAppEnabled":{
            "description":"Tells whether agent application is enabled or not.",
            "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

Merchant Client configuration.

Show Source

• createOrderForLoggedInAtCheckout: boolean
  Flag to create an order when a user logs in the checkout page.
• includeOrderDetailsInShippingMethodsPayload: boolean
  If true, the order details are to be included in the payload for listShippingMethod endpoint request.

{
    "description":"Merchant Client configuration.",
    "type":"object",
    "properties":{
        "includeOrderDetailsInShippingMethodsPayload":{
            "description":"If true, the order details are to be included in the payload for listShippingMethod endpoint request.",
            "type":"boolean"
        },
        "createOrderForLoggedInAtCheckout":{
            "description":"Flag to create an order when a user logs in the checkout page.",
            "type":"boolean"
        }
    }
}

Nested Schema : defaultCatalog

Type: object

Default Catalog

Show Source

• displayName: string
  Default catalog display name
• repositoryId: string
  Repository id of the default catalog

{
    "description":"Default Catalog",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Default catalog display name",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository id of the default catalog",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "isShowTaxSummaryEnabled":true,
    "excludeAddressList":false,
    "isB2BEnabled":false,
    "includeFilteredSkusForProductAndSkuEndpoints":false,
    "enableCustomOrganizationId":false,
    "optimizeRelatedProductsForPageEndpoint":false,
    "clientConfiguration":{
        "includeOrderDetailsInShippingMethodsPayload":false,
        "skipLoadingProductTypes":false,
        "createOrderForLoggedInAtCheckout":false,
        "prioritizedLoading":false,
        "useEnhancedSearch":false
    },
    "optimizeRelatedProductsForListProductsEndpoint":false,
    "excludeDynamicContentFromMetadataCatalog":null,
    "strictExtraPropertiesValidation":true,
    "allowReturnOnPartiallyFulfilledOrder":false,
    "enablePurchaseListItemCustomPropertiesAsKeys":false,
    "enablePciCompliance":false,
    "directEditEventProcessingIntervalSeconds":10,
    "isAgentAppEnabled":true,
    "enableChildEntitiesLimit":false,
    "enableMaxLevelCheck":false,
    "enableDefaultSortForListProducts":false,
    "includeDiscountInfoInOrderResponse":true,
    "globalCORSConfiguration":{
        "allowAllOriginsURIs":{
            "/ccstoreui/v1/products":"GET",
            "/ccstore/v1/products":"GET"
        }
    },
    "maxChildItemsCount":1000,
    "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: 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

{
    "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: 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

{
    "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