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 files:
- route.csv
- customerOrder.csv
- otherAccount.csv
- carrierOrder.csv
- equipment.csv
- externalIds.csv
- items.csv
- costs.csv
- contacts.csv
- invoice.csv
- payment.csv
- deduction.csv
Prerequisites:
Customers and Locations are required. The recommended sequence should be followed prior to uploading shipments.
Fields bolded and marked with an asterisk (*) are mandatory.
Formatting:
The following standard formatting should be used in all TDI entity files.
UTC Date & Time
Date columns ending in “- UTC” should include the date in “YYYY-MM-DD,” as well as the time of the pickup/delivery appointment in Coordinated Universal Time (UTC), which is also known as “Zulu time”. The time is formatted to the millisecond as HH:MM:SS.SS, using the 24 hour UTC clock. This should correspond to UTC and not the local time at the delivery location. Using a timezone calculator to transpose from the local time to UTC is recommended.
Finally, a “T” comes between the date and time, and a “Z” follows the time.
For example, a delivery date of August 25th, 2022, at 12PM US Central Daylight Time would be 1700 UTC. Therefore, the date should be formatted as, “2022-08-25T17:00:00.00Z”.
Local Date & Time
Date columns ending in “- LT” use the YYYY-MM-DD HH:MM:SS.SS format.
Local date and time fields are given priority. For example, if both the pickupApptStart - UTC and pickupApptStart - LT columns are filled in for the same shipment, the date and time listed in the pickupApptStart - LT column is used.
Note: All local date & time fields support adding only the date, using the YYYY-MM-DD format.
IDs
IDs cannot have spaces.
Any column where multiple IDs are listed, such as adding codes from a lookup table, should have the IDs separated by commas only. For example, two equipment service codes might be listed as, “21206,21203”.
Filename: shipment.csv
| Field | Descriptions | Values/codes | Conditions | Format/Restrictions |
| id* |
The unique system ID for a Shipment. This ID is used anytime you would like to make updates or add details to the shipment in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| customId | The shipment’s primary ID number, displayed in the shipment header in Turvo. | - | - | IDs cannot have spaces. Otherwise, no character restrictions. |
| transportation.mode | Indicates the mode of transport for the shipment. |
|
Any additional transportation modes used in shipments with multiple route legs are configured in the optional route.csv file. | Enter the primary mode of the shipment using the values in the Value/codes column. |
| transportation.type |
Indicates the service type, specific to the mode selected. "Any" is applied to the shipment if no service type is entered. |
The primary service types are found in the Transportation type codes by mode table. | Additional service types for shipments with multiple route legs are configured in the optional route.csv file. | Enter the name of the service type. |
| equipment.type | Indicates the equipment type needed to transport the shipment. | Equipment type codes are found in the Equipment type codes table. | If a shipment contains multiple assets, equipment types for additional assets are configured in the equipment.csv file. | Enter the four- or five-digit code. |
| equipment.size | Indicates the size of equipment needed. | Equipment size codes are found in the Equipment size codes table. | If a shipment contains multiple assets, equipment sizes for additional assets are configured in the equipment.csv file. | Enter the four-digit code. |
| equipment.temp |
The operating temperature of equipment. Units of measure are automatically selected based on your tenant’s locale. |
- | If a shipment contains multiple assets, equipment operating temperatures for additional assets are configured in the equipment.csv file. | Number with decimals allowed. |
| equipment.weight |
The weight of the equipment. Units of measure are automatically selected based on your tenant’s locale. |
- | If a shipment contains multiple assets, the weights of additional equipment are configured in the equipment.csv file. | Integers only. |
| equipment.description | A free form text field where a description of the equipment can be entered. | - | Equipment descriptions for shipments with multiple assets are configured in the equipment.csv file. | No character restrictions. |
| services | Additional services that need to be provided with the equipment. | Equipment service codes are found in the Equipment Service codes table. | If a shipment contains multiple assets, any services associated with additional assets are configured in the equipment.csv file. | Enter the codes with a comma between each. “[21206,21203]”. |
| routeStart.id | A unique ID that identifies the route’s starting pickup location. | - |
If there is a pickup location provided in the pickup column, this column is required. If no pickup location is provided, these columns can be left blank. If there are multiple stops, leave both columns blank and configure the route in the optional route.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| pickup | The Location ID for the pickup location. | Location IDs are found in the ID column of the location.csv upload sheet. |
If there is a pickup location provided in this column, the routeStart.id column is required. If no pickup location is provided, these columns can be left blank. If there are multiple stops, leave both columns blank and configure the route in the optional route.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| pickupTimezone | Indicates the timezone of the shipment's pickup location. | - |
If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure the timezones for each stop on the route in the optional route.csv file. |
No character restrictions. "America/Los_Angeles" |
| pickupContact | The Contact ID associated with the pickup location. | Contact IDs are found in the ID column of the contact.csv upload sheet. |
If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure the primary contact for each stop on the route in the optional route.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| pickupServices | Additional services required at the stop. | Service codes are found in the Pickup service codes table. |
If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure the pickup services for each stop on the route in the optional route.csv file. |
Find the correct code(s) and enter them with a comma between each. “[21301,21203]”. |
| pickupScheduling | Indicates the type of scheduling for the pickup location. |
FCFS / FCFS: 9400 By appointment: 9401 |
If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure the scheduling type for each stop on the route in the optional route.csv file. |
Enter the code for First come, first served (FCFS) or By appointment. |
| pickupNo | A unique ID that identifies the planned pickup stop. | - |
If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure the reference ID for each stop on the route in the optional route.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions.
|
| pickupApptNo | The appointment number used to refer to the appointment at the pickup location. | - |
If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure the appointment number for each stop on the route in the optional route.csv file. |
No character restrictions. |
| pickupApptStart - UTC | The pickup location’s appointment start date and time. This is the local time for the pickup location, using the timezone indicated in the pickupTimezone column, transposed to UTC. | - |
If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure the appointment start times for each stop on the route in the optional route.csv file. |
Formatted as described in the UTC Date & Time description above. |
| pickupApptEnd - UTC | The pickup location’s appointment end time. This is the local time for the pickup location, using the timezone indicated in the pickupTimezone column, transposed to UTC. | - |
If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure the appointment end times for each stop on the route in the optional route.csv file. |
Formatted as described in the UTC Date & Time description above. |
| pickupApptStart - LT | The pickup location’s appointment start date and time, using the local timezone for the pickup location. | - |
If both the UTC and LT pickupApptStart columns are filled, then this column is used. If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure the appointment start times for each stop on the route in the optional route.csv file. |
Formatted as described in the Local Date & Time description above. |
| pickupApptEnd - LT | The pickup location’s appointment end date and time, using the local timezone for the pickup location | - |
If both the UTC and LT pickupApptEnd columns are filled, then this column is used. If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure the appointment end times for each stop on the route in the optional route.csv file. |
Formatted as described in the Local Date & Time description above. |
| pickupNotes | A free form text field where any notes for the pickup location should be added. | - |
If no pickup location is provided, leave this column blank. If there are multiple stops, leave blank and configure notes for each stop on the route in the optional route.csv file. |
No character restrictions. |
| routeEnd.id | A unique ID that identifies the route’s delivery location. | - |
If there is a delivery location provided in the delivery column, this column is required. If no delivery location is provided, these columns can be left blank. If there are multiple stops, leave blank and configure the route in the optional route.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| delivery | The Location ID for the delivery location. | Location IDs are found in the ID column of the location.csv upload sheet. |
If there is a delivery location provided in this column, the routeEnd.id column is required. If no delivery location is provided, these columns can be left blank. If there are multiple stops, leave both columns blank and configure the route in the optional route.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| deliveryTimezone | Indicates the timezone of the shipment delivery location. | - |
If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure the timezones for each stop on the route in the optional route.csv file. |
No character restrictions. "America/Los_Angeles" |
| deliveryContact | The Contact ID for the primary contact associated with the delivery location. | Contact IDs are found in the ID column of the contact.csv upload sheet. |
If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure the primary contact for each stop on the route in the optional route.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| deliveryServices | Indicates any additional services required at the stop. | Service codes are found in the Delivery service codes table. |
If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure the delivery services for each stop on the route in the optional route.csv file. |
Find the correct code(s) and enter them with a comma between each. “[21301,21203]”. |
| deliveryScheduling | Indicates the type of scheduling for delivery appointments. |
FCFS / FCFS: 9400 By appointment: 9401 |
If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure the scheduling type for each stop on the route in the optional route.csv file. |
Enter the code for First come, first served (FCFS) or By appointment. |
| deliveryNo | A unique ID that identifies the planned delivery stop. | - |
If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure the reference ID for each stop on the route in the optional route.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| deliveryApptNo | The appointment number used to refer to the appointment at the delivery location. | - |
If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure the appointment number for each stop on the route in the optional route.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| deliveryApptStart - UTC | The delivery location’s appointment start time. This is the local time for the delivery location, using the timezone indicated in the deliveryTimezone column, transposed to UTC. | - |
If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure the appointment start times for each stop on the route in the optional route.csv file. |
Formatted as described in the UTC Date & Time description above. |
| deliveryApptEnd - UTC | The delivery location’s appointment end time. This is the local time for the delivery location, using the timezone indicated in the deliveryTimezone column, transposed to UTC. | - |
If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure the appointment end times for each stop on the route in the optional route.csv file. |
Formatted as described in the UTC Date & Time description above. |
| deliveryApptStart - LT | The delivery location’s appointment start date and time, using the local timezone for the delivery location | - |
If both the UTC and LT deliveryApptStart columns are filled, then this column is used. If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure the appointment start times for each stop on the route in the optional route.csv file. |
Formatted as described in the Local Date & Time description above. |
| deliveryApptEnd - LT | The delivery location’s appointment end date and time, using the local timezone for the delivery location | - |
If both the UTC and LT deliveryApptEnd columns are filled, then this column is used. If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure the appointment end times for each stop on the route in the optional route.csv file. |
Formatted as described in the Local Date & Time description above. |
| deliveryNotes | A free form text field where any notes for delivery should be added. | - |
If no delivery location is provided, leave this column blank. If there are multiple stops, leave blank and configure notes for each stop on the route in the optional route.csv file. |
No character restrictions. |
| group | The Group ID associated with the shipment. | Group IDs are found in the ID column of the group.csv upload sheet. | - | IDs cannot have spaces. Otherwise, no character restrictions. |
| status* | The status of the shipment. | Shipment status codes are found in the Shipment Status codes table. | Required | Find the correct code to enter the shipment’s status. |
| minPay | The minimum margin payable for the shipment. | - | - | Number with decimals allowed. |
| maxPay | The maximum margin payable for the shipment. | - | - | Number with decimals allowed. |
| tags | Tags associated with the shipment. These are tenant-specific. An API retrieves the codes on your tenant. | - | - | Codes with a comma between each. “[23,24]”. |
| customerOrder | The Order ID for the customer order associated with the shipment. | Order IDs are found in the ID column of the order.csv upload sheet. |
If a customer ID is provided in the customer column, this column is required. If a shipment is associated with multiple customer orders, leave blank. Order IDs for shipments with multiple customer orders are configured in the customerOrder.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| customer | The Customer ID for the shipment’s customer. | Customer IDs are found in the ID column of the customer.csv upload sheet. |
If a customer ID is provided in the customer column, the customerOrder column is required. If a shipment is associated with multiple customers, leave blank. Customer IDs for shipments with multiple customers are configured in the customerOrder.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| customerExternalId | The type of order ID the customer uses to track shipments. | Customer external order ID type codes are found in the Customer External Order ID Type codes table. |
If a shipment is associated with multiple customer external IDs, leave blank. External ID types for shipments with multiple customer external IDs are configured in the customerOrder.csv file. |
Use the table linked in the Value/codes column. Find and enter the ID type. |
| customerExternalIdValue | The customer’s external ID for the shipment. | Corresponds to the ID type indicated in the customerExternalId column. (e.g., if PO number, then enter the PO number associated with the shipment). | If a shipment is associated with multiple customer external IDs, leave blank. The External IDs for shipments with multiple customer external IDs are configured in the customerOrder.csv file. | No character restrictions. |
| customerCostType | The type of cost incurred by and charged to the customer. | Cost type codes are found in the Cost type codes table. | If a shipment has multiple customer cost items, leave blank. Customer costs are configured in the costs.csv file. | Find and enter the cost type’s code. |
| customerCostQty | The quantity of the cost type indicated in the customerCost column. | - | If a shipment has multiple customer cost items, leave blank. Customer costs are configured in the costs.csv file. | Integers only. |
| customerCostPrice | The price per unit of the cost type indicated in the customerCost column. | - | If a shipment has multiple customer cost items, leave blank. Customer costs are configured in the costs.csv file. | Number with decimals allowed. |
| customerCostAmount | The price per unit multiplied by the quantity of cost units. | - | If a shipment has multiple customer cost items, leave blank. Customer costs are configured in the costs.csv file. | Number with decimals allowed. |
| customerCostNotes | Notes to attach to the customer cost. | - | If a shipment has multiple customer cost items, leave blank. Customer costs are configured in the costs.csv file. | No character restriction. |
| customerContact | The Contact ID associated with the customer. | Contact IDs are found in the ID column of the contact.csv upload sheet. | If multiple customer contacts are associated with a shipment, leave blank. Customer contacts for the shipment are configured in the contacts.csv file. | IDs cannot have spaces. |
| customerContactRole | The role of the customer contact identified in the customerContact column. | Contact role codes are found in the Contact role codes table. |
Required if a customer contact is provided. If multiple customer contacts are associated with a shipment, leave blank. The roles for each of the shipment's customer contacts for the shipment are configured in the contacts.csv file. |
Find the correct code to enter the contact’s role. |
| carrierOrder | The Order ID for the carrier order associated with the shipment. | Order IDs are found in the ID column of the order.csv upload sheet. |
If a carrier ID is provided in the carrier column, this column is required. If a shipment is associated with multiple carrier orders, leave blank. Order IDs for shipments with multiple carrier orders are configured in the carrierOrder.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| carrier | The Carrier ID for the shipment’s carrier. | Carrier IDs are found in the ID column of the carrier.csv upload sheet. |
If an ID is provided in this column, the carrierOrder column is required. If a shipment is associated with multiple carriers, leave blank. Carrier IDs for shipments with multiple carriers are configured in the carrierOrder.csv file. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| carrierExternalId | The type of order ID the carrier uses to track shipments. | Carrier external order ID type codes are found in the Carrier external order ID type codes table. | If a shipment is associated with multiple carrier external IDs, leave blank. The external ID types for shipments with multiple carrier external IDs are configured in the carrierOrder.csv file. | Find the correct code to enter the ID type the carrier uses for orders. |
| carrierExternalIdValue |
The carrier’s external ID for the shipment, corresponding to the ID type indicated in the carrierExternalId column. (e.g., if PO number, then enter the PO number associated with the shipment). |
- | If a shipment is associated with multiple carrier external IDs, leave blank. The external IDs for shipments with multiple carrier external IDs are configured in the carrierOrder.csv file. | IDs cannot have spaces. Otherwise, no character restrictions. |
| carrierCostType | The type of cost charged by the carrier. | Cost type codes are found in the Cost type codes table. | If a shipment has multiple carrier cost items, leave blank. Carrier costs are configured in the costs.csv file. | Find the correct code to enter the cost type. |
| carrierCostQty | The quantity of the cost item indicated in the carrierCost column. | - | If a shipment has multiple carrier cost items, leave blank. Carrier costs are configured in the costs.csv file. | Integers only. |
| carrierCostPrice | The price per unit of the cost type indicated in the carrierCost column. | - | If a shipment has multiple carrier cost items, leave blank. Carrier costs are configured in the costs.csv file. | Numbers with decimals allowed. |
| carrierCostAmount | The price per unit multiplied by the quantity of units. | - | If a shipment has multiple carrier cost items, leave blank. Carrier costs are configured in the costs.csv file. | Numbers with decimals allowed. |
| carrierCostNotes | Notes to attach to the carrier cost. | - | If a shipment has multiple carrier cost items, leave blank. Carrier costs are configured in the costs.csv file. | No character restrictions. |
| carrierContact | The Contact ID associated with the carrier. | Contact IDs are found in the ID column of the contact.csv upload sheet. | If multiple carrier contacts are associated with a shipment, leave blank. Carrier contacts for the shipment are configured in the contacts.csv file. | IDs cannot have spaces. Otherwise, no character restrictions. |
| carrierContactRole | The role of the carrier contact identified in the carrierContact column. | Contact role codes are found in the Contact role codes table. |
Required if a carrier contact is provided. If multiple carrier contacts are associated with a shipment, leave blank. The roles for each of the shipment's carrier contacts are configured in the contacts.csv file. |
Find the correct code to enter the contact’s role. |
| user_routing_guide | Flags whether a shipment uses automatic routing. |
True False |
Enter “True” to trigger automatic routing for the shipment and “False” to leave the shipment out of the automatic routing guide. | Use the values in the Value/codes column. |
Optional files:
Filename: route.csv
| Field | Description | Values/codes | Conditions | Format/Restrictions |
| id* |
The unique system ID for a route leg associated with a shipment. This ID is used anytime you would like to make updates or add details to the route leg in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The unique ID for the shipment associated with the route. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| customer.id* | The Customer ID for the customer associated with the route. | Customer IDs are found in the ID column of the customer.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| carrier.id | The Carrier ID for the carrier associated with the route. | Carrier IDs are found in the ID column of the carrier.csv upload sheet. | - | IDs cannot have spaces. Otherwise, no character restrictions. |
| location.id* | The Location ID for the stop. | Location IDs are found in the ID column of the location.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| contact.id | The Contact ID associated with the stop location. | Contact IDs are found in the ID column of the contact.csv upload sheet. | - | IDs cannot have spaces. Otherwise, no character restrictions. |
| legSequence* | Indicates the sequence of route legs for the shipment. | - | Required | Integers only. The first route leg is “0”. The next route leg is “1”, etc. |
| sequence* | Indicates the sequence for stops within a route leg. Multiple pickup and delivery stops can be in the same route leg. | - | Required | Integers only. The first pickup location is “0”. The next stop is “1”, etc. |
| timezone* | timezone of the location linked to the stop. | - | Required | No character restrictions. "America/Los_Angeles" |
| services | Enter codes for any additional services required at the stop. | Pickup and delivery service codes are found in the Pickup/Delivery service codes table. | Find the correct code(s) and enter them with a comma between each. “[21301,21203]”. | |
| stopType | Indicates whether the stop is a pickup or delivery. |
Pickup: 1500 Delivery: 1501 |
Required | Enter the code for pickup or delivery. |
| schedulingType* | Indicates the type of scheduling for pickup/delivery appointments. |
FCFS / FCFS: 9400 By appointment: 9401 |
Required | Enter the code for First come, first served (FCFS) or By appointment. |
| poNumbers | The pickup or delivery numbers associated with the stop. | - | - | No character restrictions. |
| appointment.number | The appointment numbers associated with the stop. | - | - | No character restrictions. |
| appointment.start - UTC | The appointment’s start date and time in UTC. | This is the local time for the stop location, using the time zone indicated in the timezone column, transposed to UTC. |
If no appointment is needed for the stop, leave this column blank. If the stop’s scheduling type is By appointment, an appointment start date/time is required. |
Formatted as described in the UTC Date & Time description above. |
| appointment.end - UTC | The appointment’s end date and time in UTC. | This is the local time for the stop location, using the time zone indicated in the timezone column, transposed to UTC. |
If no appointment is needed for the stop, leave this column blank. If the stop’s scheduling type is By appointment, an appointment end date/time is required. |
Formatted as described in the UTC Date & Time description above. |
| appointment.start - LT | The delivery location’s appointment start date and time, using the local timezone for the delivery location | - |
If both the UTC and LT appointment.start columns are filled, then this column is used. If no appointment is needed for the stop, leave this column blank. If the stop’s scheduling type is By appointment, an appointment start date/time is required. |
Formatted as described in the Local Date & Time description above. |
| appointment.end - LT | The delivery location’s appointment end date and time, using the local timezone for the delivery location | - |
If both the UTC and LT appointment.end columns are filled, then this column is used. If no appointment is needed for the stop, leave this column blank. If the stop’s scheduling type is By appointment, an appointment end date/time is required. |
Formatted as described in the Local Date & Time description above. |
| notes | A free form text field where any notes on the route leg should be added. | - | - | No character restriction. |
| carrierOrder.id | The Order ID for the carrier order associated with the shipment. | Carrier Order IDs are found in the ID column of the carrierOrder.csv upload sheet. | - | IDs cannot have spaces. Otherwise, no character restrictions. |
| customerOrder.id | The Order ID for the customer order associated with the shipment. | Customer Order IDs are found in the ID column of the customerOrder.csv upload sheet. | - | IDs cannot have spaces. Otherwise, no character restrictions. |
| transportation.mode* | Indicates the mode of transport for the route leg. |
|
Required. All stops in a route leg should have the same mode. |
Enter the name of the route leg's mode, using the Value/codes column. |
| transportation.type* |
Indicates the service type associated with the route leg. "Any" is applied to the shipment if no service type is entered. |
Transportation service types are found in the Transportation type codes by mode table. |
Required. All stops in a route leg should have the service type. |
Enter the name of the route leg’s service type for the shipment. |
Filename: customerOrder.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for a customer order associated with a shipment. This ID is used anytime you would like to make updates or add details to the customer order in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The unique ID for the shipment. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| customer.id* | The Customer ID for the shipment customer. | Customer IDs are found in the ID column of the customer.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| accountOwner.id | The User ID for the customer’s account owner. | User IDs are found in the ID column of the user.csv upload sheet. | - | IDs cannot have spaces. Otherwise, no character restrictions. |
| enableSharing | Allows sharing of the shipment with the customer, so long as sharing is enabled for the customer account. |
True False |
Enter "True" to enable sharing or "False" to keep sharing disabled. | - |
Filename: otherAccount.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for an account associated with a shipment that is not a carrier or customer. This ID is used anytime you would like to make updates or add details to the other account in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The unique ID for the shipment. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| account.id* | The Other Account ID for the account. | Other Account IDs are found in the ID column of the otherAccount.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
Filename: carrierOrder.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for a carrier order associated with a shipment. This ID is used anytime you would like to make updates or add details to the carrier order in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The unique ID for the shipment. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| carrier.id* | The Carrier ID for the shipment’s carrier. | Carrier IDs are found in the ID column of the carrier.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| accountOwner.id | The User ID for the carrier’s account owner. | User IDs are found in the ID column of the user.csv upload sheet. | - | No character restrictions. |
| enableSharing | Allows sharing of the shipment with the carrier, so long as sharing is enabled for the carrier account. |
True False |
Enter "True" to enable sharing or "False" to keep sharing disabled. |
- |
Filename: externalIds.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for an external ID used by a shipment. This ID is used anytime you would like to make updates or add details to the external ID in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The Shipment ID for the shipment associated with the external ID. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| customerOrder.id | The Order ID for the customer order associated with the external ID. | Customer Order IDs are found in the ID column of the customerOrder.csv upload sheet. | Required if the external ID is associated with a Customer order. | IDs cannot have spaces. Otherwise, no character restrictions. |
| otherAccount.id | The Other account ID for the account associated with the external ID. | Other Account IDs are found in the ID column of the otherAccount.csv upload sheet. | Required if the external ID is associated with an Other account. | IDs cannot have spaces. Otherwise, no character restrictions. |
| carrierOrder.id | The Order ID for the carrier order associated with the external ID. | Carrier Order IDs are found in the ID column of the carrierOrder.csv upload sheet. | Required if the external ID is associated with a Carrier order. | IDs cannot have spaces. Otherwise, no character restrictions. |
| externalId.type* | The type of customer, carrier, or other external ID that is used. |
External ID types are found in the Customer external order ID type codes table or |
Required If using the otherAccount.id column, select a Customer external order ID type. |
Find the correct code from the correct table to enter the external ID type. |
| externalId.value* |
The external ID that corresponds to the ID type indicated in the ExternalId.type column. (e.g., if customer PO number, then enter the customer PO number associated with the shipment). |
- | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| fragmentSequence | The sequence number that identifies the route leg, if the External ID is specific to a route leg. | - |
Carrier Order ID and fragment sequence are required to add External IDs as route leg IDs. The fragment sequence should be left blank when the External IDs are not applicable to the carrier order segment. |
Numbers only. |
Filename: equipment.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for equipment used for a shipment. This ID is used anytime you would like to make updates or add details to the equipment in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The unique ID for the shipment. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
|
carrierOrder.id (Conditional) |
The Order ID for the carrier order associated with the shipment the equipment is used for. | Carrier Order IDs are found in the ID column of the carrierOrder.csv upload sheet. | - | IDs cannot have spaces. Otherwise, no character restrictions. |
| type | The type of equipment. | Equipment type codes are found in the Equipment type codes table. | - | Find the correct equipment type and then enter the corresponding four-digit or five-digit code. |
| size | The size of the equipment. | Equipment size codes are found in the Equipment size codes table. | - | Find the correct equipment size and then enter the corresponding four-digit code. |
| temp | Enter the temperature of equipment. Units of measure are automatically selected based on your tenant’s locale. | _ | - | Number with decimals allowed. |
| weight | Enter the weight of the equipment. | _ | Units of measure are automatically selected based on your tenant’s locale. | Numbers only. |
| services | The type of equipment service that is used. | Equipment service codes are found in the Equipment service codes table. | Find the correct services and then enter the corresponding five-digit code. | |
| description | Description of the equipment being used for shipments. | - | Only applicable when adding equipment associated with shipments and not for carrier orders. | No character restrictions. |
| legSequence | Indicates the ID and the sequence for the route leg within the shipment that the equipment is being used for. | - | Only applicable when adding equipment for carrier order and not for shipment. | Numbers only. |
| vin | The equipment’s VIN number. | - | - | No character restrictions. |
| assetNumber | A unique identifier linked to asset, created when importing asset data to Turvo in the Asset entity. | - | - | No character restrictions. |
| licenseNumber | The equipment’s license number. | - | - | No character restrictions. |
Filename: items.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for an item with a shipment. This ID is used anytime you would like to make updates or add details to the item in TDI. |
- |
Required. If you do not have an existing ID to use in this field, create one. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The Shipment ID associated with the item. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| customerOrder.id* | The Customer Order ID associated with the shipment. | Customer Order IDs are found in the ID column of the customerOrder.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| routeStart.id* | The routeStart.id for the shipment’s starting location. | routeStart IDs are found in the routeStart.id column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| routeEnd.id* | The routeEnd.id for the shipment’s final delivery location. | routeEnd IDs are found in the routeEnd.id column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| name* | The name of the item. | - | Required | No character restrictions. |
| refNumber | An optional reference number for the shipment. | - | - | No character restrictions. |
| lotNumber | A lot number associated with the item. | - | - | No character restrictions. |
| category* | A category to distinguish the item as a vehicle or another kind of item. |
Other: 22300 Vehicle: 22301 |
Required. If your tenant is configured to allow a VIN number as an item name and the item is a vehicle, use the code for Vehicle. Otherwise, use the code for Other. |
Use one of the two codes listed in the Values/Codes column to the left. |
| notes | A free form text field where any notes on the item should be added. | - | - | No character restrictions. |
| qty* | The quantity of base units by which the item is shipped that are within the shipment. | - | Required |
Numbers only. If the item is shipped by the box, inputting “1” would indicate one box. |
| qty.unit* | The type of unit used as a base unit for the item (e.g., pallets, boxes, etc.). | Unit of measure codes are found in the Unit of measures codes table. | Required | Find the correct unit and then enter the corresponding four-digit code. |
| handlingQty | The total quantity of units that the item is handled at. | - | Example: If there are five boxes of an item, and five boxes fit in a pallet, the quantity equals one pallet. | Numbers only. |
| handlingQty.unit | The type of unit used for the handling quantity. | Unit of measure codes are found in the Unit of measures codes table. | - | Find the correct unit and then enter the corresponding four-digit code. |
| weight | Enter the weight of the item. | _ | Units of measure are automatically selected based on your tenant’s locale. | Numbers with decimals allowed. |
| min.temp | Enter the minimum temperature the item should be kept at. | _ | Units of measure are automatically selected based on your tenant’s locale. | Numbers only. |
| max.temp | Enter the maximum temperature the item should be kept at. | _ | Units of measure are automatically selected based on your tenant’s locale. | Numbers only. |
| value | The retail value of the item. | - | - | Numbers with decimals allowed. |
| freightClass | The freight class the item belongs to. | Freight class codes are found in the Freight class codes table. | - | Find the correct freight class and then enter the corresponding four-digit code. |
| nmfc | The National Motor Freight Classification (NMFC) code associated with the item. | - | - | No character restrictions. |
| nmfcSub | The commodict grouping within the NMFC code associated with the item. | - | - | No character restrictions. |
| isHazmat | Indicates whether the item is a hazardous material. |
True False |
Enter "True" if the item is a hazardous material or "False" if it is not. | - |
| isStackable | Indicates whether the item can be stacked. |
True False |
Enter "True" if the item is stackable for "False" if it is not. | - |
| vin.id | VIN number for the item, if a vehicle. | - | - | No character restrictions. |
| vin.year | Manufacturing year of the item, if a vehicle. | - | - | No character restrictions. |
| vin.make | Manufacturer of the item, if a vehicle. | - | - | No character restrictions. |
| vin.model | Model of the item, if a vehicle. | - | - | No character restrictions. |
| vin.color | Color of the item, if a vehicle. | - | - | No character restrictions. |
| dim.length | The item’s length. | - | Units of measure are automatically selected based on your tenant’s locale. | Numbers with decimals allowed. |
| dim.width | The item’s width. | - | Units of measure are automatically selected based on your tenant’s locale. | Numbers with decimals allowed. |
| dim.height | The item’s height. | - | Units of measure are automatically selected based on your tenant’s locale. | Numbers with decimals allowed. |
| wheelBase | The wheelbase of the item, if a vehicle. | - | - | Numbers with decimals allowed. |
| identification | Additional item attributes. | - | - | Numbers only. |
| shippingName | Additional item attributes. | - | - | No character restrictions. |
| hazardClass | The hazard class of the item, if a hazardous material. | - | Required if isHazmat is set to true. | Numbers only. |
| packingGroup | The packaging group for the item, if a hazardous material. |
|
Required if isHazmat is set to true. | Enter the appropriate code from the Value/codes column. |
| emergencyContact.id | The Contact ID for the emergency contact for the item, if a hazardous material. | Contact IDs are found in the ID column of the contact.csv upload sheet. | Required if isHazmat is set to true. | IDs cannot have spaces. Otherwise, no character restrictions. |
Filename: costs.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for the cost. This ID is used anytime you would like to make updates or add details to the chose in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The Shipment ID for the shipment associated with the cost. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| customerOrder.id | The Customer Order ID associated with the cost. | Customer Order IDs are found in the ID column of the customerOrder.csv upload sheet. | Required if the cost is associated with a customer order. | IDs cannot have spaces. Otherwise, no character restrictions. |
| carrierOrder.id | The Carrier Order ID associated with the cost, created in the carrierOrder file. | Carrier Order IDs are found in the ID column of the carrierOrder.csv upload sheet. | Required if the cost is associated with a carrier order. | No character restrictions. |
| lineItem.code* | The type of cost charged by the carrier. | Cost type codes are found in the Cost type codes table. | Required | Find the correct code to enter the cost type. |
| lineItem.qty* | The quantity of the cost item. | - | Required | Numbers only. |
| lineItem.price* | The price of the cost item. | - | Required | Numbers with decimals allowed. |
| lineItem.amount* | The total amount of the cost item (Quantity multiplied by price). | - | Required | Numbers with decimals allowed. |
| lineItem.notes | A free form text field where any notes on the cost item should be added. | - | - | No character restrictions. |
| lineItem.billable | Indicates whether the cost item is billable to the customer. | - | Enter "True" if the cost item is billable. Enter "False" if it is not. | This is only applicable for carrier costs that have carrierOrder.id populated. |
| lineItem.payable |
Indicates whether the cost item is payable to the carrier. |
True False |
Enter "True" if the cost item is payable. Enter "False" if it is not. | This is only applicable for customer costs that have the customerOrder.id populated. |
Filename: contacts.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for contacts associated with a shipment. This ID is used anytime you would like to make updates or add details to the contact in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The Shipment ID associated with the shipment’s contact. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| customerOrder.id | The Customer Order ID associated with the contact. | Customer Order IDs are found in the ID column of the customerOrder.csv upload sheet. | - | IDs cannot have spaces. Otherwise, no character restrictions. |
| otherAccount.id | The Other Account ID, if the contact associated with the shipment is not a customer or carrier account. | Other Account IDs are found in the ID column of the otherAccount.csv upload sheet. | - | IDs cannot have spaces. Otherwise, no character restrictions. |
| carrierOrder.id | The Carrier Order ID associated with the contact. | Carrier Order IDs are found in the ID column of the carrierOrder.csv upload sheet. | If the contact’s role is Driver and a fragmentSequence is added, then the Carrier Order ID is required. | IDs cannot have spaces. Otherwise, no character restrictions. |
| contact.id* | The Contact ID that is associated with the customer, carrier, or other account. | Contact IDs are found in the ID column of the contact.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| role* | The role of the account identified in the contact.id column. | Contact roles codes are found in the Contact role codes table. | Required | Find the correct code to enter the contact’s role. |
| fragmentSequence | Sequence number that identifies the route leg. | - |
Required if the contact’s role is Driver. Otherwise, leave blank. |
Numbers only. |
| trackMethod | The method used for driver tracking. |
None: 31300 Turvo Driver app: 31301 |
Enter the code for the Turvo Driver app if the contact’s role is Driver. Otherwise, enter the code for None. |
- |
| enableSharing | Allows sharing of the contact information within the network. |
True False |
Enter "True" to enable sharing or "False" to keep sharing disabled. | - |
Filename: invoice.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for the invoice. This ID is used anytime you would like to make updates or add details to the invoice in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The Shipment ID associated with the invoice. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
|
customerOrder.id (Conditional) |
The Customer Order ID associated with the invoice. | Customer Order IDs are found in the ID column of the customerOrder.csv upload sheet. |
Required if the invoice is for a customer order. Leave blank if the invoice is for a carrier order. |
IDs cannot have spaces. Otherwise, no character restrictions. |
|
carrierOrder.id (Conditional) |
The Carrier Order ID associated with the invoice. | Carrier Order IDs are found in the ID column of the carrierOrder.csv upload sheet. |
Required if the invoice is for a carrier order. Leave blank if the invoice is for a customer order. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| date* | The invoice date. | - | Required | YYYY-MM-DD |
| invoiceNum* | The invoice number. | - | Required | No character restrictions. |
| dueDate | The invoice’s due date. | - | - | YYYY-MM-DD |
| status* | The invoice’s status. | Document status codes are found in the Customer/Carrier invoice statuses table. | Required. | Find and enter the correct four-digit invoice status code using the table linked in the Values/codes column. |
| notes | A free form text field where any notes about the invoice should be added. | - | - | No character restrictions. |
| paid amount* | The amount that is already recorded as paid against a carrier/customer order. | - | Required | Numbers with decimals allowed. |
Filename: payment.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for the payment. This ID is used anytime you would like to make updates or add details to the payment in TDI. |
If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The Shipment ID associated with the payment. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
|
customerOrder.id (Conditional) |
The Customer Order ID associated with the payment. | Order IDs are found in the ID column of the customerOrder.csv upload sheet. |
Required if the payment is for a customer order. Leave blank if the payment is for a carrier order. |
IDs cannot have spaces. Otherwise, no character restrictions. |
|
carrierOrder.id (Conditional) |
The Carrier Order ID associated with the payment. | Order IDs are found in the ID column of the carrierOrder.csv upload sheet. |
Required if the payment is for a carrier order. Leave blank if the payment is for a customer order. |
IDs cannot have spaces. Otherwise, no character restrictions. |
| invoice.id* | The unique ID used for the invoice. | Invoice IDs are found in the ID column of the invoice.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| referenceNum | The Payment Reference number. | - | - | No character restrictions. |
| paymentDate* | The date the payment was made. | - | Required | YYYY-MM-DD |
| method* | The payment method used to pay the carrier or receive pay from the customer. | Payment method codes are found in the Payment method codes by type table. | Required | Find and enter the correct payment method code. |
| notes | A free form text field where any notes about the payment should be added. | - | - | No character restrictions. |
| amount* | The amount of the payment. | - | Required | Numbers with decimals allowed. |
| paymentTerm* | The payment’s terms. | - | Applicable for carrier payments only. | No character restrictions. |
| fee | Any fee applicable to the payment. |
5200: We pay fee 5201: Deduct fee |
Applicable to customer payments only. | Enter the appropriate code from the Value/codes column. |
Filename: deduction.csv
| Field | Description | Values/codes | Conditions | Format/restrictions |
| id* |
The unique system ID for a deduction made from a carrier payment. This ID is used anytime you would like to make updates or add details to the deduction in TDI. |
-If you do not have an existing ID to use in this field, create one. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| shipment.id* | The Shipment ID associated with the deduction. | Shipment IDs are found in the ID column of the shipment.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| carrierOrder.id* | The Carrier Order ID associated with the deduction. | Carrier Order IDs are found in the ID column of the carrierOrder.csv upload sheet. | Required | IDs cannot have spaces. Otherwise, no character restrictions. |
| amount* | The amount of the deduction. | - | Required | Numbers with decimals allowed. |
| notes | A free form text field where any notes about the deduction should be added. | - | - | No character restrictions. |
| description | The user-entered description of the deduction. | - | - | No character restrictions. |
| date* | The date the deduction was made. | - | Required | YYYY-MM-DD |
<%= heading %>