Jump to

• Request
• Response

getCloudConfiguration

get

/ccstore/v1/merchant/cloudConfiguration

Get Cloud Configuration. Gets the configurations from server.

Request

Supported Media Types

• application/json

Header Parameters

• x-ccsite(required): string
  The site id corresponding to which cloud configurations should be fetched.

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
  The configurations object that holds the client settings
• cpqConfigIDCSEnabled: boolean
  Indicates whether CPQ Config IDCS integration is enabled for the current site context. Value is determined dynamically based on the requesting site's configuration.
• cpqPricingSettings: object cpqPricingSettings
  This is the pricing context used during interaction with CPQ.
• customerDataMasterEnabled: boolean
  The flag is used to enable functionality for onboarding accounts and contacts from the customer data master, or to link commerce accounts and contacts with those in the customer data master.
• 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 returned 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
• enableMaxLevelCheck: 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
• 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
• includeFilteredSkusForProductAndSkuEndpoints: boolean
  When set to true, list/get products and skus endpoints include filtered skus property in the response.
• isB2BEnabled: boolean
  Tells whether b2b is enabled.
• optimizeRelatedProductsForListProductsEndpoint: boolean
  Flag to exclude few properties like parentCategories, parentCategory etc from relatedProducts in listProducts Response
• optimizeRelatedProductsForPageEndpoint: boolean
  Flag to exclude few properties like parentCategories, parentCategory etc from relatedProducts in pageEndpoint Response
• preorderBackorderEnabled: boolean
  Flag to enable preorderBackorderEnabled in products response
• selfServicePortalEnabled: boolean
  Indicates whether the Self-Service Portal feature is enabled for the current site context. Value is derived from server-side configuration based on the requesting site's ID.
• useOrderSubmittedDateForTax: boolean
  Enables use of order submitted date for tax calculation. Flag is useful in returns and exchanges
• visitorService: object visitorService
  Visitor Service configuration details

{
    "properties":{
        "cpqPricingSettings":{
            "description":"This is the pricing context used during interaction with CPQ.",
            "type":"object",
            "properties":{
                "pricingContextProperties":{
                    "type":"object",
                    "properties":{
                        "orderProperties":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "lineProperties":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    }
                },
                "enabled":{
                    "description":"Tells whether CPQ Pricing Integration is enabled.",
                    "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"
        },
        "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"
        },
        "customerDataMasterEnabled":{
            "description":"The flag is used to enable functionality for onboarding accounts and contacts from the customer data master, or to link commerce accounts and contacts with those in the customer data master.",
            "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"
        },
        "allowReturnOnPartiallyFulfilledOrder":{
            "description":"Tells whether returns on partially fulfilled orders is enabled",
            "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"
        },
        "visitorService":{
            "description":"Visitor Service configuration details",
            "type":"object",
            "properties":{
                "visitorServiceHost":{
                    "description":"Visitor Service Host address",
                    "type":"string"
                },
                "tenantId":{
                    "description":"Tenant Id",
                    "type":"string"
                },
                "oracleUnifiedVisitJsUrl":{
                    "description":"oracleunifiedvisit js file url",
                    "type":"string"
                }
            }
        },
        "enablePciCompliance":{
            "description":"Tells whether PCI compliance is enabled.",
            "type":"boolean"
        },
        "cpqConfigIDCSEnabled":{
            "description":"Indicates whether CPQ Config IDCS integration is enabled for the current site context. Value is determined dynamically based on the requesting site's configuration.",
            "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 returned when at least one of the direct edit features is enabled.",
            "type":"integer"
        },
        "preorderBackorderEnabled":{
            "description":"Flag to enable preorderBackorderEnabled in products response",
            "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"
        },
        "selfServicePortalEnabled":{
            "description":"Indicates whether the Self-Service Portal feature is enabled for the current site context. Value is derived from server-side configuration based on the requesting site's ID.",
            "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: boolean
  Flag to create an order when a user logs in the checkout page.
• includeOrderDetailsInShippingMethodsPayload: boolean
  Flag that indicates if the Complete Order payload should be passed to Shipping Methods API
• prioritizedLoading: boolean
  Flag to indicate whether prioritized loading is enabled.
• skipLoadingProductTypes: boolean
  Flag to skip loading all the product types in page data.
• useEnhancedSearch: 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"
        }
    }
}

Nested Schema : cpqPricingSettings

Type: object

This is the pricing context used during interaction with CPQ.

Show Source

• enabled: boolean
  Tells whether CPQ Pricing Integration is enabled.
• pricingContextProperties: object pricingContextProperties

{
    "description":"This is the pricing context used during interaction with CPQ.",
    "type":"object",
    "properties":{
        "pricingContextProperties":{
            "type":"object",
            "properties":{
                "orderProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "lineProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "enabled":{
            "description":"Tells whether CPQ Pricing Integration is enabled.",
            "type":"boolean"
        }
    }
}

Nested Schema : visitorService

Type: object

Visitor Service configuration details

Show Source

• oracleUnifiedVisitJsUrl: string
  oracleunifiedvisit js file url
• tenantId: string
  Tenant Id
• visitorServiceHost: string
  Visitor Service Host address

{
    "description":"Visitor Service configuration details",
    "type":"object",
    "properties":{
        "visitorServiceHost":{
            "description":"Visitor Service Host address",
            "type":"string"
        },
        "tenantId":{
            "description":"Tenant Id",
            "type":"string"
        },
        "oracleUnifiedVisitJsUrl":{
            "description":"oracleunifiedvisit js file url",
            "type":"string"
        }
    }
}

Nested Schema : pricingContextProperties

Type: object

Show Source

• lineProperties: array lineProperties
• orderProperties: array orderProperties

{
    "type":"object",
    "properties":{
        "orderProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lineProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : lineProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : orderProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "excludeAddressList":false,
    "isB2BEnabled":false,
    "includeFilteredSkusForProductAndSkuEndpoints":false,
    "enableCustomOrganizationId":false,
    "customerDataMasterEnabled":false,
    "optimizeRelatedProductsForPageEndpoint":false,
    "clientConfiguration":{
        "includeOrderDetailsInShippingMethodsPayload":false,
        "skipLoadingProductTypes":false,
        "createOrderForLoggedInAtCheckout":false,
        "prioritizedLoading":false,
        "useEnhancedSearch":false
    },
    "optimizeRelatedProductsForListProductsEndpoint":false,
    "allowReturnOnPartiallyFulfilledOrder":false,
    "enablePurchaseListItemCustomPropertiesAsKeys":false,
    "visitorService":{
        "visitorServiceHost":"//localhost",
        "tenantId":"5dbd2e4a",
        "oracleUnifiedVisitJsUrl":"//localhost/Visit/js/oracleunifiedvisit.js"
    },
    "enablePciCompliance":false,
    "cpqConfigIDCSEnabled":false,
    "directEditEventProcessingIntervalSeconds":10,
    "preorderBackorderEnabled":false,
    "enableChildEntitiesLimit":false,
    "enableMaxLevelCheck":false,
    "selfServicePortalEnabled":true,
    "maxChildItemsCount":1000,
    "useOrderSubmittedDateForTax":false
}

Default Response

The error response

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