Loading...
Area: Episerver B2B Commerce

Settings handlers

Recommended reading 

NOTE: Calling the general /api/v1/settings endpoint returns all settings: Account, Cart, Product, Search, Customer, Invoice, Order, Quote, and Wishlists. However, Account, Cart, Products, Quote, and Wishlists have their own unique endpoints, which, when used, return additional information. Therefore it is recommended to compare the general endpoint against the more specific endpoint to ensure you are returning the desired information.

HTTP Verb: GET

URL: /api/v1/settings

Description: Returns settings for Account, Cart, Product, Search, Customer, Invoice, Order, Quote, and Wishlists

Base: HandlerBase<GetSettingsCollectionParameter, GetSettingsCollectionResult>

Handlers:

Order Handler Description
500 GetSettingsCollectionHandler

Gets all the active website settings including: customer, cart, account, order, product, quote/rfq, wish list.

Order Handler Description
500 GetSettingsCollection

Retrieves all settings for all services that implement the ISettingsService interface. The settings are stored in the SettingsCollection property on the result object.

 

HTTP Verb: GET

URL: /api/v1/settings or /api/v1/settings/account

Description: Gets the account settings.

Base: HandlerBase<GetAccountSettingsParameter, GetAccountSettingsResult>

Handlers:

Order Handler Description
500 GetAccountSettings

Retrieves settings which related to account:

  • AllowCreateAccount
  • AllowGuestCheckout
  • AllowSubscribeToNewsLetter
  • RequireSelectCustomerOnSignIn
  • PasswordMinimumLength
  • MinRequiredNonAlphanumericChar
  • MinRequiredDigits
  • MinRequiredLowercase
  • MinRequiredUppercase
  • PasswordMinimumRequiredLength
  • PasswordRequiresSpecialCharacter
  • PasswordRequiresUppercase
  • PasswordRequiresLowercase
  • PasswordRequiresDigit
  • RememberMe
  • DaysToRetainUser

 

HTTP Verb: GET

URL: /api/v1/settings or /api/v1/settings/cart

Description: Gets the cart settings.

Base: HandlerBase<GetCartSettingsParameter, GetCartSettingsResult>

Handlers:

Order Handler Description
500 GetCartSettings

Retrieves the following cart settings and stores them in the result object. Most of the settings are stored in similarly-named properties on the result object.

Checkout Settings:

  • EnableRequestDeliveryDate
  • MaximumDeliveryPeriod
  • AllowPONumbers (ShowPoNumber on result object)
  • AllowCreditCardPaymentMethod (ShowCreditCard on result object)
  • ShowNewsletterSignup
  • PONumberRequired

Requisitions Settings:

  • Enabled (CanRequisition on result object)

Budgets and Order Approval Settings:

  • AllowCostCodeEdit (CanEditCostCode on result object)
  • ShowCostCode

Payment Settings:

  • ShowPayPal

Cart Settings:

  • ShowTaxAndShipping
  • ShowOrderLineNotes
  • AddToCartPopupTimeout

 

1000 GetPunchoutSettings If the current session is a punchout session, sets result ShowLineNotes to false.

HTTP Verb: GET

URL: /api/v1/settings

Description: Gets the customer settings.

Base: HandlerBase<GetCustomerSettingsParameter, GetCustomerSettingsResult>

Handlers:

Order Handler Description
500 GetCustomerSettings

Retrieves the following customer settings and stores them in the result object.

Storefront User Permissions

AllowBillToAddressEditAllowShipToAddressEditAllowCreateNewShipToAddress

Budgets and Order Approval Settings

BudgetsFromOnlineOnly

HTTP Verb: GET

URL: /api/v1/settings

Description: Returns all invoice settings.

Base: HandlerBase<GetInvoiceParameter, GetInvoiceSettingsResult>

Handlers:

Order Handler Description
500 GetInvoiceSettings Populate LookBackDays and ShowInvoices property on the result object.

HTTP Verb: GET

URL: /api/v1/settings

Description: Returns all order settings.

Base: HandlerBase<GetOrderParameter, GetOrderSettingsResult>

Handlers:

Order Handler Description
500 GetOrderSettings

Retrieves the following settings and stores them in the result object.

Order History Settings

AllowCancellationRequestRmaEnabledReorderEnabledShowPoNumberShowTermsCodeShowErpOrderNumberShowOrderStatusLookBackDays

Budgets and Order Approval Settings

ShowCostCode

Cart Settings

OrderUploadEnabled

