getCloudConfiguration
get
/ccstore/v1/merchant/cloudConfiguration
Get Cloud Configuration. Gets the configurations from server.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getCloudConfiguration_response
Type:
Show Source
object
-
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
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.
Example Response (application/json)
{
"excludeAddressList":false,
"isB2BEnabled":false,
"includeFilteredSkusForProductAndSkuEndpoints":false,
"preorderBackorderEnabled":false,
"enableMaxLevelCheck":false,
"optimizeRelatedProductsForPageEndpoint":false,
"clientConfiguration":{
"includeOrderDetailsInShippingMethodsPayload":false,
"skipLoadingProductTypes":false,
"createOrderForLoggedInAtCheckout":false,
"prioritizedLoading":false,
"useEnhancedSearch":false
},
"optimizeRelatedProductsForListProductsEndpoint":false,
"allowReturnOnPartiallyFulfilledOrder":false,
"visitorService":{
"visitorServiceHost":"//localhost",
"tenantId":"5dbd2e4a",
"oracleUnifiedVisitJsUrl":"//localhost/Visit/js/oracleunifiedvisit.js"
},
"useOrderSubmittedDateForTax":false
}
Default Response
The error response
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