---
schema_version: "1"
id: 49ed3949b65fea57c2467da83eef28b8270e47d83978e611b62f005381dfcf11
title: cgcloud__Tour__c
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/retail_api/sforce_api_objects_cgcloud__tour__c.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour__c.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: ef56ef9938e3d9d46b564f74345b8ddd35a98a5e3ed4e325aeea582d4bb4c0d3
description: Stores the details of the tour object. This object is available in API version 54.0 and later.
---
# cgcloud\_\_Tour\_\_c

Stores the details of the tour object. This object is available in API version 54.0 and later.

## Supported Calls

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

## Fields

### LastReferencedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: Most recent date that a user referenced this record on.

### LastViewedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: Most recent date that a user viewed this record on.

### Name

- **Type**: string
- **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
- **Description**: Unique identification of the record.

### OwnerId

- **Type**: reference
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: ID of the record owner.
    
    This field is a polymorphic relationship field.
- **Relationship Name**: Owner
- **Relationship Type**: Lookup
- **Refers To**: Group, User

### RecordTypeId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the record type.
    
    This field is a relationship field.
- **Relationship Name**: RecordType
- **Relationship Type**: Lookup
- **Refers To**: RecordType

### cgcloud\_\_Assignment\_Confirmation\_\_c

- **Type**: Picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Specifies the tour assignment confirmation type for the user.
    
    This field is reserved for future use.
- **Possible values**:
    - Confirmed
    - NoConfirmationRequired—No Confirmation Required
    - PendingConfirmation—Pending Confirmation

### cgcloud\_\_Cancel\_Note\_\_c

- **Type**: textarea
- **Properties**: Create, Nillable, Update
- **Description**: Note that can be specified if the tour is canceled.

### cgcloud\_\_Cancel\_Reason\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Indicates the reason that the tour was canceled for.
- **Possible values**:
    - RouteClosed—Route Closed
    - VehicleProblems—Vehicle Problems

### cgcloud\_\_Cash\_Check\_In\_Required\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Defines whether the cash check-in at the end of each tour is mandatory.
- **Possible values**:
    - Mandatory
    - Optional

### cgcloud\_\_Cash\_Handling\_Required\_\_c

- **Type**: boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Specifies whether the driver can perform cash-related actions during the tour execution.
- **Default value**: false

### cgcloud\_\_Completion\_Release\_Time\_\_c

- **Type**: dateTime
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: Stores the tour end release time.

### cgcloud\_\_Consider\_Mileage\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Specifies whether it's mandatory that the driver documents the odometer information when beginning and ending the tour.
- **Possible values**:
    - No
    - Optional
    - Yes

### cgcloud\_\_Consider\_Vehicle\_Status\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Specifies whether the driver must check and document the status or damages of the truck (and its trailers) at the beginning and the end of the tour.
- **Possible values**:
    - No
    - Status—Only Status
    - StatusReason—Status + Reason

### cgcloud\_\_Consider\_Vehicle\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Specifies whether the driver must check the license plate numbers of the truck and its trailers.
- **Possible values**:
    - No
    - Truck
    - TruckTrailer—Truck + Trailer
    - TruckTrailers—Truck + Trailer 1,2

### cgcloud\_\_Default\_Currency\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Defines the default currency of the tour template.
- **Possible values**:
    - CAD
    - CHF
    - EUR
    - GBP
    - JPY—Yen
    - NOK
    - RUB
    - USD

### cgcloud\_\_Default\_Driver\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the default driver of the tour.
    
    This field is a relationship field.
- **Relationship Name**: cgcloud\_\_Default\_Driver\_\_r
- **Relationship Type**: Lookup
- **Refers To**: User

### cgcloud\_\_Default\_Tour\_Visit\_Duration\_\_c

- **Type**: number
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The duration for creating tour-related visits based on the sequence. It’s measured in minutes.
- **Default value**: 30

### cgcloud\_\_Description\_Language\_1\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Stores the description of language 1.

### cgcloud\_\_Description\_Language\_2\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Stores the description of language 2.

