Description
The LocationGroup object is used to groups Locations that can be found via a locator, eg Store locator.
ℹ️ Note
This object supports custom data via the data attribute.
Attributes
| Attribute | Type | Description |
|---|---|---|
active? |
Boolean | Returns true if the LocationGroup is active |
categories |
List[ProductCategory] | Returns a list of product categories that the locations in this LocationGroup can handle |
id |
String | Returns the unique id of this LocationGroup |
identifier |
String | Returns a unique identifier for this LocationGroup |
locations |
List[Location] | Returns a list of Locations in this LocationGroup |
meta_description |
String | Returns the value of the Meta Description attribute |
meta_keywords |
String | Returns the value of the Meta Keywords attribute |
meta_title |
String | Returns the value of the Meta Title attribute |
name |
String | Returns the display name of this LocationGroup |
path |
String | Returns the url path for this LocationGroup |
social_image |
Image | Returns the image to be used when sharing this LocationGroup |
url |
String | Returns the complete url for this LocationGroup |