Globals

Type Definitions

jQuery

Description

Represents a jQuery object

Details

WizardModuleError

Properties

Name	Type	Description
`errorMessage`	String
`errorCode`	String

Promotion

Description

Refers to a promotion. The getPromotions() method returns an array of Promotion objects.

Properties

Name	Type	Attributes	Description
`internalid`	String	<optional>	The internal ID of the promotion in NetSuite.
`type`	String
`name`	String
`rate`	String
`code`	String
`errormsg`	String
`isvalid`	Boolean

AddLine

Description

Represents a line to be added to the cart.

Properties

Name	Type	Description
`line`	Line	The line to add to the cart. The value of line is a `Line` object.

AddLines

Description

Represents one or more lines to be added to the cart. It is used with the addLines method to add multuple lines to the cart.

Properties

Name	Type	Description
`lines`	Array.<Line>	The lines to add to the cart. `lines` is an array of `Line` objects.

Line

Description

A line in the cart.

Properties

Name Type Attributes Description

internalid String <optional>

quantity Number <optional>

amount Number <optional>

rate Number <optional>

tax_amount Number <optional>

tax_code String <optional>

itemtype String <optional>

item

Name	Type	Attributes
`internalid`	Number
`itemid`	String	<optional>
`displayname`	String	<optional>
`isinactive`	Boolean	<optional>
`itemtype`	String	<optional>
`minimumquantity`	Number	<optional>

options Array.<LineOption> <optional>

extras

Name	Type	Attributes	Description
`shipaddress`	String	<optional>	SCA specific
`shipmethod`	String	<optional>	SCA specific
`tax_rate`	Number	<optional>	SCA specific
`rate_formatted`	String	<optional>	SCA specific
`discount`	Number	<optional>	SCA specific
`total`	number	<optional>	SCA specific
`amount_formatted`	String	<optional>	SCA specific
`tax_amount_formatted`	String	<optional>	SCA specific
`discount_formatted`	String	<optional>	SCA specific
`total_formatted`	String	<optional>	SCA specific
`description`	String	<optional>	SCIS specific
`giftcertfrom`	String	<optional>	SCIS specific
`giftcertmessage`	String	<optional>	SCIS specific
`giftcertnumber`	Number	<optional>	SCIS specific
`giftcertrecipientemail`	String	<optional>	SCIS specific
`giftcertrecipientname`	String	<optional>	SCIS specific
`taxrate1`	String	<optional>	SCIS specific
`taxrate2`	String	<optional>	SCIS specific
`grossamt`	String	<optional>	SCIS specific
`tax1amt`	String	<optional>	SCIS specific
`custreferralcode`	String	<optional>	SCIS specific
`excludefromraterequest`	Boolean	<optional>	SCIS specific
`custcol_ns_pos_voidqty`	String	<optional>	SCIS specific
`voidPercentage`	Number	<optional>	SCIS specific
`returnedQuantity`	Number	<optional>	SCIS specific
`isUnvalidatedReturn`	Boolean	<optional>	SCIS specific
`order`	Boolean	<optional>	SCIS specific
`note`	String	<optional>	SCIS specific

LineOption

Description

This is the representation of the line's option in the Line type

Properties

Name	Type	Description
`cartOptionId`	String
`value`	Object	an object with a String property internalid

Summary

Description

This is the representation of the cart's summary returned by getSummary.

Properties

