RetailStore

Create records for physical retail stores associated to business accounts. 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

AccountId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: ID of the parent account to which the retail store belongs.

Address

Type: address
Properties: Filter, Nillable
Description: Address of the retail store. This field is available in API version 51.0 and later.

City

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: City where the retail store is located. This field is available in API version 51.0 and later.

Country

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Country where the retail store is located. This field is available in API version 51.0 and later.

DeliveryFrequency

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of times orders are delivered to the store with the specified frequency type.

DeliveryFrequencyType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The frequency at which orders are delivered to the store.

This is a static picklist. The values of the picklist aren’t displayed in the Object Manager.
Note
Possible values:
- Daily
- Monthly
- Weekly

DeliveryMethod

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The method used for delivering orders to the store.
Possible values:
- Truck
- Van

Description

Type: textarea
Properties: Create, Nillable, Update
Description: User-defined description of the store.

GeocodeAccuracy

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Geocode for the retail store. This field is available in API version 51.0 and later.
Possible values:
- Address
- Block
- City
- County
- State
- Street
- Zip

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.

Latitude

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: Latitude of the retail store. This field is available in API version 51.0 and later.

LocationId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: Identifier of a retail store’s geographical location.

Longitude

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: Longitude of the retail store. This field is available in API version 51.0 and later.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Unique identifier for the store.

OperatingHoursId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the store operating hours.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: ID of the retail store record owner.

PaymentMethod

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Method of payment used for transactions of orders.
Possible values:
- Cash
- Cheque
- Credit

PostalCode

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Postal code of the retail store address. This field is available in API version 51.0 and later.

PreferredVisitHoursId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the preferred hours for store visits.

PrimaryContactId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Name of the store manager that is associated with the account.

Priority

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The priority of the store.
Possible values:
- High
- Low
- Medium

RecommendedVisitFrequency

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The recommended number of store visits.

RecommendedVisitFrequencyType

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The recommended frequency type for store visits.
Possible values:
- Day
- Month
- Week

RetailLocationGroupId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the store group with which the store is associated.

State

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: State where the retail store is located. This field is available in API version 51.0 and later.

StoreType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Type of the store. This value is used when setting up policies for the store.
Possible values:
- Flagship Store
- Regular Store
- Van Store
- Virtual Store

Street

Type: textarea
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Street where the retail store is located. This field is available in API version 51.0 and later.

Associated Objects

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

RetailStoreChangeEvent (API Version 62.0): Change events are available for the object.
RetailStoreFeed: Feed are available for the object.
RetailStoreHistory: History is available for the object.
RetailStoreShare: Sharing is available for the object.