### cgcloud\_\_Description\_Language\_3\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Stores the description of language 3.

### cgcloud\_\_Description\_Language\_4\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Stores the description of language 4.

### cgcloud\_\_Description\_\_c

- **Type**: string
- **Properties**: Filter, Nillable, Sort
- **Description**: Reference to the description based on the user-specified language.
    
    This field is a calculated field.
- **Formula**:
    
    CASE($User.cgcloud\_\_Language\_Postfix\_\_c,
    "Language1", cgcloud\_\_Description\_Language\_1\_\_c,
    "Language2", BLANKVALUE(cgcloud\_\_Description\_Language\_2\_\_c,cgcloud\_\_Description\_Language\_1\_\_c),
    "Language3", BLANKVALUE(cgcloud\_\_Description\_Language\_3\_\_c,cgcloud\_\_Description\_Language\_1\_\_c),
    "Language4", BLANKVALUE(cgcloud\_\_Description\_Language\_4\_\_c,cgcloud\_\_Description\_Language\_1\_\_c),
    cgcloud\_\_Description\_Language\_1\_\_c)

### cgcloud\_\_End\_Date\_Time\_\_c

- **Type**: dateTime
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: First date and time of validity period of the tour.

### cgcloud\_\_End\_Warehouse\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the warehouse where the tour ended.
    
    This field is a relationship field.
- **Relationship Name**: cgcloud\_\_End\_Warehouse\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_Warehouse\_\_c

### cgcloud\_\_Express\_Check\_Out\_\_c

- **Type**: boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Specifies whether the driver is allowed to use the express checkout type.
- **Default value**: false

### cgcloud\_\_Has\_End\_Tour\_Veh\_Details\_Rvw\_\_c

- **Type**: boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Indicates whether the vehicle details are reviewed (true) or not (false) during the end tour activities.
- **Default value**: false

### cgcloud\_\_Is\_Odometer\_Photo\_Required\_\_c

- **Type**: boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Specifies whether the user documents the odometer reading at the start and the end of the day with a picture.
- **Default value**: false

### cgcloud\_\_Message\_\_c

- **Type**: textarea
- **Properties**: Create, Nillable, Update
- **Description**: Message for the driver of the tour.

### cgcloud\_\_Multiple\_Cash\_Check\_In\_Allowed\_\_c

- **Type**: boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Defines whether multiple cash check-ins for one tour are allowed.
- **Default value**: false

### cgcloud\_\_Odometer\_End\_\_c

- **Type**: double
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: Mileage of the truck after ending the tour.

### cgcloud\_\_Odometer\_Start\_\_c

- **Type**: double
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: Mileage of the truck before starting the tour.

### cgcloud\_\_Route\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the route.
    
    This field is a relationship field.
- **Relationship Name**: cgcloud\_\_Route\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_Route\_\_c

### cgcloud\_\_Sales\_Org\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: Describes the sales org that the tour belongs to.
- **Possible values**:
    - 0000
    - 0001
    - 0002
    - 0003

### cgcloud\_\_Show\_Cash\_Info\_\_c

- **Type**: boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Show cash or expenses information in the tour summary report.
- **Default value**: false

### cgcloud\_\_Should\_Allow\_End\_Day\_Geofencing\_\_c

- **Type**: Boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Specifies whether the validation of the user's GPS location against warehouse location is enabled at the end of the day.
- **Default value**: false

### cgcloud\_\_Should\_Allow\_End\_Day\_GPS\_Tracking\_\_c

- **Type**: Boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Specifies whether GPS tracking is allowed at the end of the day.
- **Default value**: false

### cgcloud\_\_Should\_Allow\_End\_Day\_Time\_Tracking\_\_c

- **Type**: Boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Specifies whether end-of-day time tracking is allowed.
- **Default value**: false

### cgcloud\_\_Should\_Allow\_Seal\_Scanning\_\_c

- **Type**: Boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Specifies whether the user validates a list of seals through scanning or manual entry. This field is applicable only when the Express Check-Out field is selected.
- **Default value**: false

