Before starting an upload, make sure you have read the information available in the Introduction to TDI and Importing data with TDI articles and followed the guidance provided.
Mandatory file:
Optional file:
- None
Prerequisites:
None, although any locations used for origin and destination must already exist in the system to use them here. The recommended sequence should be followed prior to uploading orders.
Fields bolded and marked with an asterisk (*) are mandatory.
File naming for Routing Guide files
The Routing Guide TDI entity is not limited to a single upload sheet for each file. A suffix can be added to each file name to distinguish the files for different guides and sequences from one another. However, they must begin with “routing_guide_” and “routing_sequence_,” respectively.
For example, you can add dates to the end of the file names, creating files named “routing_guide_25_04_2023.csv” and “routing_sequence_25_04_23.csv”
Filename: routing_guide.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| Id* | Unique system ID for the entity. This ID is used anytime you would like to make updates or changes to the order in TDI or when using TDI to associate additional details to the order. | If you do not have an existing ID to use in this field, you will need to create one. | Required | Important note: ID cannot have spaces. |
| origin_id | The starting location of the routing guide. |
Find the location’s ID in the ID column of the location.csv upload sheet. If your tenant has ID generalization enabled, you can enter the ID number listed after the origin location’s name in its profile page on your tenant. |
An origin location is required. Enter one using one of the following combinations of columns:
|
No character restrictions. |
| origin_city | The routing guide’s origin city. | - | Enter the city name. Only one origin city can be entered. | |
| origin_state | The routing guide’s origin state. | - |
Enter the name or two letter state abbreviation. Only one origin state can be entered. Examples: “CA” or “California” |
|
| origin_country | The routing guide’s origin country. | Find the country code in the Country Codes table. | Only one origin country can be entered. | |
| origin_zip | The routing guide’s origin zip code. | - |
Must be a valid zip code. Only one origin zip can be entered. |
|
| destination_id | The ending location of the routing guide. |
Find the location’s ID in the ID column of the location.csv upload sheet. If your tenant has ID generalization enabled, you can enter the ID number listed after the destination location’s name in its profile page on your tenant. |
A destination location is required. Enter one using one of the following combinations of columns:
|
No character restrictions. |
| destination_city | The routing guide’s destination city. | - | Enter the city name. Only one destination city can be entered. | |
| destination_state | The routing guide’s destination state. | - |
Enter the name or two letter state abbreviation. Examples: “CA” or “California” Only one destination state can be entered. |
|
| destination_country | The routing guide’s destination country. | Find the country code in the Country Codes table. |
Enter a country code listed in the Values/codes column to the left. Only one destination country can be entered. |
|
| destination_zip | The routing guide’s destination zip code. | - |
Must be a valid zip code. Only one destination zip can be entered. |
|
| startDate* | Beginning date of the routing guide. | - |
Required The start date must be today’s date or a date in the future. You cannot set up routing guides retroactively. |
Format: YYYY-MM-DD |
| endDate* | Ending date of the routing guide. | - | Required | Format: YYYY-MM-DD |
| account | Customer account ID associated with the Item. |
Find the account ID for the Customer in the ID column of the customer.csv upload sheet. If your tenant has ID generalization enabled, you can enter the ID number listed after the customer’s name in its account page on your tenant. |
- | No character restrictions. |
| equipment | The type of equipment required on the order. | Find the equipment type code in the Equipment type codes table. | - | Use the table linked in the Values/codes column to find the appropriate equipment type. |
| status* | The status of the routing guide. | Active / Inactive | Required | Enter one of the values listed in the Values/codes column to the left. |
| mode* | The shipment mode that is applicable to the routing guide. | TL: 24105 Intermodal: 24109 |
Required | Enter one of the five-digit codes listed in the Values/codes column to the left for the mode applicable to the routing guide. |
| service | The level of service for the shipment mode that is applicable to the routing guide. |
Standard: 24338 Expedite: 24349 Any: 24304 |
- | Enter one of the five-digit codes listed in the Values/codes column to the left for the service level applicable to the routing guide. |
| is_hazmat | Indicates whether the routing guide applies to shipments containing hazardous materials. | true / false | - | Enter “true” or “false”. |
| low_cost_precedence | Controls whether low cost precedence is used for the routing guide. | true / false | - | Enter “true” or “false”. |
Filename: routing_sequence.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| Id* | Unique system ID for the entity. This ID is used anytime you would like to make updates or changes to the order in TDI or when using TDI to associate additional details to the order. | If you do not have an existing ID to use in this field, you will need to create one. | Required | Important note: ID cannot have spaces. |
| contextId* | The reference ID for the respective routing guide. | These IDs are found in the Id column of the routing_guide.csv upload sheet. | Required | No character restrictions. |
| offerType* | Identifies the type of offer being added to the routing guide sequence. | CARRIER_OFFER POSTING CONTRACTED_RATE GLOBAL_RATE |
Required | Enter one of the values listed in the Values/codes column to the left. |
| carrierId | The Carrier ID for the carrier associated with the route sequence. |
Carrier IDs can be found in the ID column of the carrier.csv upload sheet. If your tenant has ID generalization enabled, you can enter the ID number listed after the carrier’s name in its account page on your tenant. |
Required if the offerType column is set to CARRIER_OFFER, GLOBAL_RATE, or POSTING. Required if the routing sequence is not being posted to the network. Required if you did not enter a carrierScac. |
No character restrictions. Use the table linked in the Value/codes column to find the appropriate carrier ID. |
| carrierScac | The SCAC ID of the carrier associated with the routing sequence. | - | Required if you did not enter a carrierID. |
Only a single SCAC is applicable. Important note: ID cannot have spaces. |
| carrierEmail | Email address for the carrier. | - | - | No character restrictions. |
| rate* | Offer amount for the routing guide sequence. | - | Required | Only numbers are allowed. |
| offerDuration* | The amount of time the offer will sit with the carrier before moving on to the next offer in the routing sequence. |
Time is measured in minutes for this duration. Turvo defaults to 30 minutes. |
Required |
Only numbers are allowed. |
| shareTo | Identifies the locations the offer is posted to. |
its dat network |
Required if the offerType column is set to POSTING. |
List each posting location with only commas separating the list. "its,dat,network" |
| contractId | This custom ID associates the routing guide with a contract. | - | Required if the offerType column is set to GLOBAL_RATE or CONTRACTED_RATE. | No character restrictions. |
| contractItemId | This custom ID associates the routing guide with a contract item. | - | Required if the offerType column is set to GLOBAL_RATE or CONTRACTED_RATE. | No character restrictions. |
<%= heading %>