Class ShippingLocation

• TopLevel.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.

Property Summary 

Property	Description
address1: String	Returns the shipping location’s first address.
address2: String	Returns the shipping location’s second address.
city: String	Returns the shipping location’s city.
countryCode: String	Returns the shipping location’s country code.
postBox: String	Returns the shipping location’s post box.
postalCode: String	Returns the shipping location’s postal code.
stateCode: String	Returns the shipping location’s state code.
suite: String	Returns the shipping location’s suite.

Constructor Summary 

Constructor	Description
ShippingLocation()	Constructs a new shipping location.
ShippingLocation(CustomerAddress)	Constructs a new shipping location and initializes it with the values of the specified address object.
ShippingLocation(OrderAddress)	Constructs a new shipping location and initializes it with the values of the specified address object.

Method Summary 

Method	Description
getAddress1()	Returns the shipping location’s first address.
getAddress2()	Returns the shipping location’s second address.
getCity()	Returns the shipping location’s city.
getCountryCode()	Returns the shipping location’s country code.
getPostBox()	Returns the shipping location’s post box.
getPostalCode()	Returns the shipping location’s postal code.
getStateCode()	Returns the shipping location’s state code.
getSuite()	Returns the shipping location’s suite.
setAddress1(String)	Sets the shipping location’s first address.
setAddress2(String)	Sets the shipping location’s second address.
setCity(String)	Sets the shipping location’s city.
setCountryCode(String)	Sets the shipping location’s country code.
setPostBox(String)	Sets the shipping location’s post box.
setPostalCode(String)	Sets the shipping location’s postal code.
setStateCode(String)	Sets the shipping location’s state code.
setSuite(String)	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

Property Details 

address1 

address1: String

Returns the shipping location's first address.

---

address2 

address2: String

Returns the shipping location's second address.

---

city 

city: String

Returns the shipping location's city.

---

countryCode 

countryCode: String

Returns the shipping location's country code.

---

postBox 

postBox: String

Returns the shipping location's post box.

---

postalCode 

postalCode: String

Returns the shipping location's postal code.

---

stateCode 

stateCode: String

Returns the shipping location's state code.

---

suite 

suite: String

Returns the shipping location's suite.

---

Constructor Details 

ShippingLocation() 

ShippingLocation()

Constructs a new shipping location.

---

ShippingLocation(CustomerAddress) 

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(OrderAddress) 

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 Details 

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.

---

getPostBox() 

getPostBox(): String

Returns the shipping location's post box.

Returns:

• the shipping location's post box.

---

getPostalCode() 

getPostalCode(): String

Returns the shipping location's postal code.

Returns:

• the shipping location's postal code.

---

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(String) 

setAddress1(aValue: String): void

Sets the shipping location's first address.

Parameters:

• aValue - the shipping location's first address.

---

setAddress2(String) 

setAddress2(aValue: String): void

Sets the shipping location's second address.

Parameters:

• aValue - the shipping location's second address.

---

setCity(String) 

setCity(aValue: String): void

Sets the shipping location's city.

Parameters:

• aValue - the shipping location's city.

---

setCountryCode(String) 

setCountryCode(aValue: String): void

Sets the shipping location's country code.

Parameters:

• aValue - the shipping location's country code.

---

setPostBox(String) 

setPostBox(aValue: String): void

Sets the shipping location's post box.

Parameters:

• aValue - the shipping location's post box.

---

setPostalCode(String) 

setPostalCode(aValue: String): void

Sets the shipping location's postal code.

Parameters:

• aValue - the shipping location's postal code.

---

setStateCode(String) 

setStateCode(aValue: String): void

Sets the shipping location's state code.

Parameters:

• aValue - the shipping location's state code.

---

setSuite(String) 

setSuite(aValue: String): void

Sets the shipping location's suite.

Parameters:

• aValue - the shipping location's suite.

---