Name	Type	Attributes	Description
`total`	Number	<optional>
`taxtotal`	Number	<optional>
`tax2total`	Number	<optional>
`discounttotal`	Number	<optional>
`subtotal`	Number	<optional>
`shippingcost`	Number	<optional>
`handlingcost`	Number	<optional>
`giftcertapplied`	Number	<optional>
`discounttotal_formatted`	String	<optional>	SCA specific
`taxonshipping_formatted`	String	<optional>	SCA specific
`taxondiscount_formatted`	String	<optional>	SCA specific
`itemcount`	Number	<optional>	SCA specific
`taxonhandling_formatted`	String	<optional>	SCA specific
`discountedsubtotal`	Number	<optional>	SCA specific
`discountedsubtotal_formatted`	String	<optional>	SCA specific
`taxondiscount`	Number	<optional>	SCA specific
`handlingcost_formatted`	String	<optional>	SCA specific
`taxonshipping`	Number	<optional>	SCA specific
`taxtotal_formatted`	String	<optional>	SCA specific
`totalcombinedtaxes_formatted`	String	<optional>	SCA specific
`totalcombinedtaxes`	Number	<optional>	SCA specific
`giftcertapplied_formatted`	String	<optional>	SCA specific
`shippingcost_formatted`	String	<optional>	SCA specific
`discountrate`	Number	<optional>	SCA specific
`taxonhandling`	Number	<optional>	SCA specific
`tax2total_formatted`	String	<optional>	SCA specific
`discountrate_formatted`	String	<optional>	SCA specific
`estimatedshipping`	Number	<optional>	SCA specific
`estimatedshipping_formatted`	String	<optional>	SCA specific
`total_formatted`	String	<optional>	SCA specific
`subtotal_formatted`	String	<optional>	SCA specific
`shippingtax1rate`	String		SCIS specific
`shippingcostoverridden`	Boolean		SCIS specific
`amountdue`	Number		SCIS specific
`tranid`	String		SCIS specific
`createddate`	Date		SCIS specific
`couponcode`	String		SCIS specific
`createdfrom`	Date		SCIS specific
`changedue`	Number		SCIS specific

ConfirmationSubmit

Description

in SCA the object returned by getShoppingSession().getOrder().submit()

Address

Description

This is the representation an address

Properties

Name	Type	Description
`internalid`	String
`zip`	String
`country`	String
`addr1`	String
`addr2`	String
`addr3`	String
`city`	String
`company`	String
`defaultbilling`	Boolean
`defaultshipping`	Boolean
`fullname`	String
`isresidential`	Boolean
`isvalid`	Boolean
`phone`	String
`state`	String

ShipMethod

Description

A shipping method.

Properties

Name	Type	Description
`internalid`	String	The internal ID of the shipping item record in NetSuite.
`name`	String	The name of the shipping item.
`rate`	Number	The rate charged for this shipping method, for example, "10".
`rate_formatted`	String	The formatted rate charged for the shipping method, for example, "$10.00".
`shipcarrier`	String

PaymentMethod

Description

Refers to a payment method in NetSuite.

Properties

Name Type Description

internalid String

type

String

valid options: [creditcard, invoice, paypal, giftcertificate, external_checkout]

creditcard

CreditCard

Required only if it is a creditcard

Name	Type	Description
`ccnumber`	String	Required only if it is a creditcard
`ccname`	String	Required only if it is a creditcard
`ccexpiredate`	String	Required only if it is a creditcard
`expmonth`	String	Required only if it is a creditcard
`expyear`	String	Required only if it is a creditcard
`ccsecuritycode`	String	Required only if it is a creditcard
`paymentmethod.internalid`	String
`paymentmethod.name`	String
`paymentmethod.creditcard`	Boolean
`paymentmethod.ispaypal`	Boolean
`paymentmethod.key`	String

key String

thankyouurl String

errorurl String

giftcertificate.code

String

Required only if it is a giftcertificate

RemoveStepGroupData

Properties

Name	Type	Description
`group_name`	String

AddStepData

Properties

Name	Type	Description
`name`	String
`url`	String
`isActive`	function
`group_name`	String
`index`	Number

AddStepGroupData

Properties

Name	Type	Description
`name`	String
`url`	String
`index`	Number

AddModuleData

Properties

Name	Type	Description
`step_url`	String
`module`	ModuleData

ModuleData

Properties

Name	Type	Description
`id`	String
`index`	Number
`classname`	String	the JavaScript class name of the new module to add
`options`	ModuleOptions

ModuleOptions

Properties

Name	Type	Description
`container`	String	where to add the new module, for example, '#wizard-step-content-right'

RemoveModuleData

Properties

Name	Type	Description
`step_url`	String
`module_id`	String

CheckoutStepGroup

Properties

Name	Type	Description
`index`	Number
`name`	String
`url`	String
`show_group`	Boolean
`state`	String
`steps`	Array.<CheckoutStep>

CheckoutStep

Properties

Name	Type	Description
`url`	String	It is the step identifier
`name`	String
`show_step`	Boolean
`state`	String
`step_group_name`	String
`modules`	Array.<CheckoutStepModule>

CheckoutStepModule

Properties

