1. Home
  2. Classes
  3. Cart

new Cart()

Description

The Cart component provides ways to work with the cart, for example, adding lines, getting the cart summary, and applying promotions. It also exposes before and after events for several methods. For example, the beforeAddLine and afterAddLine events let you add event listeners before lines are added to the cart, and after lines are added to the cart respectively.

Get an instance of this component by calling container.getComponent("Cart").

Members

componentName :String

Description

A unique name that identifies the component. Use the component name when getting a component, for example, application.getComponent(componentName).

Details
String

BaseComponent#componentName

VisualComponent#componentName

application :ComponentContainer

Description

The name which identify this kind of component. This name is used both for registering a new component and
getting a component implementation with ComponentContainer

Details
ComponentContainer

BaseComponent#application

VisualComponent#application

CART_VIEW :String

Description

Name of the cart main view. Use this name to reference views in methods such as addChildView() and addToViewContextDefinition().

CART_MINI_VIEW :String

Description

Name of the mini-cart main view. Use this name to reference views in methods such as addChildView() and addToViewContextDefinition().

WIZARD_VIEW :String

Methods

cancelableOn( event_name, handler ) → {void}

Description

Attaches an event handler to an event.

Parameters
Name Type Description
event_name String

The name of the event to which the event handler will be attached.
handler function

The event handler method that will be invoked when event_name is triggered. This function can receive optionally one parameter representing the action parameter. Besides optionally can return a Deferred to details the execution of the trigger's callback. If the returned Deferred is rejected the trigger's callback wont be called
Returns
Details

CancelableEvents#cancelableOn

VisualComponent#cancelableOn

cancelableOff( event_name, handler ) → {void}

Description

Detaches an event handler from an event.

Parameters
Name Type Description
event_name String

The name of the event from which to detach the event handler. This argument is required.
handler function

The event handler that will be removed from the list of handlers attached to the event. This argument is required.
Returns
Details

CancelableEvents#cancelableOff

VisualComponent#cancelableOff

extend( componentDefinition ) → {BaseComponent}

Description

Extends the current component and creates a child component.

Parameters
Name Type Description
componentDefinition Object

An object with the appropriate properties and methods to create the component.
Returns
Details

BaseComponent#extend

VisualComponent#extend

cancelableDisable( event_name ) → {void}

Description

Disables all the event handlers attached to an event.

Parameters
Name Type Description
event_name String

The name of the event.
Returns
Details

CancelableEvents#cancelableDisable

VisualComponent#cancelableDisable

on( event_name, handler ) → {void}

Description

Attaches an event handler to an event name. Alias for CancelableEvents#cancelableOn.

Parameters
Name Type Description
event_name String

The name of the event to attach to
handler function
Returns
Details

BaseComponent#on

VisualComponent#on

cancelableEnable( event_name ) → {Void}

Description

Re-enables all the event handlers attached to an event.

Parameters
Name Type Description
event_name String

The name of the event.
Returns
Details

CancelableEvents#cancelableEnable

VisualComponent#cancelableEnable

off( event_name, handler ) → {void}

Description

Detaches an event handler from an event name. Alias for CancelableEvents#cancelableOff.

Parameters
Name Type Description
event_name String

The name of the event from which to detach the event handler.
handler function
Returns
Details

BaseComponent#off

VisualComponent#off

cancelableTrigger( event_name, ...args ) → {Deferred}

Description

Triggers an event with a set of arguments. If an event handler is rejected, the event handler callbacks will not be executed.

Parameters
Name Type Attributes Description
event_name String

The name of the event to trigger.
args params <repeatable>

One or more arguments that will be broadcast to all event handlers attached to the event.
Returns

Returns a Deferred object. Because event handlers are sometimes asynchronous, any callbacks in the event handlers will also be asynchronous.

Details

CancelableEvents#cancelableTrigger

VisualComponent#cancelableTrigger

cancelableTriggerUnsafe( event_name, ...args ) → {Deferred}

Description

Triggers an event with a set of unsanitized arguments. If an event handler is rejected, the event handler callbacks will not be executed.

Parameters
Name Type Attributes Description
event_name String

The name of the event to trigger.
args params <repeatable>

One or more arguments that will be broadcast to all event handlers attached to the event.
Returns

