Class Store

• TopLevel.Object
  • dw.object.PersistentObject
    • dw.object.ExtensibleObject
      • dw.catalog.Store

Represents a store in Commerce Cloud Digital.

Property Summary 

Property	Description
ID: String (read-only)	Returns the ID of the store.
address1: String (read-only)	Returns the address1 of the store.
address2: String (read-only)	Returns the address2 of the store.
city: String (read-only)	Returns the city of the store.
countryCode: EnumValue (read-only)	Returns the countryCode of the store.
demandwarePosEnabled: Boolean (read-only)	Returns the demandwarePosEnabled flag for the store.
email: String (read-only)	Returns the email of the store.
fax: String (read-only)	Returns the fax of the store.
image: MediaFile (read-only)	Returns the store image.
inventoryList: ProductInventoryList (read-only)	Returns the inventory list the store is associated with.
inventoryListID: String (read-only)	Returns the inventory list id the store is associated with.
latitude: Number (read-only)	Returns the latitude of the store.
longitude: Number (read-only)	Returns the longitude of the store.
name: String (read-only)	Returns the name of the store.
phone: String (read-only)	Returns the phone of the store.
posEnabled: Boolean (read-only)	Returns the posEnabled flag for the Store.
postalCode: String (read-only)	Returns the postalCode of the store.
stateCode: String (read-only)	Returns the stateCode of the store.
storeEvents: MarkupText (read-only)	Returns the storeEvents of the store.
storeGroups: Collection (read-only)	Returns all the store groups this store belongs to.
storeHours: MarkupText (read-only)	Returns the storeHours of the store.
storeLocatorEnabled: Boolean (read-only)	Returns the storeLocatorEnabled flag for the store.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

Method	Description
getAddress1()	Returns the address1 of the store.
getAddress2()	Returns the address2 of the store.
getCity()	Returns the city of the store.
getCountryCode()	Returns the countryCode of the store.
getEmail()	Returns the email of the store.
getFax()	Returns the fax of the store.
getID()	Returns the ID of the store.
getImage()	Returns the store image.
getInventoryList()	Returns the inventory list the store is associated with.
getInventoryListID()	Returns the inventory list id the store is associated with.
getLatitude()	Returns the latitude of the store.
getLongitude()	Returns the longitude of the store.
getName()	Returns the name of the store.
getPhone()	Returns the phone of the store.
getPostalCode()	Returns the postalCode of the store.
getStateCode()	Returns the stateCode of the store.
getStoreEvents()	Returns the storeEvents of the store.
getStoreGroups()	Returns all the store groups this store belongs to.
getStoreHours()	Returns the storeHours of the store.
isDemandwarePosEnabled()	Returns the demandwarePosEnabled flag for the store.
isPosEnabled()	Returns the posEnabled flag for the Store.
isStoreLocatorEnabled()	Returns the storeLocatorEnabled flag for the store.

Methods inherited from class ExtensibleObject 

describe, getCustom

Methods inherited from class PersistentObject 

getCreationDate, getLastModified, getUUID

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 

ID 

ID: String (read-only)

Returns the ID of the store.

---

address1 

address1: String (read-only)

Returns the address1 of the store.

---

address2 

address2: String (read-only)

Returns the address2 of the store.

---

city 

city: String (read-only)

Returns the city of the store.

---

countryCode 

countryCode: EnumValue (read-only)

Returns the countryCode of the store.

---

demandwarePosEnabled 

demandwarePosEnabled: Boolean (read-only)

Returns the demandwarePosEnabled flag for the store. Indicates that this store uses Commerce Cloud Store for point-of-sale.

Deprecated:

Use isPosEnabled() instead

Warning

---

email 

email: String (read-only)

Returns the email of the store.

---

fax 

fax: String (read-only)

Returns the fax of the store.

---

image 

image: MediaFile (read-only)

Returns the store image.

---

inventoryList 

inventoryList: ProductInventoryList (read-only)

Returns the inventory list the store is associated with. If the store is not associated with a inventory list, or the inventory list does not exist, the method returns null.

---

inventoryListID 

inventoryListID: String (read-only)

Returns the inventory list id the store is associated with. If the store is not associated with a inventory list, or the inventory list does not exist, the method returns null.

