Location
Represents a physical or virtual place of business — such as a warehouse, plant, store, site, or delivery vehicle — used across Manufacturing/Automotive/Consumer Goods Cloud to model where inventory is held, where assortments are assigned, and where operations occur. Locations can be organized into a hierarchy via ParentLocationId and RootLocationId. This object is available in API version 68.0 and later.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Special Access Rules
Available only in orgs with Manufacturing Cloud, Automotive Cloud, or Consumer Goods Cloud features (including Inventory Management and Location/Assortment management) enabled.
Fields
CloseDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date this location closed or is scheduled to close.
ConstructionEndDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date construction of this location finished.
ConstructionStartDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date construction of this location began.
CurrencyIsoCode
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The ISO currency code associated with this location. Possible values are: AED (UAE Dirham), USD (U.S. Dollar), and every other active currency ISO code configured for the org. The default value is USD.
Description
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A free-text description of this location.
DrivingDirections
Type: string
Properties: Create, Filter, Nillable, Sort, Update
Description: Free-text driving directions to reach this location.
Email
Type: email
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The primary email address associated with this location.
ExternalReference
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: An external identifier used to correlate this record with the same location in an external or source system.
Fax
Type: phone
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The fax number for this location.
InternalOrganizationUnitId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The internal organization unit that owns or operates this location.
Relationship Name: InternalOrganizationUnit
Refers To: InternalOrganizationUnit
IsInventoryLocation
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether inventory can be tracked and stored at this location. The default value is false.
IsMobile
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether this location is mobile (for example, a delivery van) rather than a fixed site. The default value is false.
LastReferencedDate
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record or a related record.
LastViewedDate
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record.
Latitude
Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The geolocation latitude of this location.
Location
Type: location
Properties: Nillable
Description: The compound geolocation field composed of the Latitude and Longitude values.
LocationLevel
Type: int
Properties: Filter, Group, Nillable, Sort
Description: The depth of this location within the location hierarchy, relative to its root location.
LocationType
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The type of place this location represents. Possible values are Plant, Site, Van, Virtual, and Warehouse. The default value is Warehouse.
LogoId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The content asset used as this location’s logo/image.
Relationship Name: Logo
Refers To: ContentAsset
Longitude
Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The geolocation longitude of this location.
Mobile
Type: phone
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The mobile phone number associated with this location.
MobileLocationType
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: When IsMobile is true, indicates the type of mobile location. Possible values are Bike, Car, CargoUnit—Cargo Unit, and Truck. The default value is Car.
Name
Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of this location.
OpenDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date this location opened for business.
OwnerId
Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The user or queue that owns this record.
Relationship Name: Owner
Refers To: Group, User
ParentLocationId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The immediate parent location in the location hierarchy.
Relationship Name: ParentLocation
Refers To: Location
Phone
Type: phone
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The primary phone number for this location.
PossessionDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date possession of this location was taken (for example, on lease or purchase).
RegistrationNumber
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A government or business registration number associated with this location.
RemodelEndDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date a remodel of this location finished.
RemodelStartDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date a remodel of this location began.
RootLocationId
Type: reference
Properties: Filter, Group, Nillable, Sort
Description: The top-level (root) location at the base of this location’s hierarchy branch.
Relationship Name: RootLocation
Refers To: Location
TimeZone
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The time zone this location operates in, expressed as an IANA time zone identifier (for example, America/New_York).
Associated Objects
This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.