Returns a Deferred object. Because event handlers are sometimes asynchronous, any callbacks in the event handlers will also be asynchronous.

Details

CancelableEvents#cancelableTriggerUnsafe

VisualComponent#cancelableTriggerUnsafe

closeMessage( messageId )

Description

Lets you close a message on the page. To close a message, you must have the ID of the message, as returned by showMessage() when the message was first shown.

		var layout = container.getComponent('Layout');
			var message_vat_no;
			
			if (layout) {
				
				// Check if a VAT number was entered. If not, display a message.
				if ($('#vat_no').val() == '') {
					message_vat_no = layout.showMessage({message: 'You must enter a VAT number to register as a business customer.', type: 'error'});
				}
			}
			
			// Clear the VAT number error message when the VAT number field gets focus.
			$('#vat_no').focus(function() {
				layout.closeMessage(message_vat_no);
			});
Parameters
Name Type Description
messageId string

The ID of the message to close. Get the ID of a message by assigning the return value of showMessage() to a variable.
Details

VisualComponent#closeMessage

VisualComponent#closeMessage

addLine( line ) → {Deferred}

Description

Adds a line (item) to the cart. This method takes an object as its argument, which has a single property called line. The value of line is a Line object. Line has properties to specify the item and item quantity to add to the cart. You must know the internal ID of an item to add it to the cart.

If the item is already in the cart, the quantity of the line is increased by the value of the quantity property.

			var cart = container.getComponent('Cart');
			cart.addLine({
				line: {
					quantity: 1, 
					item: {
						internalid: 8058
					}
				}
			}).then(function() {
				alert(Utils.translate('Item added.'))
			});
Parameters
Name Type Description
line AddLineData

The item to add to the cart. line is an AddLineData object.
Returns

Returns a Deferred object. If the promise is resolved, the line is added to the cart.

modifyViewJsonLd( view_id, callback ) → {void}

Description

Lets you modify JSON-LD data embedded in the <head> element of a SuiteCommerce product details page. JSON-LD data on SuiteCommerce websites adheres to the structured data schemas, as specified on https://schema.org/Product.

If your extension modifies a view or adds a child view on the product details page, you can use modifyViewJsonLd() to update the related JSON-LD. For example, if you add a child view that displays additional product information, you can update the JSON-LD to ensure the page and its metadata are consistent.

In general, the embedded JSON-LD data should be consistent with the content in the view. SuiteCommerce creates JSON-LD data when a view is rendered. For this reason, you need to pass in a view ID to modifyViewJsonLd() when modifying JSON-LD data.

Note: To use this method, JSON-LD must be selected as the markup type on the SuiteCommerce Configuration page in the NetSuite account. See Structured Data Markup in the NetSuite Help Center for more information.

In the following example, we create an instance of the Layout component and use modifyViewJsonLd() to add a property to the JSON-LD object. We pass in 'ProductDetails.Full.View' as the view ID and a function that returns a Promise. The _.extend function enables you to copy an object and add new properties to it.

			var layout = container.getComponent('Layout');
			
			layout.modifyViewJsonLd('ProductDetails.Full.View', function(json) {
				json = _.extend(json, {
					manufacturer: 'NetSuite Industrial'	
				});
				return jQuery.Deferred().resolve(json);
			});
Parameters
Name Type Description
view_id string

The identifier of the view that will update the JSON-LD data. For example, if you use the Layout component to modify the ProductDetails.Full.View view in the base theme template, pass in "ProductDetails.Full.View" as the view_id.
callback function

A function that modifies the JSON-LD data. It must return a Promise that resolves with an object.
Returns

Returns null if the operation is successful. Otherwise, it returns an Error. For example, an error is returned if JSON-LD is not selected as the structured markup type on the Configuration page.

Throws
Details

SuiteCommerce 2020.1

VisualComponent#modifyViewJsonLd

VisualComponent#modifyViewJsonLd

addLines( lines ) → {Deferred}

Description

Adds multiple lines to the cart. This method takes a single object as its argument with one property called lines. The value of lines is an array of Line objects.

			var cart = container.getComponent("Cart");
			cart.addLines({
					lines: [
						{
							quantity: 1,
							item: {
								internalid: 4938
							}
						},
						{
							quantity: 1,
							item: {
								internalid: 4936
							}
						}
					]
			});