Retrieves current user and user roles and populate AllowQuickOrder and ShowOrders properties in the result object.

 

HTTP Verb: GET

URL: /api/v1/settings or /api/v1/settings/product

Description: Returns all products settings.

Base: HandlerBase<GetSettingsParameter, GetProductSettingsResult>

Handlers:

Order Handler

Description

500 GetProductSettingsHandler

Gets the product settings values (ShowInventoryAvailability, ShowAddToCartConfirmationDialog, EnableProductComparisons, AlternateUnitsOfMeasure, ThirdPartyReviews, DefaultViewType).

Order Handler Description
500 GetProductSettings Properties are populated on the result object using settings. See additional information below.
600 GetRealTimeProductSettings If the pricing service is set to realtime, sets result object property RealTimePricing to true.
700 GetRealTimeInventorySettings If the inventory service is set to realtime, sets result RealTimeInventory to true.
Store IncludedWithPricing setting value as InventoryIncludedWithPricing result object property.
1000 GetPunchoutSettings If the current session is a punchout session and IPunchOutSessionUtilities.CanModifyOrder is false, sets result CanAddToCart to false.

Order 500 GetProductSettings Specifications

Result Property Description
AllowBackOrder Inventory "Allow Backorders" setting
ShowAddToCartConfirmationDialog Cart "Show Add To Cart Confirmation Popup" setting
EnableProductComparisons Product list "Product Comparisons" setting
DefaultViewType Product list "Default Product List View" setting
AlternateUnitsOfMeasure Inventory "Alternate Units of Measure" setting
LowStockQuantity Inventory "Low Stock Threshold" setting
ShowSavingsAmount Pricing "Show Savings Amount" setting
ShowSavingsPercent Pricing "Show Savings Percent" setting
PricingService Pricing "Pricing Service" setting
StorefrontAccess Security "Website Access" setting
ThirdPartyReviews Set to "None"
ShowInventoryAvailability Defaults to "false". This is set to "true" if the Inventory "Show Inventory Availability" setting equals "Always". If the Inventory "Show Inventory Availability" setting equals "Secure", this is set to "true" if:
  • The current user is authenticated OR
  • The Security "Storefront Access" setting does NOT equal "Sign In Required to Browse" or "Sign In Required to Add to Cart or See Prices"
CanSeeProducts Set to "true" if the "Storefront Access" setting is not equal to "Sign In Required to Browse"
CanSeePrices Set to "true" if the "Storefront Access" setting is not equal to "Sign In Required to Add to Cart or See Prices"
CanAddToCart Set to "true" if the "Storefront Access" setting is equal to "No Sign In Required"
CanShowPriceFilters Set to "true" if the "Show Price Filter" setting is set to "true" and the CanSeePrices property equals "true"

 

HTTP Verb: GET

URL: /api/v1/settings or /api/v1/settings/quote

Description: Returns web configuration settings for quotes

Base: HandlerBase<GetQuoteSettingsParameter, GetQuoteSettingsResult>

Handlers:

Order Handler Description
500 GetQuoteSettingsHandler Gets the website configuration settings for "JobQuoteEnabled" and "Rfq_QuoteExpireDays".
Order Handler Description
500 GetQuoteSettings Retrieves "Allow Job Quotes" and "Days to Quote Expiration" settings values and store it as JobQuoteEnabled and QuoteExpireDays properties in result object.

HTTP Verb: GET

URL: /api/v1/settings/search

Description: Gets the search settings.

Base: HandlerBase<GetSearchSettingsParameter, GetSearchSettingsResult>

Handlers:

Order Handler Description
500 GetSearchSettings

Sets next settings:

  • AutocompleteEnabled
  • SearchHistoryEnabled
  • SearchHistoryLimit

 

HTTP Verb: GET

URL: /api/v1/settings/wishlist

Description: Returns all wish list website configuration settings.

Base: HandlerBase<GetSettingsParameter, GetWishListSettingsResult>

Handlers:

Order Handler

Description

500 GetWishListSettingsHandler

Gets website configuration settings for "WishLists_ByCustomer" and "AllowMultipleWishlists"

Order Handler Description
500 GetWishListSettings Retrieves settings from WishlistsSettings. Note that AllowEditingOfWishLists is getting constant true value.
1000 GetPunchoutSettings

If the current session is a punchout session, sets result AllowEditingOfWishLists to false.

Do you find this information helpful? Please log in to provide feedback.

Last updated: Dec 11, 2020

Recommended reading