Name	Type	Description
`id`	String
`is_active`	Boolean
`is_ready`	Boolean
`index`	Number

RegisterCustomContentType

Properties

Name	Type	Description
`id`	String	The ID of the CCT to be registered. IDs must be unique per account/domain.
`customcontenttypebaseview`	CustomContentTypeBaseView	View class that implements the CCT.

TranslationEntry

Description

Represents an entry in the translation dictionary.

Properties

Name	Type	Description
`key`	String	The key of the translation.
`value`	String	The translation string.

Session

Properties

Name	Type	Description
`currency`	SessionCurrency
`language`	SessionLanguage
`touchpoints`	SessionTouchpoints
`priceLevel`	String

SessionCurrency

Properties

Name	Type	Description
`internalid`	String
`symbol`	String
`code`	String
`name`	String
`currencyname`	String
`isdefault`	String
`symbolplacement`	Number

SessionLanguage

Properties

Name	Type	Description
`name`	String
`isdefault`	String
`locale`	String
`languagename`	String

SessionTouchpoints

Properties

Name	Type	Description
`logout`	String
`customercenter`	String
`serversync`	String
`viewcart`	String
`login`	String
`welcome`	String
`checkout`	String
`continueshopping`	String
`home`	String
`register`	String
`storelocator`	String

MyAccountMenuGroup

Description

Represents a menu group in the menu on the My Account page.

Properties

Name	Type	Description
`name`	String	The name of the menu group as it appears in the menu.
`id`	String	A unique ID for the menu group.
`index`	Integer	A number that indicates the position of the menu group in the menu.
`permission`	Array.<MyAccountMenuPermission>	An array of permissions to apply to the menu group. Each permission is an object in the array. If the user has the relevant permissions, the menu group is displayed.
`permissionoperator`	String	Specifies how permissions are evaluated. To indicate that the user must have all the specified permissions, set this property to `AND`. Otherwise, to indicate that any one of the permissions are required, set this property to `OR`.

MyAccountMenuGroupEntry

Description

Represents a menu item in the menu on the My Account page.

Properties

Name	Type	Description
`id`	String	A unique ID for the menu item.
`groupid`	String	The ID of the menu group to which you want to add the menu item.
`index`	String	A number that indicates the position of the menu item in the menu group.
`name`	String	The name of the menu item as it appears in the menu.
`permission`	Array.<MyAccountMenuPermission>	The permissions required to view the menu item and its associated landing page. Specify the permissions as an array of permissions to apply to the menu item. Each permission in the array is an object. If the user has the relevant permissions, the menu item is displayed.
`permissionoperator`	String	Specifies how permissions are evaluated. To indicate that the user must have all the specified permissions, set this property to `AND`. Otherwise, to indicate that any one of the permissions are required, set this property to `OR`.
`url`	String	The URL of a landing page you want to display on the My Account page.

MyAccountMenuPermission

Description

A permission that can be applied to a menu group or menu item.

Properties

Name	Type	Description
`id`	String	The permission ID that can be applied to a menu group or menu item (menu group entry).
`group`	String	Permissions available for SuiteCommerce extensions are organised into two groups: `transactions` and `lists`. See SuiteCommerce Advanced & Reference Implementations for more information about working with permissions.
`level`	String	The permission level for the menu group or menu item. `level` can be one of the following: 0 - None 1 - View 2 - Create 3 - Edit 4 - Full

PageType

Description

A page type to register.

Properties

Name	Type	Description
`name`	String	The name of the page type. `name` must the same as the name of the CMS page type record in NetSuite, or the name of the page type as specified in the extension manifest.
`view`	PageTypeBaseView	A constructor function that creates an instance of a PageTypeBaseView view class.
`defaultTemplate`	Object	Specifies the defaut page template to use for the page type. `defaultTemplate` is an object with the following properties: name - The template file name. displayName - The name of the page template as it will appear in the list of available layouts in Site Management Tools (SMT) in NetSuite. thumbnail - The absolute URL of an image file.

PageTemplate

Description

A page template to register with one or more page types.

Properties

Name	Type	Description
`PageTypes`	Array	The page types to register the template with.
`template`	Object	Specifies the template to register. `template` is an object with the following properties: name - The template file name. displayName - The name of the page template as it will appear in the list of available layouts in Site Management Tools (SMT) in NetSuite. thumbnail - The absolute URL of an image file.

