Get Commerce Settings
get
/rest/v19/commerceUISettings
Use this endpoint to return Commerce Settings and applicable General Site settings.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
Commerce UI Settings
Root Schema : settings-response
Type:
Show Source
object-
commerceSettings:
object Commerce Settings
Title:
Commerce SettingsCommerce Settings -
generalSiteSettings:
object General Site Settings
Title:
General Site SettingsGeneral Site Settings
Nested Schema : Commerce Settings
Type:
objectTitle:
Commerce SettingsCommerce Settings
Show Source
-
accountsProviderLibraryFunctionVarName:
string
Title:
accountsProviderLibraryFunctionVarNameAccounts Lookup Library Function -
allowCommerceDeployment:
string
Title:
allowCommerceDeploymentAllow Commerce Processes and Invocations to be Deployed and Undeployed -
allowProcessClone:
string
Title:
allowProcessCloneAllow Commerce Processes to be Cloned and Migrated -
allowSearchForId:
string
Title:
allowSearchForIdAllow the Transaction ID to be included in the Commerce Search -
assetsSyncTaskRecurrenceInterval:
string
Title:
assetsSyncTaskRecurrenceIntervalSynchronization Interval for Asset Integration -
cmQuickLinksHeight:
string
Title:
cmQuickLinksHeightDialog Dimensions - Quick Links -
cmQuickLinksWidth:
string
Title:
cmQuickLinksWidthDialog Dimensions - Quick Links -
cmSearchHeight:
string
Title:
cmSearchHeightDialog Dimensions - Commerce Search -
cmSearchWidth:
string
Title:
cmSearchWidthDialog Dimensions - Commerce Search -
commerceAjaxLoadingDialogDelay:
string
Title:
commerceAjaxLoadingDialogDelayNumber of Milliseconds to Wait Before Showing the Loading Dialog for Ajax Rules -
commerceDynamicMenuResultSetLimit:
string
Title:
commerceDynamicMenuResultSetLimitMaximum number of results to display in a Commerce Dynamic Menu Attribute -
commerceNetAmountSubdocAttrVarName:
string
Title:
commerceNetAmountSubdocAttrVarNameVariable Name of Net Amount attribute at the Sub Document Level used for Delta Price calculation -
commercePricingBehavior:
string
Title:
commercePricingBehaviorCommerce Pricing Behavior -
commerceTimeout:
string
Title:
commerceTimeoutTimeout in minutes -
commerceTimeoutAction:
string
Title:
commerceTimeoutActionCommerce Timeout Action -
compoundPartDisplayLookup:
string
Title:
compoundPartDisplayLookupDisplay Part Number on Part Display Quick Key Search Results -
docDesignerNumberOfEsigSigners:
string
Title:
docDesignerNumberOfEsigSignersDoc Designer - Number of eSignature signers -
docDesignerSnippetsPreserveLineFeeds:
string
Title:
docDesignerSnippetsPreserveLineFeedsDoc Designer - Preserve line feeds for XSL snippets. Documents must be deployed for any change to take effect. -
docEngineValidateOnSavePage:
string
Title:
docEngineValidateOnSavePageDocument Engine - Validate page data on save -
enableABOFieldAdjustmentForCopy:
string
Title:
enableABOFieldAdjustmentForCopyEnable ABO Field Adjustment for Copy -
enableBomForSP:
string
Title:
enableBomForSPEnable Subscription Ordering for Simple Products -
enableFixedProductStructureExpansionOnCommerceTransactions:
string
Title:
enableFixedProductStructureExpansionOnCommerceTransactionsEnable Fixed Product Structure expansion on Commerce transactions -
enableHtmlApprovalEmails:
string
Title:
enableHtmlApprovalEmailsEnable HTML Approval Email -
enableParentLineFiltering:
string
Title:
enableParentLineFilteringFilter Rule - Enable parent filtering and rolling up children -
enablePartnerOrgFiltering:
string
Title:
enablePartnerOrgFilteringEnable Company Associations on Part Display Search -
errorBoxBehavior:
string
Title:
errorBoxBehaviorError Box Behavior -
ignoreBlanksInPayload:
string
Title:
ignoreBlanksInPayloadIgnore blank attributes in SOAP API Payload for modify action -
ligColumnFreezeCols:
string
Title:
ligColumnFreezeColsNumber of columns to freeze on line item grid -
ligStickyHeader:
string
Title:
ligStickyHeaderEnable sticky header for line item grid -
numberOfErrorMessages:
string
Title:
numberOfErrorMessagesNumber of Error Messages to be Displayed on Collapse -
selectCurrencyForNewQuote:
string
Title:
selectCurrencyForNewQuoteAllow Users to Select Currency for Quotes Created from the Transaction Manager -
showQuoteTotalForLayouts:
string
Title:
showQuoteTotalForLayoutsEnable Transaction Total for Mobile Layouts -
showSelectLanguagePreferenceMenu:
string
Title:
showSelectLanguagePreferenceMenuShow Select Language Preference menu for Print, Email and Export Actions -
suppressAddToCartOnAddFromCatalog:
string
Title:
suppressAddToCartOnAddFromCatalogHide Shopping Cart Button on Add From Catalog -
suppressCommerceButtonOnAddFromCatalog:
string
Title:
suppressCommerceButtonOnAddFromCatalogHide Commerce Invocation Buttons on Add From Catalog -
transferPricingJSON:
string
Title:
transferPricingJSONTransfer Advanced Pricing Profiles JSON to Commerce -
transItemCount:
string
Title:
transItemCountDisable Transaction Item Count
Nested Schema : General Site Settings
Type:
objectTitle:
General Site SettingsGeneral Site Settings
Show Source
-
buttonAlignment:
string
Title:
buttonAlignmentButton Alignment on Pages with no Template -
buttonPosition:
string
Title:
buttonPositionButton Position on Pages with no Template -
cmListItr:
string
Title:
cmListItrCommerce List Page Result Set Size -
guestAccess:
string
Title:
guestAccessAllow Guest Access -
includeLanguagePreference:
string
Title:
includeLanguagePreferenceInclude Language Preference -
loadingImage:
string
Title:
loadingImageLoading Dialog Image -
loadingWithText:
string
Title:
loadingWithTextInclude Text -
newTabFromSearch:
string
Title:
newTabFromSearchOpen transactions in a new tab from Commerce Search -
searchCommerceLead:
string
Title:
searchCommerceLeadCommerce Search Behavior- Leading Wildcard -
searchCommerceTrail:
string
Title:
searchCommerceTrailCommerce Search Behavior- Trailing Wildcard -
showBmLogo:
string
Title:
showBmLogoShow the Oracle Logo at the bottom of each page
Examples
The following example shows how to retrieve Commerce Settings and General Site settings used in Commerce by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/commerceUISettings
Response Body Sample
{
"commerceSettings": {
"commerceAjaxLoadingDialogDelay": "1000",
"allowCommerceDeployment": "Yes",
"allowProcessClone": "Yes",
"allowSearchForId": "Yes",
"suppressCommerceButtonOnAddFromCatalog": "Yes",
"suppressAddToCartOnAddFromCatalog": "No",
"showSelectLanguagePreferenceMenu": "Yes",
"cmSearchWidth": "600",
"cmSearchHeight": "600",
"cmQuickLinksWidth": "400",
"cmQuickLinksHeight": "900",
"errorBoxBehavior": "Collapsible",
"numberOfErrorMessages": "4",
"docEngineValidateOnSavePage": "No",
"showQuoteTotalForLayouts": "Yes",
"ignoreBlanksInPayload": "Yes",
"compoundPartDisplayLookup": "Yes",
"docDesignerNumberOfEsigSigners": "5",
"docDesignerSnippetsPreserveLineFeeds": "No",
"enablePartnerOrgFiltering": "Yes",
"commerceTimeoutAction": "Log Only",
"commerceTimeout": "2",
"selectCurrencyForNewQuote": "Yes",
"commercePricingBehavior": "Version 3",
"transferPricingJSON": "Yes",
"ligStickyHeader": "No",
"ligColumnFreezeCols": "0",
"transItemCount": "No",
"accountsProviderLibraryFunctionVarName": "",
"enableBomForSP": "No",
"enableHtmlApprovalEmails": "Yes",
"enableParentLineFiltering": "No",
"commerceDynamicMenuResultSetLimit": "250",
"enableABOFieldAdjustmentForCopy": "No",
"commerceNetAmountSubdocAttrVarName": "",
"assetsSyncTaskRecurrenceInterval": "12",
"enableFixedProductStructureExpansionOnCommerceTransactions": "Yes"
},
"generalSiteSettings": {
"showBmLogo": "Yes",
"buttonPosition": "both",
"buttonAlignment": "right",
"loadingImage": "$BASE_PATH$/images/processingBar.gif",
"loadingWithText": "no",
"includeLanguagePreference": "No",
"newTabFromSearch": "No",
"guestAccess": "Yes",
"cmListItr": "10",
"searchCommerceLead": "Explicit",
"searchCommerceTrail": "Implicit"
},
"links": [{
"rel": "self",
"href": "http://sitename.oracle.com/rest/v19/commerceUISettings"
}
]
}