Parameters
Name Type Description
lines AddLines

The items to add to the cart. lines is an AddLines object that contains an array of AddLineData objects, each of which represents a line to add to the cart.
Returns

Returns a Deferred object. If the promise is resolved, the lines are added to the cart.

setChildViewIndex( view_id, placeholder_selector, view_name, index ) → {void}

Description

Changes the position of a child view inside a container.

Parameters
Name Type Description
view_id string

The identifier of the view of the current component that contains the child view whose position will be changed.
placeholder_selector string

The identifier of a location in the specified view (view_id) where the child view will be added.
view_name string

The identifier of a view in the placeholder.
index number

The index of the child view's position.
Returns

Returns null if the operation is successful. Otherwise, it throws an exception.

Throws
Details

VisualComponent#setChildViewIndex

VisualComponent#setChildViewIndex

addPayment( data )

Description

Adds a payment method.

			var cart = container.getComponent("Cart");
			cart.addPayment({
				payment_method: {
					internalid: 3
				}
			});
Parameters
Name Type Description
data PaymentMethod

The payment method to add to the transaction. data is a PaymentMethod object, which contains a single property called payment_method. The value of payment_method is an object that contains payment method data such as the internal ID of the payment method in NetSuite, and credit card details if the payment method type is a credit card.

addPromotion( data ) → {Deferred}

Description

Applies a promotion to the cart. If the promotion code is valid and successfully applied to the order, the promotion appears in the cart automatically and the order total is updated.

			var cart = container.getComponent("Cart");
			
			if (cart) {
				cart.addPromotion({promocode: "5OFF"}).then(function(promotion) {
					console.log("Promotion added.");
					console.log(promotion);
				}, function() {
					console.log("Could not add promotion.");
				});
			}
Parameters
Name Type Description
data Object

The promotion code (promocode) of the promotion. data is an object with one property promocode. The value of promocode is the coupon code on the promotion record in NetSuite.
Returns

Returns a Deferred object. If the promise resolved, it returns a Promise object. If the promise is rejected (because the promotion could not be applied), it returns an error message object in JSON format.

clearEstimateShipping()

Description

Clears the shipping estimation from the order.

showMessage( data ) → {string}

Description

Shows a message in the notifications area of a SuiteCommerce page. The message is displayed by default in the Notifications placeholder (a DIV element in the base theme template with the custom data attribute data-view="Notifications"). You can also choose to display the message in any other placeholder that uses either of the following custom data attributes: data-view or data-cms-area.

Messages can be closed by the user, by setting a timeout in the method, or with the closeMessage() method. If you want to use closeMessage(), first assign the return value of showMessage() to a variable, and then pass the variable to closeMessage().

In the following example, the message is shown and then closed after 5 seconds by setting a timeout.

		var layout = container.getComponent('Layout');
			
			if (layout) {
				var message_shown = false;
				layout.on('afterShowContent', function() {
					
					if (message_shown != false) {
						layout.showMessage({
							message: '',
							type: 'info',
							selector: 'Notifications',
							timeout: 5000
						});
						message_shown = true;
					}
				});
			}

In the following example, a message is shown if an invalid VAT number is entered. When the user enters a valid number, the message is closed.

		var layout = container.getComponent('Layout');
			var message_vat_no;
			
			$('#vat_number').blur(function() {
				var vat_number = $(this).val();
			
				if (message_vat_no !== undefined) {
					layout.closeMessage(message_vat_no);
				}
			
				// checkVatNumber() returns false if the number entered is invalid.
				if (!checkVatNumber(vat_number)) {
					message_vat_no = layout.showMessage({
						message: 'You must enter a VAT number to register as a business customer.', 
						type: 'error'
					});
				}
			});
Parameters
Name Type Description
data Object

Data required to display the message. data is an object, which can have the following properties:

  • message - Required. The text of the message.
  • type - Required. The type of message. It also determines the appearance of the message on the page. Type can be one of the following: info, warning, error, or success.
  • selector - A placeholder on the page where you want the message to appear.
  • timeout - Specifies the duration in milliseconds of the message on the page. If you do not specify a timeout, you can use closeMessage() to remove the message.
Returns

Returns the message ID as a string.

Details

SuiteCommerce 2019.2

VisualComponent#showMessage

VisualComponent#showMessage

