Class: module:models/Store

module:models/Store(id)

new module:models/Store(id)

Constructs a new Store. Document representing a store.

Parameters:
Name Type Description
id String

The id of the store.

Source:

Members

(readonly) CountryCodeEnum :String

Allowed values for the country_code property.

Type:
  • String
Source:

(inner) address1 :String

The first address of the store.

Type:
  • String
Source:

(inner) address2 :String

The second address of the store.

Type:
  • String
Source:

(inner) c_countryCodeValue :String

Country Code Value - for the form values

Type:
  • String
Source:

(inner) c_inventoryListId :String

Store Inventory List ID

Type:
  • String
Source:

(inner) c_TestAttribute :Array.<String>

Type:
  • Array.<String>
Source:

(inner, constant) CA

value: "CA"

Source:

(inner) city :String

The city of the store.

Type:
  • String
Source:

(inner) country_code :module:models/Store.CountryCodeEnum

The country code of the store.

Type:
  • module:models/Store.CountryCodeEnum
Source:

(inner, constant) DE

value: "DE"

Source:

(inner) distance :Number

The distance to the given geo location in the unit of attribute distance (miles or kilometers).

Type:
  • Number
Source:

(inner) distance_unit :String

The distance unit the distance attribute is measured in (either in miles or kilometers).

Type:
  • String
Source:

(inner) email :String

The email address of the store.

Type:
  • String
Source:

(inner) fax :String

The fax number of the store.

Type:
  • String
Source:

(inner) id :String

The id of the store.

Type:
  • String
Source:

(inner) image :String

The store image.

Type:
  • String
Source:

(inner) inventory_id :String

The inventory list id associated with this store.

Type:
  • String
Source:

(inner) latitude :Number

The latitude of the store.

Type:
  • Number
Source:

(inner) longitude :Number

The longitude of the store.

Type:
  • Number
Source:

(inner) name :String

The store name.

Type:
  • String
Source:

(inner) phone :String

The phone number of the store.

Type:
  • String
Source:

(inner) pos_enabled :Boolean

Whether this store uses Store Point-of-Sale.

Type:
  • Boolean
Source:

(inner) postal_code :String

The postal code of the store.

Type:
  • String
Source:

(inner) state_code :String

The state code of the store.

Type:
  • String
Source:

(inner) store_events :String

The store events.

Type:
  • String
Source:

(inner) store_hours :String

The store opening hours.

Type:
  • String
Source:

(inner) store_locator_enabled :Boolean

Whether this store should show up in store locator results.

Type:
  • Boolean
Source:

(inner, constant) US

value: "US"

Source:

Methods

(static) constructFromObject(data, obj) → {module:models/Store}

Constructs a Store from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:models/Store

Optional instance to populate.

Source:
Returns:

The populated Store instance.

Type
module:models/Store