### cgcloud\_\_Should\_Allow\_Start\_Day\_Geofencing\_\_c

- **Type**: Boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Specifies whether the validation of the user's GPS location against warehouse location is enabled at the start of the day.
- **Default value**: false

### cgcloud\_\_Should\_Allow\_Start\_Day\_GPS\_Tracking\_\_c

- **Type**: Boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Specifies whether GPS tracking is allowed at the start of the day.
- **Default value**: false

### cgcloud\_\_Should\_Allow\_Start\_Day\_Time\_Tracking\_\_c

- **Type**: Boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Specifies whether the day and time tracking at the start of the day is allowed.
- **Default value**: false

### cgcloud\_\_Start\_Date\_Time\_\_c

- **Type**: dateTime
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: Last date and time of validity period of the tour.

### cgcloud\_\_Start\_Release\_Time\_\_c

- **Type**: dateTime
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: Stores the start release time.

### cgcloud\_\_Start\_Warehouse\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the warehouse.
    
    This field is a relationship field.
- **Relationship Name**: cgcloud\_\_Start\_Warehouse\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_Warehouse\_\_c

### cgcloud\_\_Status\_\_c

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
- **Description**: Current status of the tour.
- **Default value**: Open
- **Possible values**:
    - Canceled
    - Completed
    - Initial
    - Open
    - Running

### cgcloud\_\_Tour\_Template\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the tour template.
    
    This field is a relationship field.
- **Relationship Name**: cgcloud\_\_Tour\_Template\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_Tour\_Template\_\_c

### cgcloud\_\_Trailer\_1\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the truck with trailer. Reference to the vehicle.
    
    This field is a relationship field.
- **Relationship Name**: cgcloud\_\_Trailer\_1\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_Vehicle\_\_c

### cgcloud\_\_Trailer\_2\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the truck with second trailer. Reference to the vehicle.
    
    This field is a relationship field.
- **Relationship Name**: cgcloud\_\_Trailer\_2\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_Vehicle\_\_c

### cgcloud\_\_Truck\_Status\_End\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Specifies the type of damage observed after the tour finishes.
- **Possible values**:
    - Brakes—Brakes are Broken
    - Lights—Lights broken
    - Mirror—Wing mirror broken
    - Misc
    - Paint—Paint scratch
    - Tires—Flat tire
    - Vehicle—Vehicle damaged
    - Wash—Screenwash empty

### cgcloud\_\_Truck\_Status\_Start\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Specifies the type of damage observed before the tour starts.
- **Possible values**:
    - Brakes—Brakes are Broken
    - Lights—Lights broken
    - Mirror—Wing mirror broken
    - Misc
    - Paint—Paint scratch
    - Tires—Flat tire
    - Vehicle—Vehicle damaged
    - Wash—Screenwash empty

### cgcloud\_\_Truck\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the truck that carries out the tour. Reference to the vehicle.
    
    This is a relationship field.
- **Relationship Name**: cgcloud\_\_Truck\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_Vehicle\_\_c

### cgcloud\_\_Truck\_ok\_End\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Specifies whether the truck (and its trailers) have had any damage after finishing the tour.
- **Possible values**:
    - 0—No
    - 1—Yes

### cgcloud\_\_Truck\_ok\_Start\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Specifies whether the truck (and its trailers) had any damage before starting the tour.
- **Possible values**:
    - 0—No
    - 1—Yes

## Associated Objects

### Associated Objects

This object has these 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.

- **[cgcloud\_\_Tour\_\_cChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.")**: Change events are available for the object.
- **[cgcloud\_\_Tour\_\_cFeed](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")**: Feed tracking is available for the object.
- **[cgcloud\_\_Tour\_\_cHistory](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")**: History is available for the tracked fields of the object.
- **[cgcloud\_\_Tour\_\_cOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.")**: Sharing rules are available for the object.
- **[cgcloud\_\_Tour\_\_cShare](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")**: Sharing is available for the object.