Delivery Schedule ID: The ID of the delivery schedule for the itinerary.
Description: The description of the delivery schedule.
Itinerary ID: A unique identifier for the itinerary within a delivery schedule. It is user-assigned, mandatory and cannot be modified after an itinerary has been created.
Description: User maintainable description for the itinerary. It is mandatory. It can be modified in Update mode.
Status: The status for the itinerary. Maintained using operations from List of Itineraries. Possible values are: Active, Inactive.
Details
Primary Itinerary: For Delivery Schedules where Allow Multiple Itineraries is selected, scheduling uses exactly one itinerary where Primary Itinerary is selected. This field is typically true for the itineraries that represent the primary transit mode for the delivery schedule. If selected, the Itinerary Scheduling Method must be defined as Timetable.
Itinerary Scheduling Method: The scheduling method for the itinerary. Possible values are: Timetable and Distance Engine.
Distance Engine: Override distance engine for the itinerary. Applicable only when scheduling method for the itinerary is Distance Engine. This supersedes the override distance engine defined at tariff level. If override distance engine is not specified for tariff or itinerary, distance engine scheduling uses the default distance engine version for the applicable country or countries.
Transit Mode: The transit mode for the itinerary. You can edit this value only when Allow Multiple Itineraries for the delivery schedule is selected.
Team Driver: Indicates whether team drivers are used for loads handled using this itinerary. This supersedes the setting in tariff service. If not defined, scheduling uses the team driver flag from tariff service. This can be defined only when Itinerary Scheduling Method is Distance Engine.
Weekend/Holiday Scheduling Control: Determines whether business hours (including holidays) for this itinerary are considered during scheduling. This supersedes the setting in tariff service. If not defined, scheduling uses the weekend / holiday scheduling control from the tariff service. This can be defined only when Itinerary Scheduling Method is Distance Engine.
Timetable
Timetable ID: The ID of the timetable for this itinerary. Optional. The number of itinerary points must be compatible with the number of timetable entries.
Number of Itinerary Points: The count of itinerary points for the itinerary. Cannot be maintained directly.
Itinerary Points
This section contains an editable grid that can be used to define the individual points on the itinerary. Each itinerary point will be defined by the following columns:
Description: User maintainable description for the itinerary point. It is mandatory. It can be modified in Update mode.
Itinerary Point Type: Must be either Zone or one of the four possible shipping location types: Load-At, Consignee, Hub, Distribution Center. Mandatory. Can be modified in Update mode.
Itinerary Point ID: If Itinerary Point Type is Zone, this must refer to a valid zone. Otherwise, the Itinerary Point Type and Itinerary Point ID must together refer to a valid shipping location.