Commerce UI Settings REST API

Overview

This REST API returns Commerce and Site settings required to display Commerce transaction lists and details.

 

Administration

ClosedGet Commerce UI Settings

Get Commerce UI Settings GET Method

Description

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

URI Endpoint

/rest/v17/commerceUISettings

Endpoint Parameters

None

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

commerceSettings

An object containing the Commerce Settings

generatlSiteSettings

An object containing relevant General Settings

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/commerceUISettings


ClosedResponse 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/v17/commerceUISettings" } ] }


 

Related Topics

Related Topics Link IconSee Also