Get Commerce UI Settings

get

/rest/v16/commerceUISettings

Use this endpoint to return Commerce Settings and applicable General Site settings.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

Default Response

Commerce UI Settings
Body ()
Root Schema : settings-response
Type: object
Show Source
Nested Schema : Commerce Settings
Type: object
Title: Commerce Settings
Commerce Settings
Show Source
Nested Schema : General Site Settings
Type: object
Title: General Site Settings
General Site Settings
Show Source
Back to Top

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 -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/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/v16/commerceUISettings"
    }
  ]
}
Back to Top