estimateShipping( data ) → {Deferred}

Description

Gets the estimated shipping costs for a particular country and postal code combination. This method accepts an object as its argument. After you call this method, the order summary of the cart is updated with the postal code and the currency amount of the shipping estimate.

			var cart = container.getComponent("Cart");
			cart.estimateShipping({
				address: {
					zip: "10065",
					country: "US"
				}
			});
Parameters
Name Type Description
data Object

The postcode and country to use to estimate shipping. data is an object with a single property address. The value of address is an object with two properties: zip and country.
Returns

Returns a Deferred object. The promise returns an object with two properties: address and result. address contains properties related to the shipping address, including the country and postal code. result contains properties related to shipping and handling costs, discount totals, and transaction totals.

addChildViews( view_id, child_views ) → {void}

Description

Adds one or more child views to an existing view. The existing view must already be in the DOM and must have the 'data-view' HTML attribute.

The addChildViews method is flexible, but more complex than addChildView. Use the simpler addChildView() where possible.

checkout.addChildViews(
			    checkout.WIZARD_VIEW
			    , {
			        'Wizard.StepNavigation':
			        {
			            'CheckoutView':
			            {
			                childViewIndex: 1
			            ,   childViewConstructor: function ()
			                {
			                    return new CheckoutExtensionView({checkout:checkout});
			                }
			            }
			        }
			    }
			);
Parameters
Name Type Description
view_id string

The identifier of the view of the current component to which the child views will be added.
child_views object
Returns

Returns null if the operation is successful. Otherwise, it throws an exception.

Throws
Details

VisualComponent#addChildViews

VisualComponent#addChildViews

getBillAddress() → {Deferred}

Description

Gets the billing address of the order. 

			var cart = container.getComponent("Cart");
			cart.getBillAddress().then(function(billaddress) {
				if (billaddress.isresidential == "T") {
					// Do work related to Sunday shipments for residential addresses.
					// ...
				}
			});
Returns

Returns a Deferred object. If the promise is resolved, it returns an Address. If the promise is rejected, it returns an error.

getLines() → {Deferred.<Array.<Line>>}

Description

Gets the lines in the cart.

var cart = container.getComponent("Cart");
			cart.getLines().then(function(lines) {
			
					if (lines.length > 100) {
						throw new Error("You are ordering a lot of stuff. For high-volume orders, contact our sales team on 555-123-1234.");
					}
			});
Returns

Returns a Deferred object. If the promise is resolved, it returns the lines in the cart (an array of Line objects). Otherwise, the promise returns the rejected state.

addChildView( data_view, view_constructor ) → {Void}

Description

Adds a child view to a view that already exists in the DOM. Child views can be added to elements that have the data-view or data-cms-area data attribute. If there are multiple elements in a template that have a data-view attribute value of view_id, the child view is added to all elements with that ID. Elements with the data-view attribute act as placeholders in the application. If there is content in the view (which is typically the case), the child view replaces the current content.

If you want to add multiple views at the same time, or if you want to add a child view while preserving the current content in the existing view, use addChildViews.

			layout.addChildView('Header.View', function () {
			  return new HolidayBannerView({});
			});

In the above example, the view HolidayBannerView will be added as a child view of an element in any template that has a data-view attribute of Header.View.

			layout.addChildView('cms:header_banner_top', function () {
			  return new HolidayBannerView({});
			});

In the above example, a child view is added to a predefined SMT area called 'header_banner_top'. In the template, the header_banner_top SMT area might be in a div tag in the following way: <div data-cms-area="header_banner_top"></div>. Because header_banner_top is a predefined SMT area, the cms: prefix is used before the view_id argument.

Parameters
Name Type Description
data_view String

The view to which the child view will be added. data_view is the value of the 'data-view' or 'data-cms-area' data attributes of an element on the page. For example, the header logo view uses the following data-view data attribute: <div data-view="Header.Logo">.
view_constructor SimpleChildViewConstructor

An instance of a view. Use a constructor function to get an instance of a view.
Returns

Returns null if the operation is successful. Otherwise, it throws an exception.

Throws
Details

VisualComponent#addChildView

VisualComponent#addChildView

removeChildView( view_id, placeholder_selector [, view_name ] ) → {void}

Description

Removes a child view from a view.

Parameters
Name Type Attributes Description
view_id string

