cgcloud__Tour__c

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

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

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

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

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

• 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

• 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

• 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

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

• 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

• 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

• 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

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

• 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

• 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

• 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

• 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

• 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

• 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

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

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

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

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

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Reference to the description based on the user-specified language.

  This field is a calculated field.

• Formula:

  1CASE($User.cgcloud__Language_Postfix__c,
  2"Language1", cgcloud__Description_Language_1__c,
  3"Language2", BLANKVALUE(cgcloud__Description_Language_2__c,cgcloud__Description_Language_1__c),
  4"Language3", BLANKVALUE(cgcloud__Description_Language_3__c,cgcloud__Description_Language_1__c),
  5"Language4", BLANKVALUE(cgcloud__Description_Language_4__c,cgcloud__Description_Language_1__c),
  6cgcloud__Description_Language_1__c)

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

• 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

• 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

• 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

• 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

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

• 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

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

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

• 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

• 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

• 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

• 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

• 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

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

• 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

• 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

• 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

• 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

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

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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

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: Change events are available for the object.
• cgcloud__Tour__cFeed: Feed tracking is available for the object.
• cgcloud__Tour__cHistory: History is available for the tracked fields of the object.
• cgcloud__Tour__cOwnerSharingRule: Sharing rules are available for the object.
• cgcloud__Tour__cShare: Sharing is available for the object.

j

Get Started with Consumer Goods Cloud

Retail Execution

Standard Objects for Retail Execution

Associated Objects for Retail Execution

Custom Objects for Retail Execution

Standard DLO to DMO Mappings

Retail Execution Standard Metadata APIs

Retail Order Customization

Sync Management

Direct Store Delivery

Custom Objects for Direct Store Delivery

cgcloud__Route__c

cgcloud__Route_Template__c

cgcloud__Tour__c

cgcloud__Tour_Check__c

cgcloud__Tour_Object_Reference__c

cgcloud__Tour_Template__c

cgcloud__Tour_Template_Object_Reference__c

cgcloud__Tour_Template_Tour_Check__c

cgcloud__Tour_Tour_Check__c

cgcloud__Vehicle__c

cgcloud__Vehicle_Warehouse__c

cgcloud__Route_Account__c

Einstein Visit and Activity Recommendation

Trade Promotion Management

Custom Objects for Retail Execution and Trade Promotion Management

Standard and Custom Objects for Future Use

API End-of-Life Policy

Previous Versions