Salesforce B2C Commerce 24.7 > B2C Commerce API > B2C Commerce Script > dw.order
dw.order
Class ShippingLocation
Object
dw.order.ShippingLocation
Represents a specific location for a shipment.

Note: this class allows access to sensitive personal and private information. Pay attention to appropriate legal and regulatory requirements related to this data.

Properties
address1  :  String
The shipping location's first address.
address2  :  String
The shipping location's second address.
city  :  String
The shipping location's city.
countryCode  :  String
The shipping location's country code.
postalCode  :  String
The shipping location's postal code.
postBox  :  String
The shipping location's post box.
stateCode  :  String
The shipping location's state code.
suite  :  String
The shipping location's suite.
Constructor Summary
ShippingLocation()
Constructs a new shipping location.
ShippingLocation(address : CustomerAddress)
Constructs a new shipping location and initializes it with the values of the specified address object.
ShippingLocation(address : OrderAddress)
Constructs a new shipping location and initializes it with the values of the specified address object.
Method Summary
getAddress1() : String
Returns the shipping location's first address.
getAddress2() : String
Returns the shipping location's second address.
getCity() : String
Returns the shipping location's city.
getCountryCode() : String
Returns the shipping location's country code.
getPostalCode() : String
Returns the shipping location's postal code.
getPostBox() : String
Returns the shipping location's post box.
getStateCode() : String
Returns the shipping location's state code.
getSuite() : String
Returns the shipping location's suite.
setAddress1(aValue : String) : void
Sets the shipping location's first address.
setAddress2(aValue : String) : void
Sets the shipping location's second address.
setCity(aValue : String) : void
Sets the shipping location's city.
setCountryCode(aValue : String) : void
Sets the shipping location's country code.
setPostalCode(aValue : String) : void
Sets the shipping location's postal code.
setPostBox(aValue : String) : void
Sets the shipping location's post box.
setStateCode(aValue : String) : void
Sets the shipping location's state code.
setSuite(aValue : String) : void
Sets the shipping location's suite.
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Constructor Detail
ShippingLocation
public ShippingLocation()
Constructs a new shipping location.
ShippingLocation
public ShippingLocation(address : CustomerAddress)
Constructs a new shipping location and initializes it with the values of the specified address object.
Parameters:
address - the address that the shipping location represents.
ShippingLocation
public ShippingLocation(address : OrderAddress)
Constructs a new shipping location and initializes it with the values of the specified address object.
Parameters:
address - the address that the shipping location represents.
Method Detail
getAddress1
getAddress1() : String
Returns the shipping location's first address.
Returns:
the shipping location's first address.
getAddress2
getAddress2() : String
Returns the shipping location's second address.
Returns:
the shipping location's second address.
getCity
getCity() : String
Returns the shipping location's city.
Returns:
the shipping location's city.
getCountryCode
getCountryCode() : String
Returns the shipping location's country code.
Returns:
the shipping location's country code.
getPostalCode
getPostalCode() : String
Returns the shipping location's postal code.
Returns:
the shipping location's postal code.
getPostBox
getPostBox() : String
Returns the shipping location's post box.
Returns:
the shipping location's post box.
getStateCode
getStateCode() : String
Returns the shipping location's state code.
Returns:
the shipping location's state code.
getSuite
getSuite() : String
Returns the shipping location's suite.
Returns:
the shipping location's suite.
setAddress1
setAddress1(aValue : String) : void
Sets the shipping location's first address.
Parameters:
aValue - the shipping location's first address.
setAddress2
setAddress2(aValue : String) : void
Sets the shipping location's second address.
Parameters:
aValue - the shipping location's second address.
setCity
setCity(aValue : String) : void
Sets the shipping location's city.
Parameters:
aValue - the shipping location's city.
setCountryCode
setCountryCode(aValue : String) : void
Sets the shipping location's country code.
Parameters:
aValue - the shipping location's country code.
setPostalCode
setPostalCode(aValue : String) : void
Sets the shipping location's postal code.
Parameters:
aValue - the shipping location's postal code.
setPostBox
setPostBox(aValue : String) : void
Sets the shipping location's post box.
Parameters:
aValue - the shipping location's post box.
setStateCode
setStateCode(aValue : String) : void
Sets the shipping location's state code.
Parameters:
aValue - the shipping location's state code.
setSuite
setSuite(aValue : String) : void
Sets the shipping location's suite.
Parameters:
aValue - the shipping location's suite.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.