InStoreLocation

Create locations within a retail store’s layout such as aisles, shelves, or backrooms. This object is available in API version 47.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
Category
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Category of similar in-store location types across a store group.
Possible values are:
  • Aisle
  • Backroom
  • Endcap
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Description of the in-store location.
InStoreLocationType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Type of in-store location. Most retail stores have similar layouts and have common in-store location types.
Possible values are:
  • Assets
  • Backroom
  • Bin
  • Other
  • Shelf
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user viewed this record.
LocationId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the GPS coordinates of the retail store.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
User-defined name of the in-store location.
PlanogramId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Planogram image associated with the in-store location.
RetailStoreId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the store associated with the location.

Associated Objects

This object has the following associated objects. Unless noted, they’re available in the same API version as this object.

InStoreLocationFeed
Feed is available for the object.
InStoreLocationHistory
History is available for the object.