ItemInfo

Description

Representation of the data objects used to send a transaction line representation to the back-end without sending all the heavy weight JSON that is not totally needed by the back-end

Properties

Name Type Attributes Description

internalid String

quantity Number <optional>

options Array.<Object> <optional>

splitquantity Number <optional>

shipaddress Number <optional>

shipmethod Number <optional>

location Number <optional>

fulfillmentChoice String <optional>

item

Name	Type	Attributes
`internalid`	String	<optional>
`type`	String	<optional>
`onlinecustomerprice_detail`	String	<optional>

MatrixOptionSelection

Properties

Name	Type	Description
`custom_item_option`	String
`custom_item_option_value`	String \| Number

Breadcrumb

Properties

Name	Type	Description
`href`	String
`text`	String

Image

Properties

Name	Type	Description
`altimagetext`	String
`url`	String

StorePickUpDetail

Properties

Name	Type	Description
`internalid`	Number
`qtyavailableforstorepickup`	Number

Filter

Properties

Name Type Description

id String

url String

value String

active Boolean

config

Object

Name	Type	Description
`id`	String
`name`	String
`url`	String
`behavior`	String
`max`	Number
`titleToken`	String

PageSize

Properties

Name	Type	Description
`items`	Number
`name`	String
`isDefault`	Boolean
`id`	String
`active`	Boolean

Display

Properties

Name	Type	Description
`id`	String
`name`	String
`template`	String
`columns`	Number
`icon`	String
`isDefault`	Boolean
`active`	Boolean

Sorting

Properties

Name	Type	Attributes
`id`	String
`name`	String
`isDefault`	Boolean
`active`	Boolean	<optional>

Pagination

Properties

Name	Type	Description
`currentPage`	Number
`pageCount`	Number
`itemCount`	Number
`pageSize`	Number
`sorting`	String
`display`	String
`filters`	Object
`searchText`	String

SearchItemInfo

Properties

Name	Type	Attributes
`isinstock`	Boolean	<optional>
`onlinecustomerprice`	Number	<optional>
`matrixchilditems_detail`	Array.<matrixchilditems_detail>	<optional>
`itemid`	String	<optional>
`ispurchasable`	Boolean	<optional>
`onlinecustomerprice_formatted`	String	<optional>
`stockdescription`	String	<optional>
`isbackorderable`	Boolean	<optional>
`itemimages_detail`	Object	<optional>
`onlinecustomerprice_detail`	onlinecustomerprice_detail	<optional>
`custitem_automation_item_field_001`	String	<optional>
`onlinematrixpricerange`	String	<optional>
`internalid`	Number	<optional>
`showoutofstockmessage`	Boolean	<optional>
`outofstockbehavior`	String	<optional>
`custitem_automation_item_field_002`	String	<optional>
`itemoptions_detail`	itemoptions_detail	<optional>
`outofstockmessage`	String	<optional>
`displayname`	String	<optional>
`storedisplayname2`	String	<optional>
`storedescription`	String	<optional>
`urlcomponent`	String	<optional>
`options`	Array.<SearchItemInfo_options>	<optional>

matrixchilditems_detail

Properties

Name	Type	Attributes
`isinstock`	Boolean	<optional>
`itemid`	String	<optional>
`ispurchasable`	Boolean	<optional>
`stockdescription`	String	<optional>
`isbackorderable`	Boolean	<optional>
`onlinecustomerprice_detail`	onlinecustomerprice_detail	<optional>
`internalid`	Number	<optional>
`showoutofstockmessage`	Boolean	<optional>
`outofstockbehavior`	String	<optional>
`itemtype`	String	<optional>
`outofstockmessage`	String	<optional>

onlinecustomerprice_detail

Properties

Name	Type	Attributes	Description
`onlinecustomerprice_formatted`	String	<optional>
`onlinecustomerprice`	Number	<optional>

itemimages_detail

Properties

Name	Type	Attributes	Description
`urls`	Array.<itemimages_detail_urls>	<optional>

itemimages_detail_urls

Properties

Name	Type	Attributes	Description
`altimagetext`	String	<optional>
`url`	String	<optional>

itemoptions_detail

Properties

Name	Type	Description
`matrixtype`	String
`fields`	Array.<itemoptions_detail_fields>

