Contract Stop Import Wizard

Owned by Michelle Cabaya (Unlicensed)
May 13, 2022
6 min read

The Contract Stop Import Wizard allows you to import contract route stops directly to an X Route contract, set the schedule for the stops, and specify the assigned route.

How to Use the Contract Stop Import Wizard

  1. Go to X Route > Contracts. 

  2. Double-click the customer contract you would like to import the contract stops to.
  3. In the top left of the Edit Contract form go to File > Import Stops. 

  4. Choose the .csv file you would like to import. 

  5. If you have an import specifications file (.def file) you would like to use click the Load Import Specifications button.

  6. If your file has a header row, make sure that the box is checked and click the Next button. By default, the Text Qualifier is set to "Double Quote" which should work for most imports, but you can change this accordingly to match your document. 

  7. Select the delimiter. This is usually a comma. 

  8. Check that the data that will be imported looks correct and click the Next button.

  9. Set default data and check that the columns are mapped correctly then click next. 


    Quick Tip

    See Specify Column Mappings below for TargetField descriptions.

  10. If you would like to save your default specifications to use in future imports (step 5) click the Save Import Specifications button.

  11. Click the Finish button.


Specify Column Mapping

Field NameDescription
Billing GroupThe billing group from the customer form.
GroupIDThe group folder ID the stop should go to in route planning. 
RouteIDRoute ID to assign the stop to. If left blank the stop will go to unassigned.
SequenceThe order in which the stop will show up on the route. This value can be between 0 and 2,147,483,647.
OverRideCommissions

Whether or not to override commissions. If left blank, this will default to 0 (No).

  • 0 - No
  • 1 - Yes
NameAddress Name. 50 character limit.
AddressThe address for the stop. 50 character limit.
CityThe city for the stop. 50 character limit.
StateThe state of the stop. 3 character limit
ZipThe zip code for the stop. 5 character limit.
Plus4The plus for of the zip code. 4 character limit.
PhoneThe contact phone number for the stop has a 50 character limit.
AttnThe Attn field has a 50 character limit.
LongRemarksLong remarks for the stop. There is a 200 character limit.
ShortRemarksShort remarks for the stop. There is a 200 character limit.
StopType

Specified stop type for the stop. This cannot have a NULL value.

  • 0 - Pickup
  • 1 - Delivery
  • 2 - Exchange
  • 3 - Meet
  • 4 - Flight
  • 5 - Start
  • 6 - End
PiecesThe number of pieces on the stop. This cannot have a NULL value.
WeightThe total weight of pieces on the stop. If left blank it will default to 1. This cannot have a NULL value.
ParcelType

The parcel type ID.

Reference1References for the stop. There is a 50 character limit. It cannot have a NULL value but can be left blank.
Reference2
RatePerOccurrenceThe dollar amount to charge the customer for this stop.
SettlementPerOccurranceThe dollar amount to pay the driver for this stop if using a per stop pay method.
NotesNotes for the stop. There is a 2000 character limit. It cannot have a NULL value but can be left blank.
StopTimeMin

Min stop time entered in military time (XX:XX). If left blank, it will default to 22:00.

Example

Enter 16:00 for 4:00PM.

StopTimeMax

Max stop time entered in military time (XX:XX). If left blank, it will default to 22:00.

Example

Enter 16:00 for 4:00PM.

StopTimePreferred

Preferred stop time entered in military time (XX:XX). If left blank, it will default to 22:00.

Example

Enter 16:00 for 4:00PM.

ChildOfThe Load To Stop ID if using Stop Chaining. (Downstream)
DescriptionDescription for the stop. There is a 250 character limit. It cannot have a NULL value but can be left blank.
RateMultiplierAmount of times to multiply the per stop charge for this stop. This can be a decimal number.
DepotThe ID for the depot for the stop.
LatLatitudinal point for the address.
LonLongitudinal point for the address.
RouteSurchargeAdjustmentThe numeric dollar amount of the route surcharge adjustment, or enter 0 for no adjustments. This will default to 0.00 if left blank.
CreatedByThe User ID of the person performing the import.
CreatedWhenThe date and time of the import.
UpdatedByThe User ID of the person performing the import if updating contract stops that already exist.
UpdatedWhenThe date and time if updating contract stops that already exist.
UserField1User fields.
UserFeild2
UserField3
UserFeild4
UserFeidl5
UserFeild6
ParentStopIDThe Load From Stop ID if using Stop Chaining. (Upstream) 
PostActive

Whether or not a post is active. If left blank, the stop will post as "Active" by default.

  • 1 - Post as active
  • 0 - Post as inactive
ETAThis should be left blank/NULL. 
MinOffSet

Offset for StopTimeMin in days.

Example

1=1day, 2=2days and so on. use 1 and it will put the StopMintime to the next day

MaxOffSet

Offsets for StopTimeMax in days.

Example

1=1day and it will put the StopmaxTime to the next day.

PreferredOffSetOffsets for StopTimePreferred
LoadStop

This will mark a stop as the load stop for the route. This is best left as 0 value and assigned when placed on the route

  • 0 - All Other Scenarios
  • 1 - Customer Load Stop or Global Load Stop (depending on additional setting below)
GlobalLoadStop

Whether or not to mark a stop as a global load stop for the route.

  • 0 - All Other Scenarios
  • 1 - Global Load Stop
Return Stop

Whether or not to mark a stop as the return stop for the route. 

  • 0 - All Other Scenarios
  • 1 - Return Stop or Global Return Stop
GlobalReturnStop

Whether or not to mark the stop as a global return stop for the route.

  • 0 - All Other Scenarios
  • 1 - Global Return Stop
XMobileSecondaryLookup

Barcode information for the secondary lookup. There is a 50 charachter limit and this can be NULL or left blank.

Example

$cxt1234test$ (The barcode prefix and suffix may differ depending on your set up.)

CustomerStopIDReference stop ID.
CustomerAccountIDCustomer account ID to reference this stop/route/location.
IsParent

Whether or not the stop is a parent stop.

  • 0 - Is a parent stop
  • 1 - Is not a parent stop
ParentStop

The parent stop ID.

This parent/child relationship can be used for activating or deactivating posted routes on the dispatch board.  If the parent is marked as inactive, any children will also be marked inactive, and if the parent is marked as active, all of the associated children stops will be activated.

This is not for route/parcel chaining. Please see ParentStopID and ChildStopID above for route /parcel chaining.

Sun

Whether or not to post on the day of the week.

  • 0 - Will not post on this day
  • 1 - Post on this day
Mon
Tue
Wed
Thu
Fri
Sat
StartDateThe date you would like this stop to begin posting
EndDateThe date that you would like this stop to end posting

Troubleshooting

This error means that there is a required field that was left blank.


This error means that there is a field missing a required value.