---
title: "Summer '25 Revenova TMS EDI Specifications"
slug: "summer-25-revenova-tms-edi-specifications"
tags: ["EDI", "Admin"]
updated: 2025-09-12T16:20:10Z
published: 2025-11-04T19:05:19Z
canonical: "documents.revenova.com/summer-25-revenova-tms-edi-specifications"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://documents.revenova.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Summer '25 Revenova TMS EDI Specifications
## **Overview**
This document defines the syntax and semantics of a REST-based web service API to support selected EDI transactions related to the transportation industry. It acts as a synchronous, XML-based “wrapper” that shields client process API users from the message exchange patterns, transport, and format details of the supported EDI transactions. The “Revenova Partner VAN” will be responsible for implementing the web service described in this document.
This API will be used by customers via the Revenova Transportation Management System (TMS) – a native Salesforce.com application – to interact with their trading partners who are employing EDI on the VAN network.
Note that each TMS customer has their own Salesforce-provided “instance” or “org” running a separate copy of Salesforce and TMS. The high-level technical architecture for each TMS customer is illustrated as follows:

Note that the Revenova Partner VAN may be the same organization as the Trading Partner VAN for some TMS customers.
It is anticipated that this API is utilized by many TMS customers.
## Supported Transactions
The API supports the following EDI transactions.
1. Inbound EDI 204: **Motor Carrier Load Tender**
2. Outbound EDI 990: **Response to Load Tender**
3. Outbound EDI 214: **Shipment Status Report**
4. Outbound EDI 210: **Motor Carrier Freight Details and Invoice**
5. EDI 997: **Functional Acknowledgment**
6. Inbound EDI 824: **Application Advice**
7. Outbound EDI 204: **Motor Carrier Load Tender**
8. Inbound EDI 990: **Response to Load Tender**
9. Outbound EDI 404: **Rail Carrier Load Tender**
10. Inbound EDI 214: **Shipment Status Report**
11. Inbound EDI 322: **Terminal Operations and Intermodal Ramp Activity**
12. Inbound EDI 210: **Motor Carrier Freight Invoice**
13. Inbound EDI 410: **Rail Carrier Freight Details and Invoice**
14. Outbound EDI 998: **Cancel Rail Carrier Load Tender**
A subset of these transactions’ ANSI ASC X12 standard elements will be supported as defined in the request-response definitions below.
“Inbound” refers to transactions inbound from the Partner VAN to the Revenova TMS. “Outbound” refers to transactions outbound from the Revenova TMS to the Partner VAN.
## Message Exchange Patterns
This section defines the message exchange patterns for all supported transaction types.
**All message exchanges are initiated by the API client (Revenova TMS).** No unsolicited data is “pushed” from the Revenova Partner VAN to the API client (TMS). All transactions are the **HTTP POST** verb.
### **Inbound EDI 204 Process**
1. Trading Partner(s) sends 1-to-n EDI 204 (Load Tender) transactions to Trading Partner VAN.
2. Trading Partner VAN forwards 1-to-n EDI 204 transactions to Revenova Partner VAN.
3. Revenova Partner VAN sends 1-to-n EDI 997 transactions back to the Trading Partner VAN.
4. Revenova Partner VAN stages EDI 204 transactions in TMS customer-specific queue.
5. Revenova TMS invokes **GetLoadTenders** API call. Revenova Partner VAN returns **0-100** accumulated EDI 204 transactions translated into API XML format.
6. The queue is emptied after n GetLoadTenders calls, and then starts to “fill” with new transactions.
7. **Note: A maximum of 100 transactions should be returned by Revenova Partner VAN per method invocation.**
### **Outbound EDI 990 Process**
1. Revenova TMS invokes **SendLoadTenderResponses** API call to send 1-to-n EDI 990 (Tender Response) transactions to Revenova Partner VAN in API XML format.
2. Revenova Partner VAN translates XML transactions into EDI 990 format and forwards them to appropriate Trading Partner VAN(s) and/or Trading Partner(s).
3. No EDI 997 is needed back to TMS, as the response XML packet is sufficient.
### **Outbound EDI 214 Process**
1. Revenova TMS invokes **SendLoadStatusMessages** API call to send 1-to-n EDI 214 (Shipment Status Message) transactions to Revenova Partner VAN in API XML format.
2. Revenova Partner VAN translates XML transactions into EDI 214 format and forwards them to appropriate Trading Partner VAN(s) and/or Trading Partner(s).
3. No EDI 997 is needed back to TMS, as the response XML packet is sufficient.
### Outbound EDI 210 Process
1. Revenova TMS invokes **SendLoadInvoices** API call to send 1-to-n EDI 210 (Freight Details and Invoice) transactions to Revenova Partner VAN in API XML format.
2. Revenova Partner VAN translates XML transactions into EDI 210 format and forwards them to appropriate Trading Partner VAN(s) and/or Trading Partner(s).
3. No EDI 997 is needed back to TMS, as the response XML packet is sufficient.
### **Outbound EDI 204 & 404 Process**
1. Revenova TMS invokes **SendLoadTender** API call to send 1 EDI 204 (Load Tender) or or 404 (Rail Load Tender) transaction to Revenova Partner VAN in API XML format.
2. Revenova Partner VAN translates XML transaction into EDI 204 or 404 format and forwards to appropriate Trading Partner VAN and/or Trading Partner carrier.
3. No EDI 997 is needed back to TMS, as the response XML packet is sufficient.
### **Inbound EDI 824 & 990 Process**
1. Trading Partner carrier(s) sends 1-to-n EDI 824 (Rail Tender Response) or EDI 990 (Tender Response) transactions to Trading Partner VAN.
2. Trading Partner VAN forwards 1-to-n EDI 824 or EDI 990 transactions to Revenova Partner VAN.
3. Revenova Partner VAN sends 1-to-n EDI 997 transactions back to the Trading Partner VAN.
4. Revenova Partner VAN stages EDI 824 or EDI 990 transactions in TMS customer-specific queue.
5. Revenova TMS invokes **GetLoadTenderResponses** API call. Revenova Partner VAN returns all accumulated EDI 824 or EDI 990 transactions translated into API XML format.
6. The queue is emptied after the GetLoadTenderResponses call, and then starts to “fill” with new transactions.
### Inbound EDI 214 & 322 Process
1. Trading Partner carrier(s) sends 1-to-n EDI 214 (Shipment Status) or EDI 322 (Rail Shipment Status) transactions to Trading Partner VAN.
2. Trading Partner VAN forwards 1-to-n EDI 214 or EDI 322 transactions to Revenova Partner VAN.
3. Revenova Partner VAN sends 1-to-n EDI 997 transactions back to the Trading Partner VAN.
4. Revenova Partner VAN stages EDI 214 or EDI 322 transactions in TMS customer-specific queue.
5. Revenova TMS invokes **GetLoadStatusMessages** API call. Revenova Partner VAN returns **0-to-100** accumulated EDI 214 or EDI 322 transactions translated into API XML format.
6. The queue is emptied after n invocations of the GetLoadStatusMessages call, and then starts to “fill” with new transactions.
7. **Note: A maximum of 100 transactions should be returned by Revenova Partner VAN per method invocation.**
### **Inbound EDI 210 & 410 Process**
1. Trading Partner(s) sends 1-to-n EDI 210 (Freight Invoice) or EDI 410 (Rail Freight Invoice) transactions to Trading Partner VAN.
2. Trading Partner VAN forwards 1-to-n EDI 210 or EDI 410 transactions to Revenova Partner VAN.
3. Revenova Partner VAN sends 1-to-n EDI 997 transactions back to the Trading Partner VAN.
4. Revenova Partner VAN stages EDI 210 or EDI 410 transactions in TMS customer-specific queue.
5. Revenova TMS invokes **GetLoadInvoices** API call. Revenova Partner VAN returns all accumulated EDI 210 or 410 transactions translated into API XML format.
6. The queue is emptied after n GetLoadInvoices calls, and then starts to “fill” with new transactions.
### **Outbound EDI 998 Process**
1. Revenova TMS invokes **SendLoadTender** API call to send 1 EDI 998 (Rail Load Tender Cancellation) transaction to Revenova Partner VAN in API XML format.
2. Revenova Partner VAN translates XML transaction into EDI 998 format and forwards to appropriate Trading Partner VAN and/or Trading Partner carrier.
3. No EDI 997 is needed back to TMS, as the response XML packet is sufficient.
## **Transaction Request-Response Specifications**
> [!NOTE]
> The following transaction is updated for the Summer ‘25 release.
>
> - SendLoadTender Operation
### **Common Request Authorization Section**
API credentials are provided to each TMS customer by the Revenova Partner VAN. There is usually one set of credentials per TMS/VAN customer. The following authorization header will appear at the top of all API requests:
#### Example XML
```xml
intell
abcdef12345
```
#### Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** |
| --- | --- | --- | --- | --- |
| auth | Section Header | Yes | 1 | N/A |
| custId | Customer Id | Yes | 1 | String(20) |
| pwd | Password | Yes | 1 | String(20) |
### **Common Response Status Section**
The following response status header will appear at the top of all API responses. The messageCode and message elements are only populated in the case of a statusCode value of ERROR.
#### Example XML
```xml
ERROR
100
abcdef
```
#### Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** |
| --- | --- | --- | --- | --- |
| status | Section Header | Yes | 1 | N/A |
| statusCode | Status Code | Yes | 1 | ‘OK’ or ‘ERROR’ |
| messageCode | Status Message Code | No | 0:1 | Integer See Appendix A |
| message | Status Message | No | 0:1 | String(200) See Appendix A |
### **GetLoadTenders Operation (Inbound)**
This API call retrieves all EDI 204 transactions in the customer’s queue from the Revenova Partner VAN. The Revenova Partner VAN clears the transaction queue each time this operation is invoked.
> [!NOTE]
> No changes to the getLoadTenders operation request or response for the Summer ‘25 release.
#### Example Request XML
```xml
[COMMON REQUEST AUTHORIZATION SECTION]
```
#### Request Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** |
| --- | --- | --- | --- | --- |
| getLoadTendersRequest | Root element | Yes | 1 | N/A |
#### Example Response XML
```xml
[COMMON RESPONSE STATUS SECTION]
123456
ABC81818181
Original
PO
Reference Number
PO-1919191
SCA
SCAC
DIV1
BM
Reference Number
ANC1919191
CR
Reference Number
ORD1919191
PO-1919191
42645
098781237
Truckload
53’ Dry Van
Hello
World
Collect
2015-12-23
23:30
LT
2500.00
50000.00
USD
250.00
250
ABC Company
79 W. Monroe St.
Chicago
IL
60603
US
123456789
George Smiley
312-888-9999
312-888-9999
gsmiley@mi6.org
1
pickup
go to dock 122
PO
Reference Number
PO94949494
Y
2015-12-22
08:00
16:00
LT
ABC Company
79 W. Monroe St.
Chicago
IL
60603
US
123456789
George Smiley
312-888-9999
312-888-9999
gsmiley@mi6.org
Percy Allelline
312-888-9999
312-888-9999
percy@mi6.org
Lumper
FF
100.00
Lift Gate
BB
200.00
2
dropoff
go to dock 422
PO
Reference Number
PO94949494
Y
2015-12-22
08:00
16:00
LT
DEF Company
579 W. Monroe St.
Chicago
IL
60603
US
123456789
George Smiley
312-888-9999
312-888-9999
gsmiley@mi6.org
Percy Allelline
312-888-9999
312-888-9999
percy@mi6.org
Lumper
FF
200.00
Lift Gate
BB
50.00
-
1
2
123456
PO
Reference Number
PO94949494
ping pong balls
10
Pallets
10
Pieces
20000
lbs
48
48
48
in
200
Cubic Feet
70
122270
Y
UN
1234
1.1
III
George Smiley
312-888-9999
George@mi6.com
-
1
2
AB123456
PO
Reference Number
PO18181818
foosballs
10
Pallets
10
Pieces
20000
lbs
48
48
48
in
200
Cubic Feet
70
122270
N
Line Haul
Line Haul
5000.00
Fuel
Fuel Surcharge
200.00
Accessorial
Lift Gate
100.00
Accessorial
Lumper
200.00
```
### **SendLoadTender Operation (Outbound)**
This API call sends one EDI 204, 404, or 998 transaction from Revenova to the Revenova Partner VAN.
> [!NOTE]
> The following changes are added to the sendLoadTender operation request for the Summer ‘25 release.
>
> - carrierQuoteId: Maps to the Carrier Quote Reference field.
> - contractId: New element in the transaction.
#### Example Request XML
```xml
[COMMON REQUEST AUTHORIZATION SECTION]
11223344
SCAC
11991199
123
ABC81818181
Original
PO
Reference Number
PO-1919191
PR
Reference Number
1919191
BM
Reference Number
ANC1919191
CR
Reference Number
ORD1919191
3939393939
11122393939
282823939
282823939
Intermodal
53’ Dry Van
222
lbs
Cont11223344
Hello
World
Collect
2015-12-23
23:30
LT
50000.00
250.00
USD
250
Origin AAA
Destination CCC
25
DEF Company
100 W. Monroe St.
Chicago
IL
60603
US
George Smiley
312-888-9999
gsmiley@mi6.org
ABC Company
79 W. Monroe St.
Chicago
IL
60603
US
123456789
George Smiley
312-888-9999
312-888-9999
gsmiley@mi6.org
Customs Broker One
123 Main Street
Chicago
IL
60044
US
Bill Customs Broker One
444-555-6666
111-222-3333
test@revenova.com
Email Carrier One
341 S Larkin Ave
Joliet
IL
60436
US
Tess Email Carrier One
312-999-8888
312-222-4444
test@revenova.com
Revenova Shipper
2333 Waukegan Rd.
Bannockburn
IL
60015
US
Y
2015-12-22
08:00
16:00
LT
Joe Revenova HQ
312-999-7777
312-222-3333
test@revenova.com
Los Angeles Consignee
2765 E Olympic Blvd
Los Angeles
CA
90023
US
Y
2015-12-22
08:00
16:00
LT
Joe Angeles
312-999-7777
312-222-3333
test@revenova.com
1
pickup
go to dock 122
PO
Reference Number
PO94949494
Y
2015-12-22
08:00
16:00
LT
ABC Company
79 W. Monroe St.
Chicago
IL
60603
US
123456789
George
312-888-9999
312-888-9999
gsmiley@mi6.org
Percy
312-888-9999
312-888-9999
percy@mi6.org
Lumper
Lift Gate
2
dropoff
go to dock 422
PO
Reference Number
PO94949494
Y
2015-12-22
08:00
16:00
LT
DEF Company
579 W. Monroe St.
Chicago
IL
60603
US
123456789
George
312-888-9999
312-888-9999
gsmiley@mi6.org
Percy
312-888-9999
312-888-9999
percy@mi6.org
Lumper
Lift Gate
-
1
2
123456
ping pong balls
10
Pallets
10
Pieces
20000
lbs
48
48
48
in
200
Cubic Feet
70
122270
2222226
Y
-
1
2
AB123456
foosballs
10
Pallets
10
Pieces
20000
lbs
48
48
48
in
200
Cubic Feet
70
122270
2222229
N
Line Haul
Line Haul
5000.00
Fuel
Fuel Surcharge
200.00
Accessorial
Lift Gate
100.00
Accessorial
Lumper
200.00
```
#### Example Response XML
```xml
[COMMON RESPONSE STATUS SECTION]
```
#### Response Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** |
| --- | --- | --- | --- | --- |
| sendLoadTenderResponse | Root element | Yes | 1 | N/A |
#### Request Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** | **Maps To** |
| --- | --- | --- | --- | --- | --- |
| getLoadTenderResponse | Root element | Yes | 1 | N/A | N/A |
| sendLoadTenderRequest | Root element | Yes | 1 | N/A | N/A |
| loadTenders | Section Header | Yes | 1 | N/A | Load |
| loadTender | Section Header | No | 0:n | N/A | Load |
| tradingPartnerId | Unique Transaction Initiator Id | Yes | 1 | String(50) | EDI Location - Name |
| carrierTradingPartnerId | Unique Transaction Recipient Id | Yes | 1 | String(50) | EDI Location - Name |
| carrierSCAC | Carrier SCAC | Yes | 1 | String(4) | Transportation Profile - SCAC |
| carrierQuoteId | Carrier Quote Reference | No | 1 | String(100) | Carrier Quote - Carrier Quote Reference |
| contractId | Contract Id | Yes | 1 | String(100) | Carrier Quote – Contract Id |
| shipmentId | Unique Shared Load Identifier | Yes | 1 | String(50) | Load – Load Number |
| purpose | Type of Transaction | Yes | 1 | Original, Update, or Cancellation | Load – EDI Status |
| referenceNums | Section Header | Yes | 1 | N/A | Load Reference |
| referenceNum | Section Header | No | 0:n | N/A | Load Reference |
| type | Type of Reference Number | Yes | 1 | PO – PO Number PR – PRO Number BM – Bill Of Lading CR – Customer Reference OT - Other | Load Reference - Type |
| text | Label of Reference Number | Yes | 1 | String(100) | Load Reference - Label |
| value | Value of Reference Number | Yes | 1 | String(200) | Load Reference - Value |
| poNum | PO Number | No | 0:n | String(50) | Load – PO Number |
| orderNum | Customer Order Number | No | 0:n | String(50) | Load – Order Number |
| bolNum | Bill of Lading Number | No | 0:n | String(50) | Load – Bill of Lading Number |
| sealNumber | Seal Number | No | 0:1 | String(15) | Load - Seal Number |
| mode | Mode of carrier transport | Yes | 1 | “Intermodal”, “Truckload”, “LTL”, etc. | Mode Name (from Mode object) |
| equipmentType | Equipment Type | No | 0:1 | String(50) | Load – Other Instructions |
| equipmentWeight | Container Weight | No | 0:1 | Integer | Load - Equipment Weight |
| equipmentWeightUnits | Container Weight Units | No | 0:1 | “lbs” or “kg” | Load - Equipment Weight Units |
| containerNumber | Container Number | No | 0:1 | String(80) | Load - Container/Trailer Number |
| specialInstructions | Stop-Independent Instructions Header | No | 0:1 | N/A | Load – Other Instructions |
| specialInstruction | Special Instructions | No | 0:n | String(255) | Load – Other Instructions |
| paymentTerms | Payment Terms | Yes | 1 | Prepaid, Collect, or Third Party | Load – Payment Terms |
| respondByDate | Respond by Date | Yes | 1 | Date | Load - EDI Response Deadline |
| respondByTime | Respond by Time | Yes | 1 | Time | Load – EDI Response Deadline |
| timeZone | Respond By Timezone | Yes | 1 | “LT” only (for local time) | Load – EDI Response Deadline |
| totalCharge | Total Amount to be Paid | No | 0:1 | Currency | Load – EDI Quote Total Customer Quote – Customer Quote Total |
| cargoValue | Cargo Value | No | 0:1 | Currency | Load – Cargo Value |
| currencyCode | ISO Currency Code | No | 0:1 | String(3) | Load – EDI Quote Currency |
| insuranceAmount | Insurance on Load | No | 0:1 | Currency | Load – Insurance Amount |
| mileage | Route distance in miles | No | 0:1 | Decimal | Load – Distance (Miles) |
| originTerminalLocation | Origin Terminal Location | No | 0:1 | String(255) | Carrier Quote - Origin Terminal Location |
| destinationTerminalLocation | Destination Terminal Location or Interchange Location | No | 0:1 | String(255) | Carrier Quote - Destination Terminal Location |
| movementType | Code specifying extent of transportation service requested | No | 0:1 | Picklist | Carrier Quote - Movement Type |
| customerBillTo | Section Header | Yes | 1 | N/A | Not Mapped |
| billTo | Section Header | Yes | 1 | N/A | Not Mapped |
| companyName | Company Name | Yes | 1 | String(80) | Account – Name |
| addr | Address | Yes | 1 | String(100) | Account – Shipping Street |
| city | City | Yes | 1 | String(40) | Account – Shipping City |
| state | State or Province | Yes | 1 | String(2) | Account – Shipping State Code |
| zip | Zip Code | Yes | 1 | String(20) | Account – Shipping Postal Code |
| country | Country | Yes | 1 | 2-character ISO Code | Account – Shipping Country Code |
| contact | Section Header | No | 0:1 | N/A | Not Mapped |
| contactName | Customer Bill To Contact First/Last Name | Yes | 1 | String(50) | Contact - First Name, Contact - Last Name |
| phone | Customer Bill To Contact Phone | No | 0:1 | String(20) | Contact - Phone |
| fax | Customer Bill To Contact Fax | No | 0:1 | String(20) | Contact - Fax |
| email | Customer Bill To Contact Email | No | 0:1 | String(50) | Contact - Email |
| companyId | Unique Company Identifier | Yes | 1 | String(50) | Not Mapped |
| customsBroker | Section Header | No | 0:1 | N/A | Not Mapped |
| companyName | Customs Broker | No | 0:1 | String(80) | Account - Name |
| addr | Customs Broker Address | No | 0:1 | String(100) | Account - Shipping Street |
| city | Customs Broker City | No | 0:1 | String(40) | Account - Shipping City |
| state | Customs Broker State or Province | No | 0:1 | String(2) | Account - Shipping State Code |
| zip | Customs Broker Zip Code | No | 0:1 | String(20) | Account - Shipping Postal Code |
| country | Customs Broker Country | No | 0:1 | 2-character ISO Code | Account - Shipping Country Code |
| contact | Section Header | No | 0:1 | N/A | Not Mapped |
| contactName | Customs Broker Contact First/Last Name | Yes | 1 | String(50) | Contact - First Name, Contact - Last Name |
| phone | Customs Broker Contact Phone | No | 0:1 | String(20) | Contact - Phone |
| fax | Customs Broker Contact Fax | No | 0:1 | String(20) | Contact - Fax |
| email | Customs Broker Contact Email | No | 0:1 | String(50) | Contact - Email |
| notifyParty | Section Header | No | 0:1 | N/A | Not Mapped |
| companyName | Carrier picking up shipment from railroad (Delivery Dray) | Yes | 1 | String(80) | Account - Name |
| addr | Carrier picking up shipment from railroad (Delivery Dray) | No | 0:1 | String(100) | Account - Shipping Street |
| city | Carrier picking up shipment from railroad (Delivery Dray) | No | 0:1 | String(40) | Account - Shipping City |
| state | Carrier picking up shipment from railroad (Delivery Dray) | No | 0:1 | String(2) | Account - Shipping State Code |
| zip | Carrier picking up shipment from railroad (Delivery Dray) | No | 0:1 | String(20) | Account - Shipping Postal Code |
| country | Carrier picking up shipment from railroad (Delivery Dray) | No | 0:1 | 2-character ISO Code | Account - Shipping Country Code |
| contact | Section Header | No | 0:1 | N/A | Not Mapped |
| contactName | Notify Party Contact First/Last Name | Yes | 1 | String(50) | Contact - First Name, Contact - Last Name |
| phone | Notify Party Contact Phone | No | 0:1 | String(20) | Contact - Phone |
| fax | Notify Party Contact Fax | No | 0:1 | String(20) | Contact - Fax |
| email | Notify Party Contact Email | No | 0:1 | String(50) | Contact - Email |
| ultimateShipper | Section Header | No | 0:1 | N/A | Not Mapped |
| companyName | Ultimate Shipper Company Name | Yes | 1 | String(80) | Account - Name |
| addr | Ultimate Shipper Address | No | 0:1 | String(100) | Account - Shipping Street |
| city | Ultimate Shipper City | No | 0:1 | String(40) | Account - Shipping City |
| state | Ultimate Shipper State or Province | No | 0:1 | String(2) | Account - Shipping State Code |
| zip | Ultimate Shipper Zip Code | No | 0:1 | String(20) | Account - Shipping Postal Code |
| country | Ultimate Shipper Country | No | 0:1 | 2-character ISO Code | Account - Shipping Country Code |
| apptRequired | Is Appointment Required | Yes | 1 | Y or N | Stop - Appointment Required |
| expectedDate | Expected Date | Yes | 1 | Date | Stop - Expected Date |
| expectedTimeStart | Expected Time Start | Yes | 1 | Time | Stop - Shipping/Receiving Hours Stop - Appointment Time |
| expectedTimeEnd | Expected Time End | Yes | 1 | Time | Stop - Shipping/Receiving Hours |
| timeZone | Time zone | Yes | 1 | “LT” only (for local time) | Not Mapped |
| contact | Section Header | No | 0:1 | N/A | Not Mapped |
| contactName | Ultimate Shipper Contact First/Last Name | Yes | 1 | String(50) | Contact - First Name, Contact - Last Name |
| phone | Ultimate Shipper Contact Phone | No | 0:1 | String(20) | Contact - Phone |
| fax | Ultimate Shipper Contact Fax | No | 0:1 | String(20) | Contact - Fax |
| email | Ultimate Shipper Contact Email | No | 0:1 | String(50) | Contact - Email |
| ultimateConsignee | Section Header | No | 0:1 | N/A | Not Mapped |
| companyName | Ultimate Consignee Company Name | Yes | 1 | String(80) | Account - Name |
| addr | Ultimate Consignee Address | No | 0:1 | String(100) | Account - Shipping Street |
| city | Ultimate Consignee City | No | 0:1 | String(40) | Account - Shipping City |
| state | Ultimate Consignee State or Province | No | 0:1 | String(2) | Account - Shipping State Code |
| country | Ultimate Consignee Country | No | 0:1 | 2-character ISO Code | Account - Shipping Country Code |
| contact | Section Header | No | 0:1 | N/A | Not Mapped |
| contactName | Ultimate Consignee Contact First/Last Name | Yes | 1 | String(50) | Contact - First Name, Contact - Last Name |
| phone | Ultimate Consignee Contact Phone | No | 0:1 | String(20) | Contact - Phone |
| fax | Ultimate Consignee Contact Fax | No | 0:1 | String(20) | Contact - Fax |
| email | Ultimate Consignee Contact Email | No | 0:1 | String(80) | Contact - Email |
| stops | Section Header | Yes | 1 | N/A | Stop |
| stop | Section Header | Yes | 2:n | N/A | Stop |
| stopNum | Stop Number | Yes | 1 | Integer | Stop – Number |
| stopType | Stop Type | Yes | 1 | Pickup or Dropoff | Stop – Is Pickup Stop – Is Dropoff |
| stopInstructions | Stop-Specific Instructions | No | 0:1 | String(255) | Stop – Instructions |
| referenceNum | Shipper/Consignee Reference Number | No | 0:1 | String(50) | Load Reference |
| apptRequired | Is Appointment Required | Yes | 1 | Y or N | Stop – Appointment Required |
| expectedDate | Expected Date | Yes | 1 | Date | Stop – Expected Date |
| expectedTimeStart | Expected Time Start | Yes | 1 | Time | Stop – Shipping/Receiving Hours Stop – Appointment Time |
| expectedTimeEnd | Expected Time End | Yes | 1 | Time | Stop – Shipping/Receiving Hours |
| timeZone | Time zone | Yes | 1 | “LT” only (for local time) | Not Mapped |
| company | Section Header | Yes | 1 | N/A | Account |
| contacts | Section Header | Yes | 1 | N/A | Contact |
| contact | Section header | No | 0:n | N/A | Contact |
| contactName | Contact First/Last Name | Yes | 1 | String(50) | Contact – First Name Contact – Last Name |
| phone | Contact Phone | No | 0:1 | String(20) | Contact – Phone |
| fax | Contact Fax | No | 0:1 | String(20) | Contact – Fax |
| email | Contact Email | No | 0:1 | String(50) | Contact – Email |
| accessorials | Section Header | Yes | 1 | N/A | Not Mapped |
| accessorials | Section Header | No | 0:n | N/A | Not Mapped |
| name | Accessorial Name | Yes | 1 | String(80) | Not Mapped |
| code | Accessorial Code | No | 0:1 | String(10) | Not Mapped |
| charge | Cost of Accessorial | No | 0:1 | Currency | Not Mapped |
| items | Section Header | Yes | 1 | N/A | Line Item |
| item | Section Header | Yes | 1:n | N/A | Line Item |
| pickupStopNumber | Pickup Stop Number | Yes | 1 | Integer | Line Item – Pickup Stop |
| dropoffStopNumber | Drop-off Stop Number | Yes | 1 | Integer | Line Item – Delivery Stop |
| itemNum | Item (SKU) Identifier | Yes | 1 | String(50) | Line item – Name |
| desc | Item Description | Yes | 1 | String(255) | Line Item – Description |
| handlingUnitCount | Count of Handling Units | No | 0:1 | Integer | Line Item – HU Count |
| handlingUnits | Type of Handling Unit | No | 0:1 | String(50) See Appendix B | Line Item – Handling Units |
| packagingUnitCount | Count of Packaging Units | No | 0:1 | Integer | Line Item – PU Count |
| packagingUnits | Type of Packaging Unit | No | 0:1 | String(50) See Appendix B | Line Item – Packaging Units |
| weight | Item Weight | Yes | 1 | Integer | Line Item – Weight |
| weightUnits | Weight Units | Yes | 1 | lbs or kg | Line Item – Weight Units |
| length | Length of Handling Unit | No | 0:1 | Decimal | Line Item – Length |
| width | Width of Handling Unit | No | 0:1 | Decimal | Line Item – Width |
| height | Height of Handling Unit | No | 0:1 | Decimal | Line Item – Height |
| dimensionUnits | L/W/H Unit of Measure | No | 0:1 | in, cm, ft, or m | Line Item – Dimension Units |
| volume | Item Volume | No | 0:1 | Integer | Line Item – Volume |
| volumeUnits | Volume Units | No | 0:1 | Cubic Feet Cubic Inches Cubic Meters Gallons Liters | Line Item – Volume Units |
| nmfcClass | NMFC Class | No | 0:1 | Standard List (50, 55, etc.) | Line Item – NMFC Class |
| nmfcNumber | NMFC Code/Subcode | No | 0:1 | Ex: 123456-19 | Line Item – NMFC Number |
| stccCode | Standard Transportation Commodity Code (STCC) | No | 0:1 | String(10) | Line Item - STCC Code |
| ishazardousMaterials | HazMat Flag | Yes | 1 | Y or N | Line Item – HazMat |
| hazMatNumberType | HazMat Number Type | No | 0:1 | ‘UN’ or ‘NA’ | Line Item – HazMat Number Type |
| hazMatNumber | HazMat Number | No | 0:1 | 4 digit string such as ‘1234’ | Line Item – HazMat Number |
| hazMatClassDivision | HazMat Class/Division | No | 0:1 | Numeric String: 1.1 1.2 1.3 1.4 1.5 1.6 2.1 2.2 2.3 3 4.1 4.2 4.3 5.1 5.2 6.1 6.2 7 8 9 | Line Item – HazMat Class/Division |
| hazMatPackagingGroup | HazMat Packaging Group | No | 0:1 | ‘I’, ‘II’, or ‘III’ | Line Item – HazMat Packaging Group |
| hazMatContactName | Contact Name | No | 0:1 | String(80) | Contact – Name |
| hazMatContactPhone | Contact Phone | No | 0:1 | String(20) | Contact – Phone |
| hazMatContactEmail | Contact Email | No | 0:1 | String(50) | Contact – Email |
| charges | Section Header | No | 0:1 | N/A | Customer/Carrier Quote |
| charge | Customer Rate Line Item | No | 0:n | N/A | Customer/Carrier Quote |
| type | Rate Item Type | Yes | 1 | Line Haul, Fuel, Accessorial | Customer/Carrier Quote |
| desc | Rate Item Description | Yes | 1 | String(40) | Customer/Carrier Quote |
| amount | Rate Item Charge Amount | Yes | 1 | Currency | Customer/Carrier Quote |
Note that the **EDI SCAC** Load field may be populated from a load-level element if present.
#### *movementType Definition
| Code | Movement Type |
| --- | --- |
| 15 | Moto/Rail - Ramp to Ramp |
| 20 | Rail - Door to Door |
| 22 | Rail - Door to Destination Ramp |
| 25 | Rail - Ramp to Ramp |
| 27 | Rail - Origin Ramp to Door |
| 40 | Steamship/Stack Operator - Door to Door |
| 42 | Steamship/Stack Operator - Door to Destination Ramp |
| 45 | Steamship/Stack Operator - Ramp to Ramp |
| 47 | Steamship/Stack Operator - Origin Ramp to Door |
| 60 | Patron/Customer - Door to Door |
| 62 | Patron/Customer - Door to Destination Ramp |
| 65 | Patron/Customer - Ramp to Ramp |
| 67 | Patron/Customer - Origin Ramp to Door |
| 80 | Steamship/Stack Operator - International - Door to Door |
| 82 | Steamship/Stack Operator - International - Door to Destination Ramp |
| 85 | Steamship/Stack Operator - International Ramp to Ramp |
| 87 | Steamship/Stack Operator - International - Origin Ramp to Door |
### **SendLoadTenderResponses Operation (Outbound)**
This API call sends EDI 990 data for one or more loads to the Revenova Partner VAN.
> [!NOTE]
> No changes to the sendLoadTenderResponses operation request and response for the Summer ‘25 release.
#### Example Request XML
```xml
[COMMON REQUEST AUTHORIZATION SECTION]
123456
ABC81818181
Load-9989899
PO
Reference Number
PO-1919191
PR
Reference Number
1919191
BM
Reference Number
ANC1919191
CR
Reference Number
ORD1919191
Decline
TTI
```
#### Request Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeat** | **Type** | **Maps To** |
| --- | --- | --- | --- | --- | --- |
| sendLoadTenderResponsesRequest | Root element | Yes | 1 | N/A | Not Mapped |
| loadTenderReponses | Section Header | Yes | 1 | N/A | Load |
| loadTenderResponse | Section Header | Yes | 1:n | N/A | Load |
| tradingPartnerId | Unique Transaction Initiator Id | Yes | 1 | String(50) | EDI Location – Name |
| shipmentId | Unique Shared Load Identifier | Yes | 1 | String(50) | Load - Load Number |
| loadNum | Unique Load Identifier from TMS/Carrier | Yes | 1 | String(50) | Load – Name |
| referenceNums | Section Header | Yes | 1 | N/A | Load Reference |
| status | Tender Status | Yes | 1 | Accept or Decline | Load – EDI Status |
| declineReasonCode | Why tender declined | No | 0:1 | TTI = Transit Time Issue TAP = Tendered After Pickup Appointment UPU = Unsuitable Pickup Appointment / Lack of Dock Space ECL = Exceeded Capacity Limit OS = Overweight Shipment STL = Short Lead Time Org Change DAI = Delivery Appointment Issue IR = Incorrect Rate | Load – EDI Decline Reason |
#### Example Response XML
```xml
[COMMON RESPONSE STATUS SECTION]
```
#### Response Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** |
| --- | --- | --- | --- | --- |
| sendLoadTenderResponsesResponse | Root element | Yes | 1 | N/A |
### **GetLoadTenderResponses Operation (Inbound)**
This API call retrieves 0-to-N EDI 824 or 990 Load tender responses from the Revenova Partner VAN.
> [!NOTE]
> No changes to the getLoadTenderResponses operation request or response for the Summer ‘25 release.
#### Example Request XML
```xml
[COMMON REQUEST AUTHORIZATION SECTION]
```
#### Example Response XML
```xml
[COMMON RESPONSE STATUS SECTION]
123456
ABC81818181
Decline
1122334455
2233445566
809
810
Decline Comments
Exception Comments
```
#### Response Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** | **Maps To** |
| --- | --- | --- | --- | --- | --- |
| getLoadTenderResponsesResponse | Root element | Yes | 1 | N/A | Not Mapped |
| loadTenderReponses | Section Header | Yes | 1 | N/A | Not Mapped |
| loadTenderResponse | Section Header | Yes | 1:n | N/A | Load |
| carrierTradingPartnerId | Unique Transaction Initiator Id | Yes | 1 | String(50) | EDI Location - Name |
| shipmentId | Unique Shared Load Identifier | Yes | 1 | String(50) | Load – Load Number |
| status | Tender Status | Yes | 1 | Accept, Decline, Accept with Exception | Carrier Quote - Tender Status |
| waybillNumber | Waybill Number | No | 0:1 | String(40) | Load - Waybill Number |
| bookingNumber | Booking Number | No | 0:1 | String(30) | Load - Booking Number |
| tenderDeclinedReasonCodes | Section Header | No | 0:1 | N/A | Not Mapped |
| tenderDeclinedReasonCode | Reason code for declining the tender | No | 0:n | Picklist (Multi-Select) | Carrier Quote - Tender Declined Reasons |
| tenderDeclinedComments | Text explanation for declining the tender | No | 0:1 | String(255) | Carrier Quote - Tender Declined Comments |
| tenderExceptionComments | Text explanation for acccepting the tender with exceptions | No | 0:1 | String(255) | Carrier Quote - Tender Exception Comments |
### **SendLoadStatusMessages Operation (Outbound)**
This API call sends EDI 214 transaction data for one or more Loads to the Revenova Partner VAN.
> [!NOTE]
> No changes to the sendLoadStatusMessages operation request or response for the Summer ‘25 release.
#### Example Request XML
```xml
[COMMON REQUEST AUTHORIZATION SECTION]
123456
ABC81818181
LD-3939393
PO
Reference Number
PO-1919191
PR
Reference Number
1919191
BM
Reference Number
ANC1919191
CR
Reference Number
ORD1919191
In Transit
2
BG
03/04/2018
20:00
LT
LA PUENTE
CA
91746-3017
US
34.0200
-117.9495
1
pickup
go to dock 122
PO
Reference Number
PO94949494
Y
2015-12-22
08:00
16:00
LT
ABC Company
79 W. Monroe St.
Chicago
IL
60603
US
123456789
Appointment
BG
2015-12-22
08:30-09:30
LT
34.0200
-117.9495
Arrived
BG
2015-12-22
23:30
LT
34.0200
-117.9495
Departed
BG
2015-12-22
23:45
LT
34.0200
-117.9495
```
#### Request Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** | **Maps To** |
| --- | --- | --- | --- | --- | --- |
| sendLoadStatusMessagesRequest | Root element | Yes | 1 | N/A | Not Mapped |
| loadStatusMessages | Section Header | Yes | 1 | N/A | Not Mapped |
| loadStatusMessage | Section Header | Yes | 1:n | N/A | Not Mapped |
| tradingPartnerId | Unique Transaction Initiator Id | Yes | 1 | String(50) | EDI Location – Name |
| shipmentId | Unique Shared Load Identifier | Yes | 1 | String(50) | Load – Load Number |
| loadNum | Unique Load Identifier from TMS/Carrier | Yes | 1 | String(50) | Load – Name |
| referenceNums | Section Header | Yes | 1 | N/A | Load Reference |
| stops | Section Header | Yes | 1 | N/A | Stop |
| stop | Section Header | Yes | 1:n | N/A | Stop |
| stopNum | Stop Number | Yes | 1 | Integer | Stop – Number |
| stopType | Stop Type | Yes | 1 | Pickup or Dropoff | Stop – Is Pickup Stop – Is Dropoff |
| company | Section Header | Yes | 1 | N/A | Account |
| companyName | Company Name | Yes | 1 | String(80) | Account – Name |
| addr | Address | Yes | 1 | String(100) | Account – Shipping Street |
| city | City | Yes | 1 | String(40) | Account – Shipping City |
| state | State or Province | Yes | 1 | String(2) | Account – Shipping State Code |
| zip | Postal Code | Yes | 1 | String(20) | Account – Shipping Postal Code |
| country | Country Code | Yes | 1 | 2-character ISO Code | Account – Shipping Country Code |
| companyId | Unique Company Identifier | Yes | 1 | String(50) | EDI Location – Name |
| events | Section Header | Yes | 1 | N/A | Not Mapped |
| event | Section Header | No | 0:n | N/A | Not Mapped |
| currentlocation | Section Header | No | 0:1 | N/A | Not Mapped |
| status | Load Status at Stop | Yes | 1 | “Appointment” “In Transit” “Arrived” “Departed” “Loading Complete” “Unloading Complete” | Stop – Stop Status |
| reason | Load Status Reason at Stop | Yes | 1 | String(2) std reason codes | Stop – Carrier Status Reason |
| statusDate | Status Date | Yes | 1 | Date | Stop – Expected Date Stop – Arrival Date Stop – Departure Date Stop – Loading/Unloading Complete Date |
| statusTime | Status Time | Yes | 1 | Time | Stop – Appointment Time Stop – Arrival Time Stop – Departure Time Stop – Loading/Unloading Complete Time |
| timeZone | Respond By Timezone | Yes | 1 | “LT” only (for local time) | Not Mapped |
| lat | Latitude | No | 0:1 | Decimal | Load – Last Reported Geolocation |
| lon | Longitude | No | 0:1 | Decimal | Load – Last Reported Geolocation |
| items | Section Header | Yes | 1 | N/A | Line Item |
#### Example Response XML
```xml
[COMMON RESPONSE STATUS SECTION]
```
#### Response Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** |
| --- | --- | --- | --- | --- |
| sendLoadStatusMessagesResponse | Root element | Yes | 1 | N/A |
### **GetLoadStatusMessages Operation (Inbound)**
This API call retrieves **0-to-100** EDI 214 or EDI 322 transactions in the customer’s queue from the Revenova Partner VAN.
> [!NOTE]
> No changes to the getLoadStatusMessages operation request or response for the Summer ‘25 release.
#### Example Request XML
```xml
[COMMON REQUEST AUTHORIZATION SECTION]
```
#### Request Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** |
| --- | --- | --- | --- | --- |
| getLoadStatusMessagesRequest | Root element | Yes | 1 | N/A |
#### Example Response XML
```xml
[COMMON RESPONSE STATUS SECTION]
123456
Load-99818181
1
X3
Arrived at Pickup Location
2018-12-22
08:00
LT
Chicago
IL
60603
US
34.0200
-117.9495
MAEU1234567
PRO1234567
way1234567
b1234567
1234567
554433
Load-81818182
2
X1
Arrived at Delivery Location
2018-12-22
08:45
LT
Chicago
IL
60603
US
34.0200
-117.9495
GESU4444567
PRO4444567
w1234567
bn1234567
s1234567
```
#### Response Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** | **Maps To** |
| --- | --- | --- | --- | --- | --- |
| getLoadStatusMessagesResponse | Root element | Yes | 1 | N/A | Not Mapped |
| loadStatusMessages | Section Header | Yes | 1 | N/A | Not Mapped |
| loadStatusMessage | Section Header | No | 0:n | N/A | Not Mapped |
| carrierTradingPartnerId | Unique Transaction Initiator Id | Yes | 1 | String(50) | EDI Location – Name |
| shipmentId | Unique Shared Load Identifier (as passed in 204 tender) | Yes | 1 | String(50) | Load – Load Number |
| stopNum | The Stop Number for the event | No | 1 | Integer | Stop - Number |
| eventCode | Status event code | Yes | 1 | String(2)* | Stop – Stop Status |
| eventDetail | Status event detail/comment | No | 0:1 | String(255) | Load – Load Status Comments |
| eventDate | Date of event | Yes | 1 | Date | Stop – Carrier ETA Date Stop – Arrival Date Stop – Departure Date |
| eventTime | Time of event in local timezone | Yes | 1 | Time | Stop – Carrier ETA Time Stop – Arrival Time Stop – Departure Time |
| eventCity | City event occurred in | No | 0:1 | String(40) | Load – Last Reported City |
| eventState | State/Province event occurred in | No | 0:1 | 2-character ISO Code | Load – Last Reported State/Province |
| eventZip | Postal code event occurred in | No | 0:1 | String(20) | Not Mapped |
| eventCountry | Country event occurred in | No | 0:1 | 2-charater ISO Code | Load – Last Reported Country |
| lat | Latitude event occurred in | No | 0:1 | Geolocation | Load - Last Reported Geolocation |
| lon | Longitude event occurred in | No | 0:1 | Geolocation | Load - Last Reported Geolocation |
| containerNumber | Container/Trailer Number | No | 0:1 | String(11) example: “MAEU1234567” | Load – Container/Trailer Number |
| proNumber | PRO Number | No | 0:1 | String(40) example: “PRO1234567” | Load – PRO Number |
| waybillNumber | Waybill Number | No | 0:1 | String(40) | Load - Waybill Number |
| bookingNumber | Booking Number | No | 0:1 | String(30) | Load - Booking Number |
| sealNumber | Seal Number | No | 0:1 | String(15) | Load - Seal Number |
#### *eventCode Definition
| **Code** | **Description** |
| --- | --- |
| A | Shipment has arrived at the location specified. |
| B | Shipment was on a piece of equipment that failed. |
| D | Departed |
| G | Repaired and Released |
| J | Shipment delivered to an interline Carrier. |
| L | Loading |
| P | Departed Terminal Location |
| R | Shipment received from an interline Carrier. |
| S | EDI spotted at customer. |
| T | EDI ITM In |
| W | EDI Waybill created. |
| Z | EDI unloading on spot. |
| AD | EDI Delivery Appointment Scheduled. |
| AF | Departed Pickup Location with Shipment. |
| AG | Estimated Delivery |
| AL | Loaded on Rail. |
| AR | Rail Arrival at Destination Ramp. |
| CB | Chassis Tie |
| CC | Chassis Untie |
| CD | Carrier Departed Delivery Location. |
| D1 | Completed Unloading at Delivery Location. |
| I1 | Intermodal In-Gate |
| NF | Free Time to Expire. |
| NT | Container Ready for Pickup from Rail Yard. |
| OA | Intermodal Out-Gate |
| RA | Waypoint Arrival. |
| RD | Waypoint Departure. |
| RL | Rail Departure from Origin Ramp. |
| RN | Notify party at destination is re-notified. |
| S1 | Trailer at Spotted Consignee Location. |
| TA | Waybilled |
| TM | EDI ITM Out |
| UR | Equipment Grounding |
| VA | EDI Vessel Arrival. |
| VD | EDI Vessel Departure. |
| X1 | Arrived at Delivery Location. |
| X3 | Arrived at Pickup Location. |
| X6 | En Route to Delivery Location. |
| XA | EDI released loaded by customer. |
*Unknown codes are saved as Carrier Status Comments.*
### **SendLoadInvoices Operation (Outbound)**
This API call sends EDI 210 data for one or more loads to the Revenova Partner VAN.
> [!NOTE]
> No changes to the sendLoadInvoices operation request or response for the Summer ‘25 TMS release.
#### Example Request XML
```xml
[COMMON REQUEST AUTHORIZATION SECTION]
123456
ABC81818181
2938494834ASD
LD-3939393
PO
Reference Number
PO-1919191
PR
Reference Number
1919191
BM
Reference Number
ANC1919191
CR
Reference Number
ORD1919191
Collect
2015-12-22
2015-12-23
2015-12-23
USD
Line Haul
Net Line Haul
ABC
ping pong balls
70
122270
525.50
10
Per CWT
52550.00
5000.00
47550.00
25
Y
Fuel
Fuel Surcharge
DEF
525.50
Per Mile
200.00
Accessorial
Lift Gate
XYZ
2.00
Flat Rate
75.00
150.00
1
Alberta GST
GST
5.000
123.34
105944649RT0001
New Brunswick HST
HST
15.000
423.34
105944649RT0001
1
pickup
PO
Reference Number
PO94949494
ABC Company
79 W. Monroe St.
Chicago
IL
60603
US
123456789
2
Dropoff
PO
Reference Number
PO94949495
ABC Company
79 W. Monroe St.
Chicago
IL
60603
US
123456789
-
1
2
123456
ping pong balls
10
Pallets
10
Pieces
20000
lbs
48
48
48
in
200
Cubic Feet
70
122270
Y
```
#### Request Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** | **Maps To** |
| --- | --- | --- | --- | --- | --- |
| sendLoadInvoicesRequest | Root element | Yes | 1 | N/A | Not Mapped |
| loadInvoices | Section Header | Yes | 1 | N/A | Not Mapped |
| loadInvoice | Section Header | Yes | 1:n | N/A | Customer Invoice |
| tradingPartnerId | Unique Transaction Initiator Id | Yes | 1 | String(50) | EDI Location – Name |
| shipmentId | Unique Shared Load Identifier | Yes | 1 | String(50) | Load – Load Number |
| invoiceNum | Invoice Number | Yes | 1 | String(50) | Customer Invoice – Name (Non-AS) / Billing – Proprietary Billing Number |
| loadNum | Unique Load Identifier from TMS/Carrier | Yes | 1 | String(50) | Load – Name |
| referenceNums | Section Header | Yes | 1 | N/A | Load Reference |
| paymentTerms | Payment Terms | Yes | 1 | Prepaid, Collect, or Third Party | Load – Payment Terms |
| pickupDate | Date Load Picked Up | Yes | 1 | Date | Stop – Arrival Date |
| deliveryDate | Date Load Delivered | Yes | 1 | Date | Stop – Departure Date |
| invoiceDate | Invoice Date | Yes | 1 | Date | Customer Invoice – Invoice Date |
| currencyCode | ISO Currency Code | Yes | 1 | String(3) | Customer Invoice – Currency ISO Code |
| charges | Section Header | Yes | 1 | N/A | Not Mapped |
| charge | Section Header | Yes | 1:n | N/A | Not Mapped |
| type | Type of Charge | Yes | 1 | Line Haul, Fuel, or Accessorial | Not Mapped |
| desc | Charge Description | Yes | 1 | String(100) | Not Mapped |
| code | Charge Code | No | 0:1 | String | Accessorial – Charge Code |
| lineItemDescription | Line itemized line haul charge (SMC3 LTL only) | No | 1 | String | Line Item – Item Description |
| freightClass | NMFC Class of line item (SMC3 LTL only) | No | 1 | String | Line Item – NMFC Class |
| nmfcNum | NMFC Number of line item (SMC3 LTL only) | No | 1 | String | Line Item – NMFC Number |
| qty | Charge Quantity Driver | Yes | 1 | Decimal | Customer Quote Freight Charge Item – Weight (SMC3 LTL only) or Customer Invoice Freight Charge Quantity or Customer Invoice Fuel Surcharge Quantity or Customer Invoice Accessorial Quantity |
| rate | Charge Rate | No | 1 | Decimal | Customer Invoice Accessorial – Rate OR Customer Quote Freight Charge Item – Rate (SMC3 LTL only) Or Customer Invoice Freight Charge Unit Price or Customer Invoice Fuel Surcharge Unit Price |
| rateType | Charge Rate Type | Yes | 1 | See Appendix E for allowed values | Customer Invoice Freight Charge Unit Or Customer Invoice Fuel Surcharge Unit Or Customer Invoice Accessorial Charge Unit |
| subAmount | Charge Amount before Discount (SMC3 LTL only) | No | 1 | Currency | Customer Quote Freight Charge Item – Freight Charge |
| amount | Charge Amount | Yes | 1 | Currency | Various fields on Customer Invoice, Customer Invoice Accessorial, Customer Invoice Adjustment, Customer Quote Freight Charge Item |
| discount | Discount Amount (SMC3 LTL only) | No | 1 | Currency | Customer Quote Freight Charge Item – Discount Amount |
| discountRate | Discount Rate (SMC3 LTL only) | No | 1 | Decimal | Customer Quote Freight Charge Item – Discount |
| ltlCharge | LTL Charge (for Line Haul charge type only) | Yes | 1 | ‘Y’ or ‘N’ | Will be ‘Y’ if line haul charge is for SMC3 LTL line haul charge. Will be ‘N’ for all other line haul charge |
| taxes | Section Header | No | 0:1 | N/A | Not Mapped |
| tax | Section Header | No | 0:n | N/A | Customer Invoice Tax |
| taxName | Tax Name | Yes | 1 | String(50) | Sales Tax – Name |
| taxType | Tax Type | Yes | 1 | GST, HST, QST | Sales Tax – Tax Type |
| taxRatePct | Tax Percentage | Yes | 1 | Decimal | Customer Invoice Tax – Tax Rate |
| taxAmount | Tax Amount to be Paid | Yes | 1 | Currency | Customer Invoice Tax – Tax Amount |
| taxIdNumber | Sender’s Tax Id | Yes | 1 | String(50) | Sales Tax – Tax ID Number |
| stops | Section Header | Yes | 1 | N/A | Stop |
| stop | Section Header | Yes | 2:n | N/A | Stop |
| stopNum | Stop Number | Yes – stops section No – charges section | 1 | Integer | Stop - Number |
| stopType | Stop Type | Yes | 1 | Pickup or Dropoff | Stop – Is Pickup Stop – Is Dropoff |
| company | Section Header | Yes | 1 | N/A | Account |
| companyName | Company Name | Yes | 1 | String(80) | Account – Name |
| addr | Address | Yes | 1 | String(100) | Account – Shipping Street |
| city | City | Yes | 1 | String(40) | Account – Shipping City |
| state | State or Province | Yes | 1 | String(2) | Account – Shipping State Code |
| zip | Zip Code | Yes | 1 | String(20) | Account – Shipping Postal Code |
| country | Country | Yes | 1 | 2-character ISO Code | Account – Shipping Country Code |
| companyId | Unique Company Identifier | Yes | 1 | String(50) | EDI Location – Name |
| Items | Section Header | Yes | 1 | N/A | Line Item |
#### Example Response XML
```xml
[COMMON RESPONSE STATUS SECTION]
```
#### Response Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** |
| --- | --- | --- | --- | --- |
| sendLoadInvoicesResponse | Root element | Yes | 1 | N/A |
### **GetLoadInvoices Operation (Inbound)**
This API call retrieves all EDI 210 and EDI 410 transactions in the customer’s queue from the Revenova Partner VAN.
> [!NOTE]
> No changes to the getLoadInvoices operation request or response for the Summer ‘25 release.
#### Example Request XML
```xml
[COMMON REQUEST AUTHORIZATION SECTION]
```
#### Request Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** |
| --- | --- | --- | --- | --- |
| getLoadInvoicesRequest | Root element | Yes | 1 | N/A |
> [!WARNING]
> The **Invoice Date** and **Invoice Due Date** fields must be formatted correctly to properly match. A separator must be included for both fields between the month, day, and year. Example: 2024-08-12.
#### Example Response XML
```xml
[COMMON RESPONSE STATUS SECTION]
123456
Load-12345
987654
222254
TESTINVNUM123
USD
2023-08-01
2023-08-15
XYZ Shipper
2333 Waukegan Rd.
Bannockburn
IL
60045
US
ABC Consignee
526 Beacon Street
Boston
MA
02215
US
ABC Shipper
526 Beacon Street
Boston
MA
02215
US
ABC Consignee
526 Beacon Street
Boston
MA
02215
US
ABC Biilee
526 Beacon Street
Boston
MA
02215
US
Line Haul
Net Line Haul
1200
1.00
Per Mile
1200.00
Fuel
Fuel Surcharge
1200
0.25
Per Mile
300.00
Accessorial
After Hours Delivery
1
75
Fixed Cost
75.00
2
Accessorial
Unknown Accessorial Name
5
75
Per Handling Unit
375.00
224466
Load-9898
988894
TESTINVNUM321
USD
2023-08-03
2023-08-18
XYZ Shipper
2333 Waukegan Rd.
Bannockburn
IL
60045
US
ABC Consignee
526 Beacon Street
Boston
MA
02215
US
ABC Shipper
526 Beacon Street
Boston
MA
02215
US
ABC Consignee
526 Beacon Street
Boston
MA
02215
US
ABC Biilee
526 Beacon Street
Boston
MA
02215
US
Line Haul
Net Line Haul
1100
1.00
Per Mile
1100.00
Fuel
Fuel Surcharge
1100
0.25
Per Mile
275.00
Commodity AAA
50
10
0.25
Per Mile
100
100
lbs
60# Red Potato
55
20
1.25
Per Mile
100
100
lbs
5/10 Poly Russet Potato
60
20
1.25
Per Mile
100
100
lbs
```
#### Response Element Definitions
| **Element/Attribute** | **Description** | **Required** | **Repeats** | **Type** | **Maps To** |
| --- | --- | --- | --- | --- | --- |
| getLoadInvoicesResponse | Root element | Yes | 1 | N/A | Not Mapped |
| loadInvoices | Section Header | Yes | 1 | N/A | Not Mapped |
| loadInvoice | Section Header | No | 0:n | N/A | Not Mapped |
| carrierTradingPartnerId | Unique Transaction Initiator Id | Yes | 1 | String(50) | EDI Location – Name |
| shipmentId | Unique Shared Load Identifier | Yes | 1 | String(50) | Load – Load Number |
| proNumber | PRO Number | No | 0:1 | String(40) example: “PRO1234567” | Load – PRO Number |
| waybillNumber | Waybill Number | No | 0:1 | String(40) | Load - Waybill Number |
| invoiceNum | Invoice Number | Yes | 1 | String(100) | Vendor Invoice – Payee Reference |
| currencyCode | ISO Currency Code | Yes | 1 | String(3) | Vendor Invoice – Currency ISO Code |
| invoiceDate | Invoice Date | Yes | 1 | Date | Vendor Invoice – Invoice Date |
| invoiceDueDate | Invoice Due Date | Yes | 1 | Date | Vendor Invoice – Invoice Due Date |
| origin | Section Header | No | 1 | N/A | Not Mapped |
| originName | Origin Name | No | 1 | Text(80) | Vendor Invoice - Origin Name |
| originStreet | Origin Street Address | No | 1 | Text Area(255) | Vendor Invoice - Origin Street |
| originCity | Origin City | No | 1 | Text(40) | Vendor Invoice - Origin City |
| originState | Origin State | No | 1 | Picklist | Vendor Invoice - Origin State |
| originPostalCode | Origin Postal Code | No | 1 | Text(20) | Vendor Invoice - Origin Postal Code |
| originCountry | Origin Country | No | 1 | 2-character ISO Code | Vendor Invoice - Origin Country |
| destination | Section Header | No | 1 | N/A | Not Mapped |
| destinationName | Destination Name | No | 1 | Text(80) | Vendor Invoice - Destination Name |
| destinationStreet | Destination Street | No | 1 | Text Area(255) | Vendor Invoice - Destination Street |
| destinationCity | Destination City | No | 1 | Text(40) | Vendor Invoice - Destination City |
| destinationState | Destination State | No | 1 | Picklist | Vendor Invoice - Destination State |
| destinationPostalCode | Destination Postal Code | No | 1 | Text(20) | Vendor Invoice - Destination Postal Code |
| destinationCountry | Destination Country | No | 1 | 2-character ISO Code | Vendor Invoice - Destination Country |
| ultimateShipper | Section Header | No | 0:1 | N/A | Not Mapped |
| ultimateShipperName | Company Name | Yes | 1 | String(80) | Vendor Invoice - Ultimate Shipper Name |
| ulstimateShipperStreet | Address | No | 0:1 | String(255) | Vendor Invoice - Ultimate Shipper Street |
| ultimateShipperCity | City | No | 0:1 | String(40) | Vendor Invoice - Ultimate Shipper City |
| ultimateShipperState | State or Province | No | 0:1 | String(2) | Vendor Invoice - Ultimate Shipper State |
| ultimateShipperPostalCode | Zip Code | No | 0:1 | String(20) | Vendor Invoice - Ultimate Shipper Postal Code |
| ultimateShipperCountry | Country | No | 0:1 | Picklist | Vendor Invoice - Ultimate Shipper Country |
| ultimateConsignee | Section Header | No | 0:1 | N/A | Not Mapped |
| ultimateConsigneeName | Company Name | Yes | 1 | String(80) | Vendor Invoice - Ultimate Consignee Name |
| ultimateConsigneeStreet | Address | No | 0:1 | String(255) | Vendor Invoice - Ultimate Consignee Street |
| ultimateConsigneeCity | City | No | 0:1 | String(40) | Vendor Invoice - Ultimate Consignee City |
| ultimateConsigneeState | State or Province | No | 0:1 | String(2) | Vendor Invoice - Ultimate Consignee State |
| ultimateConsigneePostalCode | Zip Code | No | 0:1 | String(20) | Vendor Invoice - Ultimate Consignee Postal Code |
| ultimateConsigneeCountry | Country | No | 0:1 | 2-character ISO Code | Vendor Invoice - Ultimate Consignee Country |
| billTo | Section Header | No | 0:1 | N/A | Not Mapped |
| billToName | Company Name | Yes | 1 | String(80) | Vendor Invoice - Carrier Bill To Name |
| billToStreet | Address | No | 0:1 | String(255) | Vendor Invoice - Carrier Bill To Street |
| billToCity | City | No | 0:1 | String(40) | Vendor Invoice - Carrier Bill To City |
| billToState | State or Province | No | 0:1 | String(2) | Vendor Invoice - Carrier Bill To State |
| billToPostalCode | Zip Code | No | 0:1 | String(20) | Vendor Invoice - Carrier Bill To Postal Code |
| billToCountry | Country | No | 0:1 | 2-character ISO Code | Vendor Invoice - Carrier Bill To Country |
| charges | Section Header | Yes | 1 | N/A | Not Mapped |
| charge | Section Header | Yes | 1:n | N/A | Not Mapped |
| type | Type of Charge | Yes | 1 | Line Haul, Fuel, or Accessorial | Not Mapped |
| desc | Charge Description | Yes | 1 | String(100) | Not Mapped |
| qty | Charge Quantity | No | 1 | Decimal | Vendor Invoice Accessorial - Quantity |
| rate | Charge Rate | No | 1 | Decimal | Vendor Invoice Accessorial – Unit Price |
| rateType | Charge Rate Type | No | 1 | See Appendix E for allowed values | Vendor Invoice Accessorial - Unit |
| amount | Charge Amount | Yes | 1 | Currency | Vendor Invoice – Line Haul, Vendor Invoice – Fuel Surcharge, Vendor Invoice Accessorial – Charge |
| freightChargeItems | Section Header | Yes | 1 | N/A | Not Mapped |
| freightChargeItem | Section Header | No | 1:n | N/A | Not Mapped |
| desc | Item Description | No | 1 | Text(255) | Vendor Invoice Freight Charge Item - Item Description |
| freightClass | NMFC Class | No | 1 | Picklist | Vendor Invoice Freight Charge Item - NMFC Class (Rated As) |
| qty | Number of units | No | 1 | Number(16, 2) | Vendor Invoice Freight Charge Item - Quantity |
| rate | Cost per unit | No | 1 | Currency(10, 2) | Vendor Invoice Freight Charge Item - Rate |
| rateType | Freight Charge Item Rate Type | No | 1 | Picklist | Vendor Invoice Freight Charge Item - Unit |
| amount | Freight Charge Item Amount | No | 1 | Currency(16, 2) | Vendor Invoice Freight Charge Item - Freight Charge |
| weightUnits | Unit of measure (“lb” or “kg”)" | No | 1 | Picklist | Vendor Invoice Freight Charge Item - Weight Units |
| stopNum | Stop Number | No | 1 | Integer | Stop – Number |
## **Data Validation**
## **Implementation Notes**
1. All XML element and attribute names are in “camel case”, e.g., “helloWorld.”
2. All HTTP traffic must be TLS encrypted. No SSL is allowed as it is insecure.
3. All date elements are in “YYYY-MM-DD” or “MM/DD/YYYY” format and you must be able to handle both formats coming from request packets. See the packet examples for more information.
4. All time elements are in “HH:MM” (24-hour) time format in the local time zone of the current element context.
5. “LT” (local time) is the only supported time zone value except when processed on incoming EDI 214 transactions.
6. All currency fields are two-decimal precision.
## **Appendix A – Message Codes/Messages**
| **Message Code** | **Message** |
| --- | --- |
| 100 | An unknown service error occurred. |
| 101 | Invalid credentials were provided. |
| 102 | An invalid trading partner was provided. |
| 103 | Transaction failed validation: [specific validation failure] |
| 104 | Required field is missing: [specific field name(s)] |
## **Appendix B – Handling/Packaging Units**
| Bags |
| --- |
| Bales |
| Barrels |
| Baskets |
| Bins |
| Bottles |
| Boxes |
| Bundles |
| Canisters |
| Carboys |
| Cartons |
| Cases |
| Coils |
| Containers |
| Crates |
| Cylinders |
| Drums |
| Kegs |
| Other |
| Packages |
| Pallets |
| Pieces |
| Reels |
| Rolls |
| Skids |
| Spools |
| Tanks |
| Trays |
| Truckloads |
| Tubes |
| Units |
| Vats |
## Appendix C – Canadian Province Codes
| Alberta | AB |
| --- | --- |
| British Columbia | BC |
| Manitoba | MB |
| New Brunswick | NB |
| Newfoundland and Labrador | NL |
| Nova Scotia | NS |
| Northwest Territories | NT |
| Nunavut | NU |
| Ontario | ON |
| Prince Edward Island | PE |
| Quebec | QC |
| Saskatchewan | SK |
| Yukon Territories | YT |
## **Appendix D – Mexican State Codes**
| Aguascalientes | AG |
| --- | --- |
| Baja California | BC |
| Baja California Sur | BS |
| Chihuahua | CH |
| Colima | CL |
| Campeche | CM |
| Coahuila | CO |
| Chiapas | CS |
| Federal District | DF |
| Durango | DG |
| Guerrero | GR |
| Guanajuato | GT |
| Hidalgo | HG |
| Jalisco | JA |
| Mexico State | ME |
| Michoacán | MI |
| Morelos | MO |
| Nayarit | NA |
| Nuevo León | NL |
| Oaxaca | OA |
| Puebla | PB |
| Querétaro | QE |
| Quintana Roo | QR |
| Sinaloa | SI |
| San Luis Potosí | SL |
| Sonora | SO |
| Tabasco | TB |
| Tlaxcala | TL |
| Tamaulipas | TM |
| Veracruz | VE |
| Yucatán | YU |
| Zacatecas | ZA |
## **Appendix E – Invoice Accessorial Allowed Units**
| Fixed Cost |
| --- |
| Percent of Amount |
| Per Cubic Foot |
| Per Cubic Meter |
| Per Cwt |
| Per Day |
| Per Equipment Type |
| Per Gallon |
| Per Handling Unit |
| Per Hour |
| Per Kilogram |
| Per Kilometer |
| Per Linear Foot |
| Per Liter |
| Per Mile |
| Per Packaging Unit |
| Per Pound |
| Per Square Foot |
| Per Square Meter |
| Per Stop |
| Per Ton |
| Per Volume Unit |