sitesettings

This topic applies to

Applies to

SuiteCommerce Web Stores

Field Name

Field Type

Description

In Get Functions?

In Set Functions?

analytics

JSON analyticssettings object

Analytics settings

yes

no

checkout

JSON checkoutsettings object

Checkout settings

yes

no

cookiepolicy

string

Returns the URL for the cookie policy file in the NetSuite file cabinet.

yes

no

currencies

Array of JSON objects with fields (internalid, name, isdefault, symbolplacement)

Ordered list of currencies supported by the site

isdefault field is a Boolean, with a value of T for default currency, F for others.

symbolplacement uses the constants: SYMBOL_BEFORE_NUMBER = 1 and SYMBOL_AFTER_NUMBER = 2

yes

no

defaultshipcountry

string

Default ship to country

yes

no

defaultshippingmethod

string

Default shipping method

yes

no

displayname

string

Site name

yes

no

imagesizes

Array of JSON objects with image resize definitions (resizeid, resizeh, resizew)

Each object has the following properties:

  • maxwidth–maximum resized image width in pixels

  • maxheight–maximum resized image height in pixels

  • urlsuffix–suffix that should be added to the image URL to return a resized image

  • internalid–internal system ID of image resize definition.

  • name–value from the Image Resize ID field (image resize definition) as entered on the Web Site Setup page.

yes

yes

iswebstoreoffline

boolean

Retruns T or F depending on whether the web store is online or offline.

yes

no

iswsdk

boolean

Returns T or F depending on the settings of the WSDK checkbox on the site record (tab setup) and the WSDK feature settings for a site.

yes

no

languages

Array of JSON objects with fields (internalid, name, isdefault)

Ordered list of languages for the site

isdefault field is a Boolean, with a value of T for default language, F for others

yes

no

loginallowed

string

Indicates whether login is allowed

Value should be T or F.

yes

no

loginrequired

string

Indicates whether login is required to access the site

Value should be T or F.

yes

no

order

JSON ordersettings object

Order settings

yes

no

paymentmethods

array of paymentmethod objects

Payment methods

yes

no

pricesincludevat

string

Indicates whether prices include VAT

Value should be T or F.

yes

no

registration

JSON registrationsettings object

Registration settings

yes

no

requireloginforpricing

string

Indicates whether login is required to display item prices

Value should be T or F.

yes

no

requireshippinginformation

boolean

Indicates whether shipping information needs to be collected

Value should be T or F.

yes

no

shipallcountries

string

Indicates whether shipping is supported to all countries

Value should be T or F.

yes

no

shippingrequired

string

Indicates whether shipping is required for the site

Value should be T or F.

yes

no

shiptocountries

Array of strings

Countries where shipping is supported

yes

no

showextendedcart

string

Indicates whether extended cart should be displayed

Value should be T or F.

yes

no

showshippingestimator

string

Indicates whether shipping estimator should be displayed

Value should be T or F.

yes

no

sitetype

string

Indicates the type of web site.

Value should be ADVANCED or STANDARD.

ADVANCED indicates the site is a SuiteCommerce Advanced site where STANDARD indicates it is a Standard web site built with the NetSuite Site Builder.

yes

no

subsidiaries

Array of JSON objects with fields (internalid, name, isdefault)

Ordered list of subsidiaries for the site

isdefault field is a Boolean, with a value of T for default subsidiary, F for others

yes

wsdkcancelcarturl

string

For use with an External Catalog Site (WSDK). Returns the Cancel Cart URL.

yes

no

wsdkcancelcheckouturl

string

For use with an External Catalog Site (WSDK). Returns the Cancel Checkout URL.

yes

no

wsdkcancelloginurl

string

For use with an External Catalog Site (WSDK). Returns the Cancel Login URL.

yes

no

wsdkcompletecheckouturl

string

For use with an External Catalog Site (WSDK). Returns the Complete Checkout URL.

yes

no

wsdkcompleteloginurl

string

For use with an External Catalog Site (WSDK). Returns the Complete Login URL.

yes

no