The identifier of the view of the current component from which the child view will be removed.
placeholder_selector string

The identifier of the location in the specified view (view_id) from which the child view will be removed.
view_name string <optional>

The identifier of the view to be removed.
Returns

Returns null if the operation is successful. Otherwise, it throws an exception.

Throws
Details

VisualComponent#removeChildView

VisualComponent#removeChildView

addToViewContextDefinition( view_id, property_name, type, callback ) → {void}

Description

Adds a property to the UI context of a view to extend interaction with its template.

Parameters
Name Type Description
view_id string

The identifier of the view of the current component to which the context property will be added.
property_name string

The name of the property.
type string

The type of the property. The value returned by the callback function must be of the same type.
callback function

A function that sets the value of the property (property_name).
Returns

Returns null if the operation is successful. Otherwise, it throws an exception.

Throws
Details

VisualComponent#addToViewContextDefinition

VisualComponent#addToViewContextDefinition

getPaymentMethods() → {Deferred}

Description

Gets the currently selected payment method on the order.

			var cart = container.getComponent('Cart');
			cart.getPaymentMethods().then(function(paymentmethods) {
				var paymentmethodtype = paymentmethods[0].type;
				var paymentmethodexpiry = paymentmethods[0].creditcard.expyear;
			
				if (paymentmethodexpiry == todayyear) {
					// Do work related to payment method expiry date
					// ...
				}
			});
			
			// Example of the object returned by this method:
			{
				"extras": {...},
				"type": "creditcard",
				"creditcard": {
				"ccexpiredate": "11/1/2022",
				"ccname": "John Smith",
				"ccnumber": "************2780",
				"expmonth": "11",
				"expyear": "2022",
				"extras": {...},  
				"paymentmethod": {...}
			}
Returns

Returns a Deferred object. If the promise is resolved, it returns an array of PaymentMethod objects. If the promise is rejected, it returns an error.

removeToViewContextDefinition( view_id, property_name ) → {void}

Description

Removes a property from the UI context of a view.

Parameters
Name Type Description
view_id string

The identifier of the view of the current component from which the context property will be removed.
property_name string

The name of the property.
Returns

Returns null if the operation is successful. Otherwise, it throws an exception.

Throws
Details

VisualComponent#removeToViewContextDefinition

VisualComponent#removeToViewContextDefinition

addToViewEventsDefinition( view_id, event_selector, callback ) → {void}

Description

Adds an event handler to an event in a view.

Parameters
Name Type Description
view_id string

The identifier of the view of the current component to which the event handler will be added.
event_selector string
callback function

The event handler function to call when the specified event occurs.
Returns

Returns null if the operation is successful. Otherwise, it throws an exception.

Throws
Details

VisualComponent#addToViewEventsDefinition

VisualComponent#addToViewEventsDefinition

getPromotions() → {Deferred}

Description

Gets the promotions in the cart.

			var cart = container.getComponent("Cart");
			cart.getPromotions().then(function(promotions) {
				if (promotions.length >= 3) {
					console.log("Too many promotions on this order!");
				}	
			});
Returns

Returns a Deferred object. If the promise is resolved, it returns an array of Promotion objects. If the promise is rejected, it returns an error.
The Promotion object contains a property called internalid, which you can use with the removePromotion() method to remove a promotion from the cart.

removeToViewEventsDefinition( view_id, event_selector ) → {void}

Description

Removes an event handler from an event in a view.

Parameters
Name Type Description
view_id string

The identifier of the view of the current component to which the event handler will be added.
event_selector string
Returns

Returns null if the operation is successful. Otherwise, it throws an exception.

Throws
Details

VisualComponent#removeToViewEventsDefinition

VisualComponent#removeToViewEventsDefinition

getShipAddress() → {Deferred}

Description

Gets the shipping address of the order.

			var cart = container.getComponent("Cart");
			cart.getShipAddress().then(function(shipaddress) {
				
				if (shipaddress.country != "US") {
					alert("Shipping of this item outside the US may incur delays due to export regulations.");
				}
			})
			
			// Example of the Address object returned by this method:
			{
				addr1: "1 Main Street",
				addr2: "",
				addr3: "",
				city: "New York",
				company: null,
				country: "US",
				defaultbilling: "F",
				defaultshipping: "T",
				extras: {...},
				fullname: "John Smith",
				internalid: "42",
				isresidential: "F",
				isvalid: "T",
				phone: "555-123-1234",
				state: "NY",
				zip: "10065"
			}
Returns

Returns a Deferred object. If the promise is resolved, it returns an Address object. If the promise is rejected, it returns an error.

getShipMethod() → {Deferred}

Description

Gets the selected shipping method on the order. If a shipping method is not yet set on the order, it returns an object with a single property called extras with an empty object as its value.

			var cart = container.getComponent("Cart");
			cart.getShipMethod().then(function(shipmethod) {
				if (shipmethod.internalid == "105") {
					alert("Delivery tracking for this ship method is available on www.example.com/track");
				}
			});

Example of the ShipMethod object returned by this method:

			{
				extras: {},
				internalid: "105",
				name: "2-day shipping",
				rate: 10,
				rate_formatted: "$10.00",
				shipcarrier: "nonups"
			}
Returns

Returns a Deferred object. If the promise is resolved, it returns a ShipMethod object. If the promise is rejected, it returns an error.

getShipMethods() → {Deferred}

Description

Gets all shipping methods available on the order.

			var cart = container.getComponent("Cart");
			cart.getShipMethods().then(function(shipmethods) {
				alert(shipmethods.length + " shipping methods are available on this order.");
			});
Returns

Returns a Deferred object. If the promise is resolved, it returns an array of ShipMethod objects. If the promise is rejected, it returns an error.

getSummary() → {Deferred}

Description

Gets a summary of the cart including information such as the total currency amount, number of items in the transaction, tax amounts, and discounts applied.

		var cart = container.getComponent("Cart");
			cart.getSummary().then(function(summary) {
				if (summary.total > 10000) {
					throw new Error("Contact our sales team on 555-123-1234 for order amounts above 10,000 USD.");
				}
			});

Example of the Summary object returned by this method. Note that the list of properties in the extras property may differ depending on the configuration of your account.

			{
				discounttotal: 0,
				estimatedshipping: 0,
				extras: {
					discountedsubtotal: 260.88,
					discountedsubtotal_formatted: "$260.88",
					discountrate: 0,
					discountrate_formatted: "",
					discounttotal_formatted: "($0.00)",
					estimatedshipping_formatted: "$0.00",
					giftcertapplied_formatted: "($0.00)",
					handlingcost_formatted: "$0.00",
					itemcount: 3,
					shippingcost_formatted: "$0.00",
					subtotal_formatted: "$260.88",
					tax2total_formatted: "$0.00",
					taxondiscount: 0,
					taxondiscount_formatted: "$0.00",
					taxonhandling: 0,
					taxonhandling_formatted: "$0.00",
					taxonshipping: 0,
					taxonshipping_formatted: "$0.00",
					taxtotal_formatted: "$0.00",
					total_formatted: "$260.88",
					totalcombinedtaxes: 0,
					totalcombinedtaxes_formatted: "$0.00"
				}
				giftcertapplied: 0,
				handlingcost: 0,
				shippingcost: 0,
				subtotal: 260.88,
				tax2total: 0,
				taxtotal: 0,
				total: 260.88
			}
Returns

Returns a Deferred object. If the promise is resolved, it returns a Summary object. If the promise is rejected, it returns an error.

removeLine( line ) → {Deferred}

Description

Removes a line from the cart. To decrease (or increase) the line quantity, use updateLine() instead.

				var cart = container.getComponent("Cart");
				cart.removeLine({
					"line_id": "i123"	
				}).then(function() {
					console.log("Line removed successfully.");
				}, function() {
					alert("An error occurred while trying to remove the item. Try again.");
				});
Parameters
Name Type Description
line Object

The line to remove from the cart. line is an object with a single property line_id. The value of line_id is the internal ID of the item.
Returns

Returns a Deferred object. If the promise is resolved, it indicates the operation was successful.

removePromotion( data ) → {Deferred}

Description

Removes a promotion from the cart. If the promotion is removed sucessfully, the cart total is updated and the promotion no longer appears in the cart.

			var cart = container.getComponent("Cart");
			
			if (cart) {
				cart.removePromotion({promocode_internalid: "22"}).fail(function() {
					console.log("Could not remove promotion.");
				});
			}
Parameters
Name Type Description
data Object

The promotion to remove from the cart. data is an object with a single property promocode_internalid. The value of promocode_internalid is the internal ID of the promotion. You can use the getPromotions() method to get the internal IDs of all promotions currently applied.
Returns

Returns a Deferred object. If the promise is resolved, it indicates the promotion was removed successfully. Otherwise, if the promise fails, it returns an error message.

submit() → {Deferred}

Description

Submits the order. The user must be logged in on the web store to submit an order. If information required to submit the order is missing or incomplete, this method returns an error message. This method only works on a secure domain.

			var cart = container.getComponent("Cart");
			cart.submit();
Returns

Returns a Deferred object. If the promise is resolved, it returns a ConfirmationSubmit. If the promise is rejected, it returns an error.

updateLine( line ) → {Deferred}

Description

Updates the quantity of a line in the cart. Setting the quantity to zero will remove the line from the cart.

			var cart = container.getComponent("Cart");
			cart.updateLine({
				line: {
					internalid: "i123",
					quantity: 2
				}
			}).then(function() {
				console.log("Line updated successfully");
			});
Parameters
Name Type Description
line Line

The line in the cart to update. line is an object with a single property called line. The value of the line property is a Line object. You only need to specify two properties in the Line object: internalid and quantity.
Returns

Returns a Deferred object. If the promise is resolved, it returns the line as a Line object. Otherwise, the promise returns the rejected state.

Events

afterShowContent

Description

Event triggered after content has been rendered in the main view. This event is available in components that extend VisualComponent (such as PDP, PLP, or Layout) and is triggered by the showContent() method.

See the Work with Events help topic in the NetSuite Help Center for more information.

Details

VisualComponent#afterShowContent

VisualComponent#afterShowContent

beforeShowContent

Description

Event triggered before content in the main view is rendered. This event is available in components that extend VisualComponent (such as PDP, PLP, or Layout) and is triggered by the showContent() method. For example, if the URL changes in the application, the showContent() method is called, which triggers the event.

Details

VisualComponent#beforeShowContent

VisualComponent#beforeShowContent

beforeUpdateLine

Description

Cancelable event triggered before a line in the cart is updated. See CancelableEvents.

afterUpdateLine

Description

Event triggered after a line in the cart is updated.

Properties
Type Description
boolean

beforeRemoveLine

Description

Cancelable event triggered before a line in the cart is removed. See CancelableEvents.

Properties
Type Description
boolean

afterRemoveLine

Description

Event triggered after a line in the cart is removed.

Properties
Type Description
boolean

beforeEstimateShipping

Description

Cancelable event triggered before getting shipping esimates for the cart. See CancelableEvents.

Properties
Type Description
boolean

afterEstimateShipping

Description

Event triggered after shipping estimates retrieved.

Properties
Type Description
boolean

beforeClearEstimateShipping

Description

Cancelable event triggered before clearing shipping estimates for the cart. See CancelableEvents.

Properties
Type Description
boolean

afterClearEstimateShipping

Description

Event triggered after shipping estimates are cleared.

Properties
Type Description
boolean

beforeAddPromotion

Description

Cancelable event triggered before a promotion is applied to the cart. See CancelableEvents.

Properties
Type Description
boolean

afterAddPromotion

Description

Event triggered after a promotion is applied to the cart.

Properties
Type Description
boolean

beforeRemovePromotion

Description

Cancelable event triggered before a promotion is removed from the cart. See CancelableEvents.

Properties
Type Description
boolean

afterRemovePromotion

Description

Event triggered after a promotion is removed fromt the cart.

Properties
Type Description
boolean

beforeAddPayment

Description

Cancelable event triggered before a payment method is added to the order. See CancelableEvents.

Properties
Type Description
boolean

afterAddPayment

Description

Event triggered after a payment method is added to the order.

Properties
Type Description
boolean

beforeSubmit

Description

Cancelable event triggered before the order is submitted. See CancelableEvents.

Properties
Type Description
boolean

afterSubmit

Description

Event triggered after the order is submitted.

Properties
Type Description
boolean

beforeAddLine

Description

Cancelable event triggered before a line is added to the cart. See CancelableEvents.

Properties
Type Description
boolean

afterAddLine

Description

Event triggered after a line is added to the cart.

Properties
Type Description
boolean