itemoptions_detail_fields

Properties

Name	Type	Attributes
`ismandatory`	Boolean	<optional>
`internalid`	String	<optional>
`ismatrixdimension`	Boolean	<optional>
`values`	Array.<itemoptions_detail_fields_values>	<optional>
`label`	String	<optional>
`type`	String	<optional>
`sourcefrom`	String	<optional>

itemoptions_detail_fields_values

Properties

Name	Type	Attributes
`label`	String	<optional>
`isAvailable`	Boolean	<optional>
`url`	String	<optional>

SearchItemInfo_options

Properties

Name	Type	Description
`label`	String
`values`	Array.<SearchItemInfo_options_values>
`type`	String
`cartOptionId`	String
`itemOptionId`	String
`isMatrixDimension`	Boolean
`isMandatory`	Boolean
`urlParameterName`	String
`useLabelsOnUrl`	Boolean
`index`	Number

SearchItemInfo_options_values

Description

instance

Properties

Name	Type	Description
`label`	String
`isAvailable`	Boolean
`url`	String

UserProfile

Description

Contains a predefined set of properties with information about the logged in user. If the user is not logged in, it contains a smaller set of properties.

Properties

Name	Type	Description
`addresses`	Array.<Address>	An array of addresses. Each address corresponds to an active address on the customer record.
`balance`	Float	Refers to the customer's current accounts receivable balance.
`campaignsubscriptions`	Array.<CampaignSubscription>	The marketing subscriptions to which the user is subscribed.
`companyname`	String	The customer's company name. If the customer type is 'INDIVIDUAL', the company name is blank.
`creditholdoverride`	Boolean	Returns `true` if the user's credit hold was removed manually.
`creditlimit`	Number	The maximum currency amount the customer is allowed to accrue in outstanding receivables.
`customfields`	Array.<CustomEntityField>	An array of all custom fields and their values. All web store custom fields are in the array, regardless of whether they contain a value.
`email`	String	The customer's primary email address.
`emailsubscribe`	Boolean	Indicates whether the user has subscribed to at least one marketing subscription.
`firstname`	String	The customer's first name.
`internalid`	String	The internal identifier of the customer record in NetSuite.
`isguest`	Boolean	Indicates if the visitor is a guest user.
`isloggedin`	Boolean	Indicates if the visitor is a logged in user.
`isrecognized`	Boolean	Indicates whether the visitor is a recognized user.
`language`	String	The customer's preferred language.
`lastname`	String	The customer's surname.
`middlename`	String	The customer's middlename.
`name`	String	Corresponds to the Customer ID field on the customer record in NetSuite.
`paymentterms`	PaymentTerm	The payment terms assigned to the customer.
`phoneinfo`	PhoneInfo	Lists the customer's phone and fax numbers.
`pricelevel`	String	The price level assigned to the customer.
`subsidiary`	String	The subsidiary associated with the customer record.
`type`	String	Indicates the type of customer. If the user is a person, the value of `type` is 'INDIVIDUAL'. Otherwise, the value of `type` is 'COMPANY'.

PaymentTerm

Description

The payment terms assigned to the customer.

Properties

Name	Type	Description
`internalid`	String	The internal ID of the (payment) term record.
`name`	String	The name of the payment terms, for example, "Net 30 Days".

PhoneInfo

Description

Contains the customer's phone information.

Properties

Name	Type	Description
`alphone`	String	The customer's alternative phone number.
`fax`	String	The customer's fax number.
`phone`	String	The customer's main phone number.

CustomEntityField

Description

Refers to a custom field on the customer record.

Properties

Name	Type	Description
`id`	String	The identifier of the field in NetSuite. Identifiers always start with the string "custentity". For example, a custom phone number field might have the id "custentity_phonenumber", where "_phonenumber" is the field name entered by the NetSuite user when creating the custom field.
`value`	String	The value of the field.

CampaignSubscription

Description

A marketing subscription to which the user is subscribed.

Properties

Name	Type	Description
`internalid`	String	The identifier of the subscription in NetSuite.
`name`	String	The name of the subscription.
`description`	String	The description of the campaign subscription.

SimpleChildViewConstructor( ...any ) → {View}

Parameters

Name	Type	Attributes	Description
`any`	any	<repeatable>