---

latitude 

latitude: Number (read-only)

Returns the latitude of the store.

---

longitude 

longitude: Number (read-only)

Returns the longitude of the store.

---

name 

name: String (read-only)

Returns the name of the store.

---

phone 

phone: String (read-only)

Returns the phone of the store.

---

posEnabled 

posEnabled: Boolean (read-only)

Returns the posEnabled flag for the Store. Indicates that this store uses Commerce Cloud Store for point-of-sale.

---

postalCode 

postalCode: String (read-only)

Returns the postalCode of the store.

---

stateCode 

stateCode: String (read-only)

Returns the stateCode of the store.

---

storeEvents 

storeEvents: MarkupText (read-only)

Returns the storeEvents of the store.

---

storeGroups 

storeGroups: Collection (read-only)

Returns all the store groups this store belongs to.

---

storeHours 

storeHours: MarkupText (read-only)

Returns the storeHours of the store.

---

storeLocatorEnabled 

storeLocatorEnabled: Boolean (read-only)

Returns the storeLocatorEnabled flag for the store.

---

Method Details 

getAddress1() 

getAddress1(): String

Returns the address1 of the store.

Returns:

• address1 of the store

---

getAddress2() 

getAddress2(): String

Returns the address2 of the store.

Returns:

• address2 of the store

---

getCity() 

getCity(): String

Returns the city of the store.

Returns:

• city of the store

---

getCountryCode() 

getCountryCode(): EnumValue

Returns the countryCode of the store.

Returns:

• countryCode of the store

---

getEmail() 

getEmail(): String

Returns the email of the store.

Returns:

• email of the store

---

getFax() 

getFax(): String

Returns the fax of the store.

Returns:

• fax of the store

---

getID() 

getID(): String

Returns the ID of the store.

Returns:

• ID of the store

---

getImage() 

getImage(): MediaFile

Returns the store image.

Returns:

• the store image.

---

getInventoryList() 

getInventoryList(): ProductInventoryList

Returns the inventory list the store is associated with. If the store is not associated with a inventory list, or the inventory list does not exist, the method returns null.

Returns:

• ProductInventoryList or null

---

getInventoryListID() 

getInventoryListID(): String

Returns the inventory list id the store is associated with. If the store is not associated with a inventory list, or the inventory list does not exist, the method returns null.

Returns:

• the inventory list id

---

getLatitude() 

getLatitude(): Number

Returns the latitude of the store.

Returns:

• latitude of the store

---

getLongitude() 

getLongitude(): Number

Returns the longitude of the store.

Returns:

• longitude of the store

---

getName() 

getName(): String

Returns the name of the store.

Returns:

• name of the store

---

getPhone() 

getPhone(): String

Returns the phone of the store.

Returns:

• phone of the store

---

getPostalCode() 

getPostalCode(): String

Returns the postalCode of the store.

Returns:

• postalCode of the store

---

getStateCode() 

getStateCode(): String

Returns the stateCode of the store.

Returns:

• stateCode of the store

---

getStoreEvents() 

getStoreEvents(): MarkupText

Returns the storeEvents of the store.

Returns:

• storeEvents of the store

---

getStoreGroups() 

getStoreGroups(): Collection

Returns all the store groups this store belongs to.

Returns:

• collection of store groups

---

getStoreHours() 

getStoreHours(): MarkupText

Returns the storeHours of the store.

Returns:

• storeHours of the store

---

isDemandwarePosEnabled() 

isDemandwarePosEnabled(): Boolean

Returns the demandwarePosEnabled flag for the store. Indicates that this store uses Commerce Cloud Store for point-of-sale.

Returns:

• the demandwarePosEnabled flag

Deprecated:

Use isPosEnabled() instead

Warning

---

isPosEnabled() 

isPosEnabled(): Boolean

Returns the posEnabled flag for the Store. Indicates that this store uses Commerce Cloud Store for point-of-sale.

Returns:

• the posEnabled flag

---

isStoreLocatorEnabled() 

isStoreLocatorEnabled(): Boolean

Returns the storeLocatorEnabled flag for the store.

Returns:

• the storeLocatorEnabled flag

---