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 will be utilized by many TMS customers.
Supported Transactions
The API will support the following EDI transactions:
Inbound EDI 204: Motor Carrier Load Tender
Outbound EDI 990: Response to Load Tender
Outbound EDI 214: Shipment Status Report
Outbound EDI 210: Motor Carrier Freight Details and Invoice
EDI 997: Functional Acknowledgment
Outbound EDI 204: Motor Carrier Load Tender
Inbound EDI 990: Response to Load Tender
Inbound EDI 214: Shipment Status Report
Inbound EDI 210: Motor Carrier Freight Invoice
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
Trading Partner(s) sends 1-to-n EDI 204 (Load Tender) transactions to Trading Partner VAN.
Trading Partner VAN forwards 1-to-n EDI 204 transactions to Revenova Partner VAN.
Revenova Partner VAN sends 1-to-n EDI 997 transactions back to the Trading Partner VAN.
Revenova Partner VAN stages EDI 204 transactions in TMS customer-specific queue.
Revenova TMS invokes “GetLoadTenders” API call. Revenova Partner VAN returns 0-100 accumulated EDI 204 transactions translated into API XML format.
The queue is emptied after n GetLoadTenders calls, and then starts to “fill” with new transactions.
Note: A maximum of 100 transactions should be returned by Revenova Partner VAN per method invocation.
Outbound EDI 990 Process
Revenova TMS invokes “SendLoadTenderResponses” API call to send 1-to-n EDI 990 (Tender Response) transactions to Revenova Partner VAN in API XML format.
Revenova Partner VAN translates XML transactions into EDI 990 format and forwards them to appropriate Trading Partner VAN(s) and/or Trading Partner(s).
No EDI 997 is needed back to TMS, as the response XML packet is sufficient.
Outbound EDI 214 Process
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.
Revenova Partner VAN translates XML transactions into EDI 214 format and forwards them to appropriate Trading Partner VAN(s) and/or Trading Partner(s).
No EDI 997 is needed back to TMS, as the response XML packet is sufficient.
Outbound EDI 210 Process
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.
Revenova Partner VAN translates XML transactions into EDI 210 format and forwards them to appropriate Trading Partner VAN(s) and/or Trading Partner(s).
No EDI 997 is needed back to TMS, as the response XML packet is sufficient.
Outbound EDI 204 Process
Revenova TMS invokes “SendLoadTender” API call to send 1 EDI 204 (Load Tender) transaction to Revenova Partner VAN in API XML format.
Revenova Partner VAN translates XML transaction into EDI 204 format and forwards to appropriate Trading Partner VAN and/or Trading Partner carrier.
No EDI 997 is needed back to TMS, as the response XML packet is sufficient.
Inbound EDI 990 Process
Trading Partner carrier(s) sends 1-to-n EDI 990 (Tender Response) transactions to Trading Partner VAN.
Trading Partner VAN forwards 1-to-n EDI 990 transactions to Revenova Partner VAN.
Revenova Partner VAN sends 1-to-n EDI 997 transactions back to the Trading Partner VAN.
Revenova Partner VAN stages EDI 990 transactions in TMS customer-specific queue.
Revenova TMS invokes “GetLoadTenderResponses” API call. Revenova Partner VAN returns all accumulated EDI 990 transactions translated into API XML format.
The queue is emptied after the GetLoadTenderResponses call, and then starts to “fill” with new transactions.
Inbound EDI 214 Process
Trading Partner carrier(s) sends 1-to-n EDI 214 (Shipment Status) transactions to Trading Partner VAN.
Trading Partner VAN forwards 1-to-n EDI 214 transactions to Revenova Partner VAN.
Revenova Partner VAN sends 1-to-n EDI 997 transactions back to the Trading Partner VAN.
Revenova Partner VAN stages EDI 214 transactions in TMS customer-specific queue.
Revenova TMS invokes “GetLoadStatusMessages” API call. Revenova Partner VAN returns 0-to-100 accumulated EDI 214 transactions translated into API XML format.
The queue is emptied after n invocations of the GetLoadStatusMessages call, and then starts to “fill” with new transactions.
Note: A maximum of 100 transactions should be returned by Revenova Partner VAN per method invocation.
Inbound EDI 210 Process
Trading Partner(s) sends 1-to-n EDI 210 (Freight Invoice) transactions to Trading Partner VAN.
Trading Partner VAN forwards 1-to-n EDI 210 transactions to Revenova Partner VAN.
Revenova Partner VAN sends 1-to-n EDI 997 transactions back to the Trading Partner VAN.
Revenova Partner VAN stages EDI 210 transactions in TMS customer-specific queue.
Revenova TMS invokes “GetLoadInvoices” API call. Revenova Partner VAN returns all accumulated EDI 210 transactions translated into API XML format.
The queue is emptied after n GetLoadInvoices calls, and then starts to “fill” with new transactions.
Transaction Request-Response Specifications
Upgrading to the Fall ‘24 release includes changes to the following EDI transactions.
Inbound 204
poNum
bolNum
orderNum
referenceNums (for each Line Item)
Inbound 214
stopNum
eventTimeZone
lat/lon
Outbound 214
stopNum
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
<auth>
<custId>intell</custId>
<pwd>abcdef12345</pwd>
</auth>
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
<status>
<statusCode>ERROR</statusCode>
<messageCode>100</messageCode>
<message>abcdef</message>
</status>
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.
The following changes were added to the GetLoadTenders Operation (Inbound) with the Fall ‘24 release.
Support for multiple Reference Numbers.
poNum
bolNum
orderNum
Reference Number elements are processed for each Line Item.
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO94949494</value>
</referenceNum>
</referenceNums>
<poNum>PO-1919191</poNum>
<bolNum>42645</bolNum>
<orderNum>098781237</orderNum>
Example Request XML
<getLoadTendersRequest>
[COMMON REQUEST AUTHORIZATION SECTION]
</getLoadTendersRequest>
Request Element Definitions
Element/Attribute | Description | Required | Repeats | Type |
|---|---|---|---|---|
getLoadTendersRequest | Root element | Yes | 1 | N/A |
Example Response XML
<getLoadTenderResponse>
[COMMON RESPONSE STATUS SECTION]
<loadTenders>
<loadTender>
<tradingPartnerId>123456</tradingPartnerId>
<shipmentId>ABC81818181</shipmentId>
<purpose>Original</purpose>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO-1919191</value>
</referenceNum>
<referenceNum>
<type>SCA</type>
<text>SCAC</text>
<value>DIV1</value>
</referenceNum>
<referenceNum>
<type>BM</type>
<text>Reference Number</text>
<value>ANC1919191</value>
</referenceNum>
<referenceNum>
<type>CR</type>
<text>Reference Number</text>
<value>ORD1919191</value>
</referenceNum>
</referenceNums>
<poNum>PO-1919191</poNum>
<bolNum>42645</bolNum>
<orderNum>098781237</orderNum>
<mode>Truckload</mode>
<equipmentType>53’ Dry Van</equipmentType>
<specialInstructions>
<specialInstruction>Hello</specialInstruction>
<specialInstruction>World</specialInstruction>
</specialInstructions>
<paymentTerms>Collect</paymentTerms>
<respondByDate>2015-12-23</respondByDate>
<respondByTime>23:30</respondByTime>
<timeZone>LT</timeZone>
<totalCharge>2500.00</totalCharge>
<cargoValue>50000.00</cargoValue>
<currencyCode>USD</currencyCode>
<insuranceAmount>250.00</insuranceAmount>
<mileage>250</mileage>
<billTo>
<companyName>ABC Company</companyName>
<addr>79 W. Monroe St.</addr>
<city>Chicago</city>
<state>IL</state>
<zip>60603</zip>
<country>US</country>
<companyId>123456789</companyId>
<contact>
<contactName>George Smiley</contactName>
<phone>312-888-9999</phone>
<fax>312-888-9999</fax>
<email>gsmiley@mi6.org</email>
</contact>
</billTo>
<stops>
<stop>
<stopNum>1</stopNum>
<stopType>pickup</stopType>
<stopInstructions>go to dock 122</stopInstructions>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO94949494</value>
</referenceNum>
</referenceNums>
<apptRequired>Y</apptRequired>
<expectedDate>2015-12-22</expectedDate>
<expectedTimeStart>08:00</expectedTimeStart>
<expectedTimeEnd>16:00</expectedTimeEnd>
<timeZone>LT</timeZone>
<company>
<companyName>ABC Company</companyName>
<addr>79 W. Monroe St.</addr>
<city>Chicago</city>
<state>IL</state>
<zip>60603</zip>
<country>US</country>
<companyId>123456789</companyId>
</company>
<contacts>
<contact>
<contactName>George Smiley</contactName>
<phone>312-888-9999</phone>
<fax>312-888-9999</fax>
<email>gsmiley@mi6.org</email>
</contact>
<contact>
<contactName>Percy Allelline</contactName>
<phone>312-888-9999</phone>
<fax>312-888-9999</fax>
<email>percy@mi6.org</email>
</contact>
</contacts>
<accessorials>
<accessorial>
<name>Lumper</name>
<code>FF</code>
<charge>100.00</charge>
</accessorial>
<accessorial>
<name>Lift Gate</name>
<code>BB</code>
<charge>200.00</charge>
</accessorial>
</accessorials>
</stop>
<stop>
<stopNum>2</stopNum>
<stopType>dropoff</stopType>
<stopInstructions>go to dock 422</stopInstructions>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO94949494</value>
</referenceNum>
</referenceNums>
<apptRequired>Y</apptRequired>
<expectedDate>2015-12-22</expectedDate>
<expectedTimeStart>08:00</expectedTimeStart>
<expectedTimeEnd>16:00</expectedTimeEnd>
<timeZone>LT</timeZone>
<company>
<companyName>DEF Company</companyName>
<addr>579 W. Monroe St.</addr>
<city>Chicago</city>
<state>IL</state>
<zip>60603</zip>
<country>US</country>
<companyId>123456789</companyId>
</company>
<contacts>
<contact>
<contactName>George Smiley</contactName>
<phone>312-888-9999</phone>
<fax>312-888-9999</fax>
<email>gsmiley@mi6.org</email>
</contact>
<contact>
<contactName>Percy Allelline</contactName>
<phone>312-888-9999</phone>
<fax>312-888-9999</fax>
<email>percy@mi6.org</email>
</contact>
</contacts>
<accessorials>
<accessorial>
<name>Lumper</name>
<code>FF</code>
<charge>200.00</charge>
</accessorial>
<accessorial>
<name>Lift Gate</name>
<code>BB</code>
<charge>50.00</charge>
</accessorial>
</accessorials>
</stop>
</stops>
<items>
<item>
<pickupStopNum>1</pickupStopNum>
<dropoffStopNum>2</dropoffStopNum>
<itemNum>123456</itemNum>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO94949494</value>
</referenceNum>
</referenceNums>
<desc>ping pong balls</desc>
<handlingUnitCount>10</handlingUnitCount>
<handlingUnits>Pallets</handlingUnits>
<packagingUnitCount>10</packagingUnitCount>
<packagingUnits>Pieces</packagingUnits>
<weight>20000</weight>
<weightUnits>lbs</weightUnits>
<length>48</length>
<width>48</width>
<height>48</height>
<dimensionUnits>in</dimensionUnits>
<volume>200</volume>
<volumeUnits>Cubic Feet</volumeUnits>
<nmfcClass>70</nmfcClass>
<nmfcNum>122270</nmfcNum>
<isHazardousMaterials>Y</isHazardousMaterials>
<hazMatNumberType>UN</hazMatNumberType>
<hazMatNumber>1234</hazMatNumber>
<hazMatClassDivision>1.1</hazMatClassDivision>
<hazMatPackagingGroup>III</hazMatPackagingGroup>
<hazMatContactName>George Smiley</hazMatContactName>
<hazMatContactPhone>312-888-9999</hazMatContactPhone>
<hazMatContactEmail>George@mi6.com</hazMatContactEmail>
</item>
<item>
<pickupStopNum>1</pickupStopNum>
<dropoffStopNum>2</dropoffStopNum>
<itemNum>AB123456</itemNum>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO18181818</value>
</referenceNum>
</referenceNums>
<desc>foosballs</desc>
<handlingUnitCount>10</handlingUnitCount>
<handlingUnits>Pallets</handlingUnits>
<packagingUnitCount>10</packagingUnitCount>
<packagingUnits>Pieces</packagingUnits>
<weight>20000</weight>
<weightUnits>lbs</weightUnits>
<length>48</length>
<width>48</width>
<height>48</height>
<dimensionUnits>in</dimensionUnits>
<volume>200</volume>
<volumeUnits>Cubic Feet</volumeUnits>
<nmfcClass>70</nmfcClass>
<nmfcNum>122270</nmfcNum>
<isHazardousMaterials>N</isHazardousMaterials>
</item>
</items>
<charges>
<charge>
<type>Line Haul</type>
<desc>Line Haul</desc>
<amount>5000.00</amount>
</charge>
<charge>
<type>Fuel</type>
<desc>Fuel Surcharge</desc>
<amount>200.00</amount>
</charge>
<charge>
<type>Accessorial</type>
<desc>Lift Gate</desc>
<amount>100.00</amount>
</charge>
<charge>
<type>Accessorial</type>
<desc>Lumper</desc>
<amount>200.00</amount>
</charge>
<charges>
</loadTender>
</loadTenders>
</getLoadTenderResponse>SendLoadTender Operation (Outbound)
This API call sends one EDI 204 transaction from Revenova to the Revenova Partner VAN.
No changes to the outbound EDI 204 Request or Response for the Fall ‘24 release.
Example Request XML
<sendLoadTenderRequest>
[COMMON REQUEST AUTHORIZATION SECTION]
<loadTender>
<carrierTradingPartnerId>11223344</carrierTradingPartnerId>
<carrierSCAC>SCAC</carrierSCAC>
<carrierQuoteId>11991199</carrierQuoteId>
<shipmentId>ABC81818181</shipmentId>
<purpose>Original</purpose>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO-1919191</value>
</referenceNum>
<referenceNum>
<type>PR</type>
<text>Reference Number</text>
<value>1919191</value>
</referenceNum>
<referenceNum>
<type>BM</type>
<text>Reference Number</text>
<value>ANC1919191</value>
</referenceNum>
<referenceNum>
<type>CR</type>
<text>Reference Number</text>
<value>ORD1919191</value>
</referenceNum>
</referenceNums>
<poNum>3939393939</poNum>
<orderNum>11122393939</orderNum>
<bolNum>282823939</bolNum>
<mode>Intermodal</mode>
<equipmentType>53’ Dry Van</equipmentType>
<specialInstructions>
<specialInstruction>Hello</specialInstruction>
<specialInstruction>World</specialInstruction>
</specialInstructions>
<paymentTerms>Collect</paymentTerms>
<respondByDate>2015-12-23</respondByDate>
<respondByTime>23:30</respondByTime>
<timeZone>LT</timeZone>
<cargoValue>50000.00</cargoValue>
<insuranceAmount>250.00</insuranceAmount>
<currencyCode>USD</currencyCode>
<mileage>250</mileage>
<customerBillTo>
<companyName>DEF Company</companyName>
<addr>100 W. Monroe St.</addr>
<city>Chicago</city>
<state>IL</state>
<zip>60603</zip>
<country>US</country>
</customerBillTo>
<billTo>
<companyName>ABC Company</companyName>
<addr>79 W. Monroe St.</addr>
<city>Chicago</city>
<state>IL</state>
<zip>60603</zip>
<country>US</country>
<companyId>123456789</companyId>
<contact>
<contactName>George Smiley</contactName>
<phone>312-888-9999</phone>
<fax>312-888-9999</fax>
<email>gsmiley@mi6.org</email>
</contact>
</billTo>
<stops>
<stop>
<stopNum>1</stopNum>
<stopType>pickup</stopType>
<stopInstructions>go to dock 122</stopInstructions>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO94949494</value>
</referenceNum>
</referenceNums>
<apptRequired>Y</apptRequired>
<expectedDate>2015-12-22</expectedDate>
<expectedTimeStart>08:00</expectedTimeStart>
<expectedTimeEnd>16:00</expectedTimeEnd>
<timeZone>LT</timeZone>
<company>
<companyName>ABC Company</companyName>
<addr>79 W. Monroe St.</addr>
<city>Chicago</city>
<state>IL</state>
<zip>60603</zip>
<country>US</country>
<companyId>123456789</companyId>
</company>
<contacts>
<contact>
<contactName>George Smiley</contactName>
<phone>312-888-9999</phone>
<fax>312-888-9999</fax>
<email>gsmiley@mi6.org</email>
</contact>
<contact>
<contactName>Percy Allelline</contactName>
<phone>312-888-9999</phone>
<fax>312-888-9999</fax>
<email>percy@mi6.org</email>
</contact>
</contacts>
<accessorials>
<accessorial>
<name>Lumper</name>
</accessorial>
<accessorial>
<name>Lift Gate</name>
</accessorial>
</accessorials>
</stop>
<stop>
<stopNum>2</stopNum>
<stopType>dropoff</stopType>
<stopInstructions>go to dock 422</stopInstructions>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO94949494</value>
</referenceNum>
</referenceNums>
<apptRequired>Y</apptRequired>
<expectedDate>2015-12-22</expectedDate>
<expectedTimeStart>08:00</expectedTimeStart>
<expectedTimeEnd>16:00</expectedTimeEnd>
<timeZone>LT</timeZone>
<company>
<companyName>DEF Company</companyName>
<addr>579 W. Monroe St.</addr>
<city>Chicago</city>
<state>IL</state>
<zip>60603</zip>
<country>US</country>
<companyId>123456789</companyId>
</company>
<contacts>
<contact>
<contactName>George Smiley</contactName>
<phone>312-888-9999</phone>
<fax>312-888-9999</fax>
<email>gsmiley@mi6.org</email>
</contact>
<contact>
<contactName>Percy Allelline</contactName>
<phone>312-888-9999</phone>
<fax>312-888-9999</fax>
<email>percy@mi6.org</email>
</contact>
</contacts>
<accessorials>
<accessorial>
<name>Lumper</name>
</accessorial>
<accessorial>
<name>Lift Gate</name>
</accessorial>
</accessorials>
</stop>
</stops>
<items>
<item>
<pickupStopNum>1</pickupStopNum>
<dropoffStopNum>2</dropoffStopNum>
<itemNum>123456</itemNum>
<desc>ping pong balls</desc>
<handlingUnitCount>10</handlingUnitCount>
<handlingUnits>Pallets</handlingUnits>
<packagingUnitCount>10</packagingUnitCount>
<packagingUnits>Pieces</packagingUnits>
<weight>20000</weight>
<weightUnits>lbs</weightUnits>
<length>48</length>
<width>48</width>
<height>48</height>
<dimensionUnits>in</dimensionUnits>
<volume>200</volume>
<volumeUnits>Cubic Feet</volumeUnits>
<nmfcClass>70</nmfcClass>
<nmfcNum>122270</nmfcNum>
<isHazardousMaterials>Y</isHazardousMaterials>
<hazMatContactName>George Smiley</hazMatContactName>
<hazMatContactPhone>312-888-9999</hazMatContactPhone>
<hazMatContactEmail>George@mi6.com</hazMatContactEmail>
</item>
<item>
<pickupStopNum>1</pickupStopNum>
<dropoffStopNum>2</dropoffStopNum>
<itemNum>AB123456</itemNum>
<desc>foosballs</desc>
<handlingUnitCount>10</handlingUnitCount>
<handlingUnits>Pallets</handlingUnits>
<packagingUnitCount>10</packagingUnitCount>
<packagingUnits>Pieces</packagingUnits>
<weight>20000</weight>
<weightUnits>lbs</weightUnits>
<length>48</length>
<width>48</width>
<height>48</height>
<dimensionUnits>in</dimensionUnits>
<volume>200</volume>
<volumeUnits>Cubic Feet</volumeUnits>
<nmfcClass>70</nmfcClass>
<nmfcNum>122270</nmfcNum>
<isHazardousMaterials>N</isHazardousMaterials>
</item>
</items>
<charges>
<charge>
<type>Line Haul</type>
<desc>Line Haul</desc>
<amount>5000.00</amount>
</charge>
<charge>
<type>Fuel</type>
<desc>Fuel Surcharge</desc>
<amount>200.00</amount>
</charge>
<charge>
<type>Accessorial</type>
<desc>Lift Gate</desc>
<amount>100.00</amount>
</charge>
<charge>
<type>Accessorial</type>
<desc>Lumper</desc>
<amount>200.00</amount>
</charge>
<charges>
</loadTender>
</sendLoadTenderRequest>Example Response XML
<sendLoadTenderResponse>
[COMMON RESPONSE STATUS SECTION]
</sendLoadTenderResponse>Response Element Definitions
Element/Attribute | Description | Required | Repeats | Type |
|---|---|---|---|---|
sendLoadTenderResponse | Root element | Yes | 1 | N/A |
EDI 204 Request/Response 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 Id | Yes | 1 | String(40) | Carrier Quote – Quote/Contract Id |
shipmentId | Unique Shared Load Identifier | Yes | 1 | String(50) | Load – PO Number (usually) |
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 |
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 |
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) |
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 |
companyId | Unique Company Identifier | Yes | 1 | String(50) | Not Mapped |
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 |
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 |
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 |
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 <referenceNum> element if present.
SendLoadTenderResponses Operation (Outbound)
This API call sends EDI 990 data for one or more loads to the Revenova Partner VAN.
No changes to the outbound EDI 990 Request or Response for the Fall ‘24 release.
Example Request XML
<sendLoadTenderResponsesRequest>
[COMMON REQUEST AUTHORIZATION SECTION]
<loadTenderResponses>
<loadTenderResponse>
<tradingPartnerId>123456</tradingParnterId>
<shipmentId>ABC81818181</shipmentId>
<loadNum>Load-9989899</loadNum>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO-1919191</value>
<referenceNum>
<referenceNum>
<type>PR</type>
<text>Reference Number</text>
<value>1919191</value>
<referenceNum>
<referenceNum>
<type>BM</type>
<text>Reference Number</text>
<value>ANC1919191</value>
<referenceNum>
<referenceNum>
<type>CR</type>
<text>Reference Number</text>
<value>ORD1919191</value>
<referenceNum>
</referenceNums>
<status>Decline</status>
<declineReasonCode>TTI</declineReasonCode>
</loadTenderResponse>
</loadTenderResponses>
</sendLoadTenderResponsesRequest>
Request Element Definitions
Element/Attribute
| Description
| Required
| Repeats
| 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 - PO Number (usually) |
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
<sendLoadTenderResponsesResponse>
[COMMON RESPONSE STATUS SECTION]
</sendLoadTenderResponsesResponse>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 990 load tender responses from the Revenova Partner VAN.
No changes to the inbound EDI 990 Request or Response for the Fall ‘24 release.
Example Request XML
<getLoadTenderResponsesRequest>
[COMMON REQUEST AUTHORIZATION SECTION]
</getLoadTenderResponsesRequest>Example Request XML
<getLoadTenderResponsesResponse>
[COMMON RESPONSE STATUS SECTION]
<loadTenderResponses>
<loadTenderResponse>
<carrierTradingPartnerId>123456</carrierTradingPartnerId>
<shipmentId>ABC81818181</shipmentId>
<status>Decline</status>
<declineReasonCode>IR</declineReasonCode>
</loadTenderResponse>
</loadTenderResponses>
</getLoadTenderResponsesResponse>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 – Name |
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 |
SendLoadStatusMessages Operation (Outbound)
This API call sends EDI 214 data for one or more loads to the Revenova Partner VAN.
The following change is added to the SendLoadStatus Operation (Outbound) with the Fall ‘24 release. The Stop Number is included in the Current Location element on all outbound EDI 214 transactions.
<currentLocation>
<stopNum>2</stopNum>
Example Request XML
<sendLoadStatusMessagesRequest>
[COMMON REQUEST AUTHORIZATION SECTION]
<loadStatusMessages>
<loadStatusMessage>
<tradingPartnerId>123456</tradingParnterId>
<shipmentId>ABC81818181</shipmentId>
<loadNum>LD-3939393</loadNum>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO-1919191</value>
<referenceNum>
<referenceNum>
<type>PR</type>
<text>Reference Number</text>
<value>1919191</value>
<referenceNum>
<referenceNum>
<type>BM</type>
<text>Reference Number</text>
<value>ANC1919191</value>
<referenceNum>
<referenceNum>
<type>CR</type>
<text>Reference Number</text>
<value>ORD1919191</value>
<referenceNum>
</referenceNums>
<currentLocation>
<status>In Transit</status>
<stopNum>2</stopNum>
<reason>BG</reason>
<statusDate>03/04/2018</statusDate>
<statusTime>20:00</statusTime>
<timeZone>LT</timeZone>
<city>LA PUENTE</city>
<state>CA</state>
<zip>91746-3017</zip>
<country>US</country>
<lat>34.0200</lat>
<lon>-117.9495</lon>
</currentLocation>
<stops>
<stop>
<stopNum>1</stopNum>
<stopType>pickup</stopType>
<stopInstructions>go to dock 122</stopInstructions>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO94949494</value>
</referenceNum>
</referenceNums>
<apptRequired>Y</apptRequired>
<expectedDate>2015-12-22</expectedDate>
<expectedTimeStart>08:00</expectedTimeStart>
<expectedTimeEnd>16:00</expectedTimeEnd>
<timeZone>LT</timeZone>
<company>
<companyName>ABC Company</companyName>
<addr>79 W. Monroe St.</addr>
<city>Chicago</city>
<state>IL</state>
<zip>60603</zip>
<country>US</country>
<companyId>123456789</companyId>
</company>
<events>
<event>
<status>Appointment</status>
<reason>BG</reason>
<statusDate>2015-12-22</statusDate>
<statusTime>08:30-09:30</statusTime>
<timeZone>LT</timeZone>
<lat>34.0200</lat>
<lon>-117.9495</lon>
</event>
<event>
<status>Arrived</status>
<reason>BG</reason>
<statusDate>2015-12-22</statusDate>
<statusTime>23:30</statusTime>
<timeZone>LT</timeZone>
<lat>34.0200</lat>
<lon>-117.9495</lon>
</event>
<event>
<status>Departed</status>
<reason>BG</reason>
<statusDate>2015-12-22</statusDate>
<statusTime>23:45</statusTime>
<timeZone>LT</timeZone>
<lat>34.0200</lat>
<lon>-117.9495</lon>
</event>
</events>
</stop>
</stops>
<loadStatusMessage>
</loadStatusMessages>
</sendLoadStatusMessagesRequest>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 – PO Number (usually) |
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
<sendLoadStatusMessagesResponse>
[COMMON RESPONSE STATUS SECTION]
</sendLoadStatusMessagesResponse>
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 transactions in the customer’s queue from the Revenova Partner VAN.
The following elements are included in the GetLoadStatus Operation (Inbound) with the Fall ‘24 release. The Stop Number, Event Time Zone, and Latitude/Longitude Elements are processed by the TMS.
<stopNum>3</stopNum>
<eventTimezone>LT</eventTimezone>
<lat>34.0200</lat>
<lon>-117.9495</lon>
Example Response XML
<getLoadStatusMessagesRequest>
[COMMON REQUEST AUTHORIZATION SECTION]
</getLoadStatusMessagesRequest>
Response Element Definitions
Element/Attribute | Description | Required | Repeats | Type |
|---|---|---|---|---|
getLoadStatusMessagesRequest | Root element | Yes | 1 | N/A |
Example Response XML
<getLoadStatusMessagesResponse>
[COMMON RESPONSE STATUS SECTION]
<loadStatusMessages>
<loadStatusMessage>
<carrierTradingPartnerId>123456</carrierTradingPartnerId>
<shipmentId>Load-99818181</shipmentId>
<eventCode>X3</eventCode>
<eventDetail>Arrived at Pickup Location</eventDetail>
<eventDate>2018-12-22</eventDate>
<eventTime>08:00</eventTime>
<eventTimezone>LT</eventTimezone>
<eventCity>Chicago</eventCity>
<eventState>IL</eventState>
<eventZip>60603</eventZip>
<eventCountry>US</eventCountry>
<lat>34.0200</lat>
<lon>-117.9495</lon>
<containerNumber>MAEU1234567</containerNumber>
<proNumber>PRO1234567</proNumber>
</loadStatusMessage>
<loadStatusMessage>
<carrierTradingPartnerId>554433</carrierTradingPartnerId>
<shipmentId>Load-81818182</shipmentId>
<eventCode>X1</eventCode>
<eventDetail>Arrived at Delivery Location</eventDetail>
<eventDate>2018-12-22</eventDate>
<eventTime>08:45</eventTime>
<eventTimezone>LT</eventTimezone>
<eventCity>Chicago</eventCity>
<eventState>IL</eventState>
<eventZip>60603</eventZip>
<eventCountry>US</eventCountry>
<lat>34.0200</lat>
<lon>-117.9495</lon>
<containerNumber>GESU4444567</containerNumber>
<proNumber>PRO4444567</proNumber>
</loadStatusMessage>
</loadStatusMessages>
</getLoadStatusMessagesResponse>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 – Name |
stopNum | The Stop Number for the event | No | 0: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 |
*eventCode Definition
Code | Description |
|---|---|
X3 | Arrived at Pickup Location |
AF | Departed Pickup Location with Shipment |
I1 | Intermodal In-Gate |
AL | Loaded on Train |
RL | Rail Departure from Origin Ramp |
RA | Waypoint Arrival |
RD | Waypoint Departure |
AG | Estimated Delivery |
X6 | En Route to Delivery Location |
AR | Rail Arrival at Destination Ramp |
UR | Equipment Grounding |
NT | Container Ready for Pickup from Rail Yard |
OA | Intermodel Out-Gate |
X1 | Arrived at Delivery Location |
S1 | Trailer at Spotted Consignee Location |
D1 | Completed Unloading at Delivery Location |
CD | Carrier Departed Delivery Location |
TA | Waybilled |
SendLoadInvoices Operation (Outbound)
This API call sends EDI 210 data for one or more loads to the Revenova Partner VAN.
No changes to the EDI 210 Request for the Fall ‘24 TMS release.
Example Request XML
<sendLoadInvoicesRequest>
[COMMON REQUEST AUTHORIZATION SECTION]
<loadInvoices>
<loadInvoice>
<tradingPartnerId>123456</tradingParnterId>
<shipmentId>ABC81818181</shipmentId>
<invoiceNum>2938494834ASD</invoiceNum>
<loadNum>LD-3939393</loadNum>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO-1919191</value>
</referenceNum>
<referenceNum>
<type>PR</type>
<text>Reference Number</text>
<value>1919191</value>
</referenceNum>
<referenceNum>
<type>BM</type>
<text>Reference Number</text>
<value>ANC1919191</value>
</referenceNum>
<referenceNum>
<type>CR</type>
<text>Reference Number</text>
<value>ORD1919191</value>
</referenceNum>
</referenceNums>
<paymentTerms>Collect</paymentTerms>
<pickupDate>2015-12-22</pickupDate>
<deliveryDate>2015-12-23</deliveryDate>
<invoiceDate>2015-12-23</invoiceDate>
<currencyCode>USD</currencyCode>
<charges>
<charge>
<type>Line Haul</type>
<desc>Net Line Haul</desc>
<code>ABC</code>
<lineItemDescription>ping pong balls</lineItemDescription>
<freightClass>70</freightClass>
<nmfcNum>122270</nmfcNum>
<qty>525.50<qty>
<rate>10<qty>
<rateType>Per CWT</rateType>
<subAmount>52550.00</subAmount>
<amount>5000.00</amount>
<discount>47550.00</discount>
<discountRate>25</discountRate>
<ltlCharge>Y</ltlCharge>
</charge>
<charge>
<type>Fuel</type>
<desc>Fuel Surcharge</desc>
<code>DEF</code>
<qty>525.50<qty>
<rateType>Per Mile</rateType>
<amount>200.00</amount>
</charge>
<charge>
<type>Accessorial</type>
<desc>Lift Gate</desc>
<code>XYZ</code>
<qty>2.00<qty>
<rateType>Flat Rate</rateType>
<rate>75.00</rate>
<amount>150.00</amount>
<stopNum>1</stopNum>
</charge>
<charges>
<taxes>
<tax>
<taxName>Alberta GST</taxName>
<taxType>GST</taxType>
<taxRatePct>5.000</taxRatePct>
<taxAmount>123.34</taxAmount>
<taxIdNumber>105944649RT0001</taxIdNumber>
</tax>
<tax>
<taxName>New Brunswick HST</taxName>
<taxType>HST</taxType>
<taxRatePct>15.000</taxRatePct>
<taxAmount>423.34</taxAmount>
<taxIdNumber>105944649RT0001</taxIdNumber>
</tax>
</taxes>
<stops>
<stop>
<stopNum>1</stopNum>
<stopType>pickup</stopType>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO94949494</value>
</referenceNum>
</referenceNums>
<company>
<companyName>ABC Company</companyName>
<addr>79 W. Monroe St.</addr>
<city>Chicago</city>
<state>IL</state>
<zip>60603</zip>
<country>US</country>
<companyId>123456789</companyId>
</company>
</stop>
<stop>
<stopNum>2</stopNum>
<stopType>Dropoff</stopType>
<referenceNums>
<referenceNum>
<type>PO</type>
<text>Reference Number</text>
<value>PO94949495</value>
</referenceNum>
</referenceNums>
<company>
<companyName>ABC Company</companyName>
<addr>79 W. Monroe St.</addr>
<city>Chicago</city>
<state>IL</state>
<zip>60603</zip>
<country>US</country>
<companyId>123456789</companyId>
</company>
</stop>
</stops>
<items>
<item>
<pickupStopNum>1</pickupStopNum>
<dropoffStopNum>2</dropoffStopNum>
<itemNum>123456</itemNum>
<desc>ping pong balls</desc>
<handlingUnitCount>10</handlingUnitCount>
<handlingUnits>Pallets</handlingUnits>
<packagingUnitCount>10</packagingUnitCount>
<packagingUnits>Pieces</packagingUnits>
<weight>20000</weight>
<weightUnits>lbs</weightUnits>
<length>48</length>
<width>48</width>
<height>48</height>
<dimensionUnits>in</dimensionUnits>
<volume>200</volume>
<volumeUnits>Cubic Feet</volumeUnits>
<nmfcClass>70<nmfcClass>
<nmfcNum>122270<nmfcNum>
<isHazardousMaterials>Y</isHazardousMaterials>
</item>
</items>
</loadInvoice>
</loadInvoices>
</sendLoadInvoicesRequest>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 – PO Number (usually) |
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
<sendLoadInvoicesResponse>
[COMMON RESPONSE STATUS SECTION]
</sendLoadInvoicesResponse>
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 transactions in the customer’s queue from the Revenova Partner VAN.
No changes to the outbound EDI 210 Request or Response for the Fall ‘24 release.
Example Request XML
<getLoadInvoicesRequest>
[COMMON REQUEST AUTHORIZATION SECTION]
</getLoadInvoicesRequest>Request Element Definitions
Element/Attribute | Description | Required | Repeats | Type |
|---|---|---|---|---|
getLoadInvoicesRequest | Root element | Yes | 1 | N/A |
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
<getLoadInvoicesResponse>
[COMMON RESPONSE STATUS SECTION]
<loadInvoices>
<loadInvoice>
<carrierTradingPartnerId>123456</carrierTradingPartnerId>
<shipmentId>Load-12345</shipmentId>
<proNumber>987654</proNumber>
<invoiceNum>TESTINVNUM123</invoiceNum>
<currencyCode>USD</currencyCode>
<invoiceDate>2023-08-01</invoiceDate>
<invoiceDueDate>2023-08-15</invoiceDueDate>
<origin>
<originName>XYZ Shipper</originName>
<originStreet>2333 Waukegan Rd.</originStreet>
<originCity>Bannockburn</originCity>
<originState>IL</originState>
<originPostalCode>60045</originPostalCode>
<originCountry>US</originCountry>
</origin>
<destination>
<destinationName>ABC Consignee</destinationName>
<destinationStreet>526 Beacon Street</destinationStreet>
<destinationCity>Boston</destinationCity>
<destinationState>MA</destinationState>
<destinationPostalCode>02215</destinationPostalCode>
<destinationCountry>US</destinationCountry>
</destination>
<charges>
<charge>
<type>Line Haul</type>
<desc>Net Line Haul</desc>
<qty>1200</qty>
<rate>1.00</rate>
<rateType>Per Mile</rateType>
<amount>1200.00</amount>
</charge>
<charge>
<type>Fuel</type>
<desc>Fuel Surcharge</desc>
<qty>1200</qty>
<rate>0.25</rate>
<rateType>Per Mile</rateType>
<amount>300.00</amount>
</charge>
<charge>
<type>Accessorial</type>
<desc>After Hours Delivery</desc>
<qty>1</qty>
<rate>75</rate>
<rateType>Fixed Cost</rateType>
<amount>75.00</amount>
<stopNum>2</stopNum>
</charge>
<charge>
<type>Accessorial</type>
<desc>Unknown Accessorial Name</desc>
<qty>5</qty>
<rate>75</rate>
<rateType>Per Handling Unit</rateType>
<amount>375.00</amount>
</charge>
</charges>
</loadInvoice>
<loadInvoice>
<carrierTradingPartnerId>224466</carrierTradingPartnerId>
<shipmentId>Load-9898</shipmentId>
<proNumber></proNumber>
<invoiceNum>TESTINVNUM321</invoiceNum>
<currencyCode>USD</currencyCode>
<invoiceDate>2023-08-03</invoiceDate>
<invoiceDueDate>2023-08-18</invoiceDueDate>
<charges>
<charge>
<type>Line Haul</type>
<desc>Net Line Haul</desc>
<qty>1100</qty>
<rate>1.00</rate>
<rateType>Per Mile</rateType>
<amount>1100.00</amount>
</charge>
<charge>
<type>Fuel</type>
<desc>Fuel Surcharge</desc>
<qty>1100</qty>
<rate>0.25</rate>
<rateType>Per Mile</rateType>
<amount>275.00</amount>
</charge>
</charges>
<freightChargeItems>
<freightChargeItem>
<desc>Commodity AAA</desc>
<freightClass>50</freightClass>
<qty>10</qty>
<rate>0.25</rate>
<rateType>Per Mile</rateType>
<amount>100</amount>
<weight>100</weight>
<weightUnits>lbs</weightUnits>
</freightChargeItem>
<freightChargeItem>
<desc>60# Red Potato</desc>
<freightClass>55</freightClass>
<qty>20</qty>
<rate>1.25</rate>
<rateType>Per Mile</rateType>
<amount>100</amount>
<weight>100</weight>
<weightUnits>lbs</weightUnits>
</freightChargeItem>
<freightChargeItem>
<desc>5/10 Poly Russet Potato</desc>
<freightClass>60</freightClass>
<qty>20</qty>
<rate>1.25</rate>
<rateType>Per Mile</rateType>
<amount>100</amount>
<weight>100</weight>
<weightUnits>lbs</weightUnits>
</freightChargeItem>
</freightChargeItems>
</loadInvoice>
</loadInvoices>
</getLoadInvoicesResponse>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 – Name |
proNumber | PRO Number | No | 0:1 | String(40) example: “PRO1234567” | Load – PRO 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 | Picklist | 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 | Picklist | Vendor Invoice - Destination 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
All XML element and attribute names are in “camel case”, e.g., “helloWorld.”
All HTTP traffic must be TLS encrypted. No SSL is allowed as it is insecure.
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.
All time elements are in “HH:MM” (24-hour) time format in the local time zone of the current element context.
“LT” (local time) is the only supported time zone value except when processed on incoming EDI 214 transactions.
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 |