Visit

Track information related to a field rep’s visit to a retail store where they perform retail activities. 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
AccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The account that is associated with a visit. This field is available in API versions 48.0 and later.
ActualVisitEndTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the visit ended.
ActualVisitStartTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the visit started.
AddressId	Type reference Properties Filter, Group, Nillable, Sort Description The address of the retail store where the visit must be conducted. This field is available in API versions 52.0 and later. This is a relationship field. Relationship Name Address Relationship Type Lookup Refers To Address
ContactId	Type reference Properties Filter, Group, Nillable, Sort Description The person to contact at the retail store during a visit. This field is available in API versions 52.0 and later. This is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact
ContextId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The purpose of a visit, such as claim, business license application, or work type. This field is available in API versions 48.0 and later.
InstructionDescription	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Special instructions provided by a sales manager or an admin that a sales rep refers to during a visit.
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 Filter, Group, Nillable, Sort Description The location of the retail store where visit must be conducted. This field is available in API versions 52.0 and later. This is a relationship field. Relationship Name Location Relationship Type Lookup Refers To Location
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Unique identifier for the visit record.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the visit record owner.
PlaceId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the place that sales reps visit.
PlannedVisitEndTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the visit is expected to end.
PlannedVisitStartTime	Type dateTime Properties Create, Filter, Sort, Update Description The date and time when the visit is expected to start.
RetailStoreId	Type reference Properties Filter, Group, Nillable, Sort Description The retail store where the visit is conducted. This field is available in API versions 52.0 and later. This is a relationship field. Relationship Name RetailStore Relationship Type Lookup Refers To RetailStore
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The status of the visit. Sales reps’ can’t edit this field. Possible values are: `Abandoned` `Completed` `InProgress` `Planned` `Unscheduled` `None` `Error` This is a static picklist. The values of the picklist aren’t displayed in the Object Manager. Note
StatusRemarks	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The reasons for abandoning or completing the visit as provided by the sales rep.
VisitPriority	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The priority of the visit. Possible values are: `High` `Low` `Medium`
VisitorId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the sales representative visiting the store.

Associated Objects

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

VisitShare: Sharing is available for the object.
VisitFeed: Feed is available for the object.
VisitHistory: History is available for the object.
VisitOwnerSharingRule: Sharing rule is available for the object.

Consumer Goods Cloud Developer Guide

Visit

Supported Calls

Fields

Associated Objects