Retrieves Queued Outbound EDI Events

Prev Next
Get
/services/apexrest/rtms/ediService

GET endpoint for retrieving queued outbound EDI Events, with mixed EDI codes and payloads, returning the latest 1000 events

Security
OAuth

OAuth 2.0 Client Credentials flow for server-to-server communication.

FlowClient Credentials
Token URL/services/oauth2/token
Query parameters
ediCode
integer
Valid values[ 204, 990, 214, 210, 404, 998, 824, 322, 410 ]
Example204
autoMarkAsSuccess
boolean

Control whether retrieving EDI transactions automatically marks them as success. Defaults to true if blank or not present. If false, the transactions will continue to be in the queue in pending until calling the PATCH endpoint to mark them as success.

Examplefalse
Responses
200

Valid authentication, valid parameters, no errors, all available outbound EDI Events to process are returned and marked as success

204
[
  {
    "ediCode": 204,
    "inbound": false,
    "ediProviderRetrievalDatetime": "2025-12-19T20:35:42.061Z",
    "ediTransactionId": "a19E2000005sxOPIAY",
    "payload": {
      "carrierTradingPartnerId": "KLIQA",
      "scac": "FLSJ",
      "carrierScac": "AACT",
      "carrierQuoteId": "1122334455",
      "contractId": "QM11223344",
      "shipmentId": "12345",
      "purpose": "Original",
      "mode": "LTL",
      "equipmentType": "Dry Van 48'",
      "equipmentWeight": 1000,
      "equipmentWeightUnits": "kg",
      "containerNumber": "MAEU1234567",
      "specialInstructions": [
        "Special Instructions"
      ],
      "poNum": "12345",
      "orderNum": "45678",
      "bolNum": "98765",
      "sealNumber": "123627",
      "paymentTerms": "Third Party",
      "respondByDate": "2015-12-23",
      "respondByTime": "03:30",
      "timeZone": "LT",
      "currencyCode": "USD",
      "cargoValue": 1000,
      "insuranceAmount": 800,
      "mileage": 56.24,
      "originalTerminalLocation": "CHICAGO NORTH (DSP)",
      "destinationTerminalLocation": "ERIE/YOUNGSTOWN (WARD)",
      "movementType": "60",
      "totalWeight": 5500,
      "weightUnits": "lbs",
      "totalVolume": 5500,
      "volumeUnits": "Cubic Feet",
      "customerBillTo": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "carrierBillTo": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "companyId": "0015000000VvAAAAB",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "customsBroker": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "notifyParty": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "ultimateShipper": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "apptRequired": true,
        "expectedDate": "12-26-2025",
        "expectedTimeStart": "12:30",
        "expectedTimeEnd": "14:30",
        "timeZone": "LT",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "ultimateConsignee": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "apptRequired": true,
        "expectedDate": "12-26-2025",
        "expectedTimeStart": "12:30",
        "expectedTimeEnd": "14:30",
        "timeZone": "LT",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "referenceNums": [
        {
          "type": "PD",
          "text": "Pickup/Delivery Number",
          "value": "716263587126"
        }
      ],
      "stops": [
        {
          "stopNum": 1,
          "stopType": "pickup",
          "apptRequired": true,
          "expectedDate": "12-26-2025",
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "stopInstructions": [
            "Careful Handling",
            "Drop off at door"
          ],
          "timeZone": "LT",
          "company": {
            "companyName": "Test Company 1",
            "addr": "123 Test Street",
            "city": "Smalltown",
            "state": "MN",
            "zip": "12345",
            "country": "US",
            "companyId": "0015000000VvAAAAB"
          },
          "contacts": [
            {
              "contactName": "Felicia Wheaton",
              "phone": "555-555-5555",
              "fax": "666-666-6666",
              "email": "fwheaton@trucking.com"
            }
          ],
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ],
          "accessorials": [
            "Lift Gate Delivery",
            "After Hours Delivery"
          ]
        }
      ],
      "items": [
        {
          "pickupStopNum": 1,
          "dropoffStopNum": 2,
          "itemNum": "3366468010001",
          "description": "Commodity",
          "handlingUnitCount": 1,
          "handlingUnits": "Boxes",
          "packagingUnitCount": 20,
          "packagingUnits": "Boxes",
          "weight": 12.1,
          "weightUnits": "kg",
          "volume": 34.2,
          "volumeUnits": "Cubic Feet",
          "length": 12.1,
          "width": 12.1,
          "height": 12.1,
          "dimensionUnits": "m",
          "nmfcClass": "55",
          "nmfcNum": "21652-02",
          "stccCode": "01132",
          "isHazMat": false,
          "hazMatContactName": "George Smith",
          "hazMatContactPhone": "312-555-9999",
          "hazMatContactEmail": "georgesmith@company.com",
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ]
        }
      ],
      "charges": [
        {
          "type": "Line Haul",
          "description": "Lift Gate Delivery",
          "amount": 1000
        }
      ]
    }
  }
]
210
[
  {
    "ediCode": 210,
    "inbound": false,
    "ediProviderRetrievalDatetime": "2025-12-19T20:35:42.061Z",
    "ediTransactionId": "a19E2000005sxOPIAY",
    "payload": {
      "tradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "invoiceNum": "TESTINVNUM123",
      "loadNum": "L-10",
      "scac": "AACT",
      "totalWeight": 5500,
      "weightUnits": "lbs",
      "totalVolume": 5500,
      "volumeUnits": "Cubic Feet",
      "containerNumber": "MAEU1234567",
      "customerBillTo": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US"
      },
      "paymentTerms": "Third Party",
      "pickupDate": "2025-12-23",
      "deliveryDate": "2025-12-25",
      "invoiceDate": "2025-12-26",
      "currencyCode": "USD",
      "referenceNums": [
        {
          "type": "PD",
          "text": "Pickup/Delivery Number",
          "value": "716263587126"
        }
      ],
      "charges": [
        {
          "type": "Line Haul",
          "description": "Net Line Haul",
          "code": "123",
          "qty": 1200,
          "rate": 1,
          "rateType": "Per Mile",
          "amount": 1200,
          "subAmount": 1200,
          "discount": 1200,
          "discountRate": 1200,
          "ltlCharge": true,
          "freightClass": "50",
          "lineItemDescription": "Steel Beams",
          "nmfcClass": "55",
          "nmfcNum": "21652-02",
          "stopNum": 2
        }
      ],
      "taxes": [
        {
          "taxName": "Sales Tax",
          "taxType": "GST",
          "taxIdNumber": "51-2144346",
          "taxRatePct": 0.08,
          "taxAmount": 12.45
        }
      ],
      "stops": [
        {
          "stopNum": 1,
          "stopType": "pickup",
          "stopInstructions": [
            "Careful Handling",
            "Drop off at door"
          ],
          "company": {
            "companyName": "Test Company 1",
            "companyId": "KLIQA",
            "addr": "123 Test Street",
            "city": "Smalltown",
            "state": "MN",
            "zip": "12345",
            "country": "US"
          },
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ]
        }
      ],
      "items": [
        {
          "pickupStopNum": 1,
          "dropoffStopNum": 2,
          "itemNum": "Item 1",
          "description": "Commodity AAA",
          "handlingUnitCount": 1,
          "handlingUnits": "Boxes",
          "packagingUnitCount": 20,
          "packagingUnits": "Boxes",
          "weight": 12.1,
          "weightUnits": "lbs",
          "volume": 34.2,
          "volumeUnits": "Cubic Feet",
          "length": 12.1,
          "width": 12.1,
          "height": 12.1,
          "dimensionUnits": "ft",
          "nmfcClass": "55",
          "nmfcNum": "21652-02",
          "isHazMat": false,
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ]
        }
      ]
    }
  }
]
214
[
  {
    "ediCode": 214,
    "inbound": false,
    "ediProviderRetrievalDatetime": "2025-12-19T20:35:42.061Z",
    "ediTransactionId": "a19E2000005sxOPIAY",
    "payload": {
      "tradingPartnerId": "EDIC1",
      "scac": "FLSJ",
      "shipmentId": "12345",
      "loadNum": "L-10",
      "totalWeight": 5500,
      "weightUnits": "lbs",
      "totalVolume": 5500,
      "volumeUnits": "Cubic Feet",
      "containerNumber": "MAEU1234567",
      "customerBillTo": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US"
      },
      "referenceNums": [
        {
          "type": "PD",
          "text": "Pickup/Delivery Number",
          "value": "716263587126"
        }
      ],
      "currentLocation": {
        "status": "In Transit",
        "stopNum": "2",
        "statusDate": "2025-12-24",
        "statusTime": "08:30",
        "timeZone": "LT",
        "city": "Boston",
        "state": "MA",
        "country": "US",
        "lat": 47.5292773045995,
        "lon": -87.20153829304499
      },
      "stops": [
        {
          "stopNum": 1,
          "stopType": "pickup",
          "apptRequired": true,
          "expectedDate": "12-26-2025",
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "stopInstructions": [
            "Careful Handling",
            "Drop off at door"
          ],
          "timeZone": "LT",
          "company": {
            "companyName": "Test Company 1",
            "companyId": "KLIQA",
            "addr": "123 Test Street",
            "city": "Smalltown",
            "state": "MN",
            "zip": "12345",
            "country": "US"
          },
          "events": [
            {
              "status": "In Transit",
              "statusDate": "2025-12-24",
              "statusTime": "08:30",
              "timeZone": "LT",
              "reason": "BG",
              "lat": 47.5292773045995,
              "lon": -87.20153829304499
            }
          ],
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ]
        }
      ],
      "items": [
        {
          "pickupStopNum": 1,
          "dropoffStopNum": 2,
          "itemNum": "Item 1",
          "description": "Commodity AAA",
          "handlingUnitCount": 1,
          "handlingUnits": "Boxes",
          "packagingUnitCount": 20,
          "packagingUnits": "Boxes",
          "weight": 12.1,
          "weightUnits": "lbs",
          "volume": 34.2,
          "volumeUnits": "Cubic Feet",
          "length": 12.1,
          "width": 12.1,
          "height": 12.1,
          "dimensionUnits": "ft",
          "nmfcClass": "55",
          "nmfcNum": "21652-02",
          "isHazMat": false,
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ]
        }
      ]
    }
  }
]
990
[
  {
    "ediCode": 990,
    "inbound": false,
    "ediProviderRetrievalDatetime": "2025-12-19T20:35:42.061Z",
    "ediTransactionId": "a19E2000005sxOPIAY",
    "payload": {
      "tradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "loadNum": "L-10",
      "status": "Accept",
      "declineReasonCode": "TTI",
      "referenceNums": [
        {
          "type": "PD",
          "text": "Pickup/Delivery Number",
          "value": "716263587126"
        }
      ]
    }
  }
]
Expand All
object
ediCode
integer

The EDI codes to send or receive in the body of the request.

Valid values[ 204, 990, 214, 210, 404, 998, 824, 322, 410 ]
Example204
inbound
boolean
Examplefalse
ediProviderRetrievalDatetime
string (date-time)
Example2025-12-19T20:35:42.061Z
ediTransactionId
string
Examplea19E2000005sxOPIAY
payload
OneOf
outboundEdi204
object (outboundEdi204)
carrierTradingPartnerId
string

The trading partner identifier for the carrier receiving the load tender.

Maps to EDI Location (object) -> Name (field) in Revenova TMS.

Max length80
ExampleKLIQA
carrierScac
string

The SCAC of the carrier receiving the load tender.

Maps to Transportation Profile (object) -> SCAC (field) in Revenova TMS.

Max length6
ExampleAACT
carrierQuoteId
string

The unique identification reference for the carrier quote. Falls back on Load Name

Maps to one of the following in Revenova TMS:

  • Carrier Quote (object) -> Carrier Quote Reference (field)
  • Load (object) -> Name (field)
Max length100
Example1122334455
contractId
string

The contract identification for the carrier quote.

Maps to one of the following in Revenova TMS:

  • Carrier Quote (object) -> Contract Id (field)
  • Load (object) -> Name (field)
Max length100
ExampleQM11223344
shipmentId
string

The unique identifier for the shipment load tender.

Maps to Load (object) -> Load Number (field) in Revenova TMS.

Max length80
Example12345
purpose
string

The purpose of the load tender (e.g., Original, Update, Cancellation).

Valid values[ "Original", "Update", "Cancellation" ]
ExampleOriginal
mode
string

The mode of transportation for the shipment, from the carrier service on the carrier quote.

Maps to Mode (object) -> Name (field) in Revenova TMS.

Max length80
ExampleLTL
equipmentType
string

The type of equipment required for the shipment.

Maps to Load (object) -> Equipment Type (field) in Revenova TMS.

Max length80
ExampleDry Van 48'
equipmentWeight
number (integer)

The weight of the equipment type for the shipment.

Maps to Load (object) -> Equipment Weight (field) in Revenova TMS.

Example1000.0
equipmentWeightUnits
string

The weight units of the equipment type for the shipment.

Maps to Load (object) -> Equipment Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplekg
containerNumber
string

The number of the container/trailer for the shipment.

Maps to Load (object) -> Container/Trailer Number (field) in Revenova TMS.

Max length80
ExampleMAEU1234567
specialInstructions
Array of string

A singleton list of special instructions for the shipment.

Maps to Load (object) -> Other Instructions (field) in Revenova TMS.

Example[ "Special Instructions" ]
string

A special instruction for the shipment.

Max length3000
poNum
string

The purchase order number associated with the shipment.

Maps to Load (object) -> PO Number (field) in Revenova TMS.

Max length100
Example12345
orderNum
string

The order number associated with the shipment.

Maps to Load (object) -> Order Number (field) in Revenova TMS.

Max length50
Example45678
bolNum
string

The bill of lading number for the shipment.

Maps to Load (object) -> Bill of Lading Number (field) in Revenova TMS.

Max length55
Example98765
sealNumber
string

The seal number used in the shipment.

Maps to Load (object) -> Seal Number (field) in Revenova TMS.

Max length15
Example123627
paymentTerms
string

The payment terms for the shipment (e.g, Prepaid, Collect, Third Party).

Maps to Load (object) -> Payment Terms (field) in Revenova TMS.

Valid values[ "Prepaid", "Collect", "Third Party" ]
ExampleThird Party
respondByDate
string (date)

The date by which the carrier must respond to the load tender. Date the outbound tender got created.

Format is YYYY-MM-DD.

Example2015-12-23
respondByTime
string

The time by which the carrier must respond to the load tender. 2hrs after the tender got created.

Format is HH:MM in 24-hour format.

Example03:30
timeZone
string

The time zone for the respond by time.

Always LT (Local Time)

ExampleLT
currencyCode
string

The 3-character currency code for monetary values in the load tender.

Maps to Carrier Quote (object) -> Currency ISO Code (field) in Revenova TMS.

Max length3
ExampleUSD
cargoValue
number

The declared value of the cargo being shipped.

Maps to Load (object) -> Cargo Value (field) in Revenova TMS.

Example1000.0
insuranceAmount
number

The amount of insurance coverage for the shipment.

Maps to Load (object) -> Insurance Amount (field) in Revenova TMS.

Example800.0
mileage
number (decimal)

The total mileage for the shipment.

Maps to Load (object) -> Distance (Miles) (field) in Revenova TMS.

Example56.24
originalTerminalLocation
string

The original terminal location of the shipment.

Maps to Carrier Quote (object) -> Origin Terminal Location (field) in Revenova TMS.

Max length255
ExampleCHICAGO NORTH (DSP)
destinationTerminalLocation
string

The destination terminal location of the shipment.

Maps to Carrier Quote (object) -> Destination Terminal Location (field) in Revenova TMS.

Max length255
ExampleERIE/YOUNGSTOWN (WARD)
movementType
string

Code for the type of movement, related to mode

Maps to Carrier Quote (object) -> Movement Type (field) in Revenova TMS.

Valid values[ "Door to Door", "Door to Port", "Port to Door", "Port to Port", "15", "20", "22", "25", "27", "40", "42", "45", "47", "60", "62", "65", "67", "80", "82", "85", "87" ]
Example60
totalWeight
number

The total weight for the shipment.

Maps to Load (object) -> Total Weight (field) in Revenova TMS:

Example5500.0
weightUnits
string

The units of weight for the item (lbs or kg).

Maps to Load (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplelbs
totalVolume
number

The total volume for the shipment.

Maps to Load (object) -> Total Volume (field) in Revenova TMS:

Example5500.0
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
customerBillTo
object

The customer to be billed for the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Billing Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Billing City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Billing State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Billing Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Billing Country Code (field) in Revenova TMS.

Max length80
ExampleUS
contact
object

The contact person for the customer to be billed for the shipment.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
carrierBillTo
object

The company to be billed for the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
companyId
string

The Salesforce unique identifier for the company.

Max length18
Example0015000000VvAAAAB
contact
object

The contact to be billed to for the shipment.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
customsBroker
object

The customs broker associated with the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
contact
object

The customs broker contact for the shipment.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
notifyParty
object

The party to be notified about the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
contact
object

The contact to be notified about the shipment.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
ultimateShipper
object

The ultimate shipper of the load.

companyName
string

The name of the ultimate shipper for the shipment.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the ultimate shipper for the shipment.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city of the ultimate shipper for the shipment.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the ultimate shipper is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the ultimate shipper for the shipment.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code of the ultimate shipper for the shipment, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
apptRequired
boolean

Indicates whether an appointment is required for the ultimate shipper.

Maps to Stop (object) -> Appointment Required (field) in Revenova TMS.

Exampletrue
expectedDate
string (date)

The expected date for the ultimate shipper.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Expected Date (field) in Revenova TMS.

Example12-26-2025
expectedTimeStart
string

The expected start time for the ultimate shipper.

Format is HH:MM.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time(field)
Example12:30
expectedTimeEnd
string

The expected end time for the ultimate shipper.

Format must be HH:MM.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time(field)
Example14:30
timeZone
string

The time zone for the respond by time.

Always LT (Local Time)

ExampleLT
contact
object

The contact of the ultimate shipper for the load.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
ultimateConsignee
object
companyName
string

The name of the ultimate consignee for the shipment.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the ultimate consignee for the shipment.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city of the ultimate consignee for the shipment.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the ultimate consignee is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the ultimate consignee for the shipment.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code of the ultimate consignee for the shipment, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
apptRequired
boolean

Indicates whether an appointment is required for the ultimate consignee.

Maps to Stop (object) -> Appointment Required (field) in Revenova TMS.

Exampletrue
expectedDate
string (date)

The expected date for the ultimate consignee.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Expected Date (field) in Revenova TMS.

Example12-26-2025
expectedTimeStart
string

The expected start time for the ultimate consignee.

Format is HH:MM.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time(field)
Example12:30
expectedTimeEnd
string

The expected end time for the ultimate consignee.

Format is HH:MM.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time(field)
Example14:30
timeZone
string

The time zone for the respond by time.

Always LT (Local Time)

ExampleLT
contact
object

The contact of the ultimate consignee for the load.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
referenceNums
Array of object

A list of reference numbers for the stop.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the stop.

type
string

The type of reference number (e.g., PD, PO, etc.).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The description/label of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
stops
Array of object

A list of stops for the shipment.

Maps to Stop (object) in Revenova TMS.

object
stopNum
number (integer)

The sequential number of the stop in the shipment.

Maps to Stop (object) -> Number (field) in Revenova TMS.

Example1.0
stopType
string

The type of stop (e.g., pickup, dropoff).

Maps to one of the following in Revenova TMS:

  • For pickup stops: Stop (object) -> Is Pickup (field)
  • For dropoff stops: Stop (object) -> Is Dropoff (field)
Valid values[ "pickup", "dropoff" ]
Examplepickup
apptRequired
boolean

Indicates whether an appointment is required for the stop.

Maps to Stop (object) -> Appointment Required (field) in Revenova TMS.

Exampletrue
expectedDate
string (date)

The expected date for the stop.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Expected Date (field) in Revenova TMS.

Example12-26-2025
expectedTimeStart
string

The expected start time for the stop.

Format is HH:MM in 24-hour format.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time (field)
Example12:30
expectedTimeEnd
string

The expected end time for the stop.

Format is HH:MM in 24-hour format.

Maps to Stop (object) -> Shipping/Receiving Hours (field) in Revenova TMS.

Example14:30
stopInstructions
Array of string

A list of specific instructions for the stop.

Maps to Stop (object) -> Instructions (field) in Revenova TMS.

Example[ "Careful Handling", "Drop off at door" ]
string

A specific instruction for the stop.

Max length2000
timeZone
string

The time zone for the respond by time.

Always LT (Local Time)

ExampleLT
company
object

The company information for the stop.

Maps to Account (object) in Revenova TMS.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
companyId
string

The Salesforce unique identifier for the company.

Max length18
Example0015000000VvAAAAB
contacts
Array of object

A list of contacts for the stop.

Maps to Contact (object) in Revenova TMS.

object

A contact person for the stop.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
referenceNums
Array of object

A list of reference numbers for the stop.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the stop.

type
string

The type of reference number (e.g., PD, PO, etc.).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The description/label of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
accessorials
Array of string

A list of accessorials related to the stop.

Example[ "Lift Gate Delivery", "After Hours Delivery" ]
string

The accessorial related to the stop.

items
Array of object

A list of items being shipped in the load.

object

An item being shipped in the load.

Maps to Line Item (object) in Revenova TMS.

pickupStopNum
number (integer)

The stop number where the item is picked up.

Maps to Line Item (object) -> Pickup Stop (field) in Revenova TMS.

Example1.0
dropoffStopNum
number (integer)

The stop number where the item is dropped off.

Maps to Line Item (object) -> Delivery Stop (field) in Revenova TMS.

Example2.0
itemNum
string

The unique identifier (SKU) for the item.

Maps to Line Item (object) -> Name (field) in Revenova TMS.

Max length80
Example3366468010001
description
string

The description of the item being shipped.

Maps to Line Item (object) -> Description (field) in Revenova TMS.

Max length255
ExampleCommodity
handlingUnitCount
number (integer)

The number of handling units for the item.

Maps to Line Item (object) -> HU Count (field) in Revenova TMS.

Example1.0
handlingUnits
string

The type of handling unit.

Maps to Line Item (object) -> Handling Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
packagingUnitCount
number (integer)

The number of packaging units for the item.

Maps to Line Item (object) -> PU Count (field) in Revenova TMS.

Example20.0
packagingUnits
string

The type of packaging unit.

Maps to Line Item (object) -> Packaging Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
weight
number

The weight of the item.

Maps to Line Item (object) -> Weight (field) in Revenova TMS.

Example12.1
weightUnits
string

The weight units for the item.

Maps to Line Item (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplekg
volume
number

The volume of the item.

Maps to Line Item (object) -> Volume (field) in Revenova TMS.

Example34.2
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
length
number (decimal)

The length of the handling unit.

Maps to Line Item (object) -> Length (field) in Revenova TMS.

Example12.1
width
number (decimal)

The width of the handling unit.

Maps to Line Item (object) -> Width (field) in Revenova TMS.

Example12.1
height
number (decimal)

The height of the handling unit.

Maps to Line Item (object) -> Height (field) in Revenova TMS.

Example12.1
dimensionUnits
string

The dimension units for the handling unit (e.g, in, cm, ft, m).

Maps to Line Item (object) -> Dimension Units (field) in Revenova TMS.

Valid values[ "in", "cm", "ft", "m" ]
Examplem
nmfcClass
string

The NMFC class for the item (e.g., "50", "55", "60", etc.).

Maps to Line Item (object) -> NMFC Class (field) in Revenova TMS.

Example55
nmfcNum
string

The NMFC code/subcode for the item.

Maps to Line Item (object) -> NMFC Number (field) in Revenova TMS.

Max length20
Example21652-02
stccCode
string

The Standard Transportation Commodity Code (STCC) Code for the item.

Maps to Line Item (object) -> STCC Code (field) in Revenova TMS.

Example01132
isHazMat
boolean

Indicates whether the item is hazardous material.

Maps to Line Item (object) -> HazMat (field) in Revenova TMS.

Examplefalse
hazMatContactName
string

The name of the hazardous material contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleGeorge Smith
hazMatContactPhone
string

The phone number of the hazardous material contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example312-555-9999
hazMatContactEmail
string

The email address of the hazardous material contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplegeorgesmith@company.com
referenceNums
Array of object

A list of reference numbers for the stop.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the stop.

type
string

The type of reference number (e.g., PD, PO, etc.).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The description/label of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
charges
Array of object

A list of charges associated with the shipment.

Maps to Carrier Quote (object) in Revenova TMS.

object

A charge associated with the shipment.

type
string

The type of charge (e.g., Line Haul, Fuel, Accessorial).

Maps to Carrier Quote (object) in Revenova TMS.

Valid values[ "Line Haul", "Fuel", "Accessorial" ]
ExampleLine Haul
description
string

The description of the charge, or Accessorial Name.

Maps to Carrier Quote (object) in Revenova TMS.

Max length80
ExampleLift Gate Delivery
amount
number

The amount of the charge.

Maps to Carrier Quote (object) in Revenova TMS.

Example1000.0
outboundEdi990
object (outboundEdi990)
tradingPartnerId
string

The EDI Trading Partner ID of the Carrier sending the load tender acknowledgment.

Maps to EDI Location (object) -> Name (field) in Revenova TMS.

Max length80
ExampleEDIC1
shipmentId
string

The unique identifier for the shipment load tender.

Maps to the Load (object) field set in TMS Admin > Configuration > EDI Shipment ID in Revenova TMS.

Max length255
Example12345
loadNum
string

The load number associated with this status message.

Maps to Load (object) -> Load Number (field) in Revenova TMS.

Max length80
ExampleL-10
status
string

The status of the load tender acknowledgment (e.g., Accept, Decline, etc.).

Maps to Load (object) -> EDI Status (field) in Revenova TMS.

Valid values[ "Pending", "Accept", "Decline", "Update Pending from Customer", "Updated by Customer", "Cancelled by Customer" ]
ExampleAccept
declineReasonCode
string

The decline reason code for why the tender was declined (e.g., TTI, TAP, UPU, etc.).

Maps to Load (object) -> EDI Decline Reason (field) in Revenova TMS.

Codes:

  • 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
Valid values[ "TTI", "TAP", "UPU", "ECL", "OS", "STL", "DAI", "IR" ]
ExampleTTI
referenceNums
Array of object

The list of reference numbers associated with this status message.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the shipment.

type
string

The type of reference number (e.g., PD for Pickup/Delivery Number).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

A description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
outboundEdi214
object (outboundEdi214)
tradingPartnerId
string

The unique identifier for the trading partner (carrier) receiving the status message.

Maps to EDI Location (object) -> Name (field) in Revenova TMS.

Max length80
ExampleEDIC1
shipmentId
string

The unique identifier for the shipment load tender.

Maps to the Load (object) field set in TMS Admin > Configuration > EDI Shipment ID in Revenova TMS.

Max length255
Example12345
loadNum
string

The load number associated with this status message.

Maps to Load (object) -> Load Number (field) in Revenova TMS.

Max length80
ExampleL-10
scac
string

The SCAC of the customer associated with the load.

Maps to Load (object) -> EDI SCAC (field) in Revenova TMS.

Max length10
ExampleFLSJ
totalWeight
number

The total weight for the shipment.

Maps to Load (object) -> Total Weight (field) in Revenova TMS:

Example5500.0
weightUnits
string

The units of weight for the item (lbs or kg).

Maps to Load (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplelbs
totalVolume
number

The total volume for the shipment.

Maps to Load (object) -> Total Volume (field) in Revenova TMS:

Example5500.0
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
containerNumber
string

The number of the container/trailer for the shipment.

Maps to Load (object) -> Container/Trailer Number (field) in Revenova TMS.

Max length80
ExampleMAEU1234567
customerBillTo
object

The customer to be billed for the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Billing Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Billing City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Billing State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Billing Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Billing Country Code (field) in Revenova TMS.

Max length80
ExampleUS
referenceNums
Array of object

The list of reference numbers associated with this status message.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the shipment.

type
string

The type of reference number (e.g., PD for Pickup/Delivery Number).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

A description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
currentLocation
object

The current location details of the shipment.

status
string

The current status of the shipment (e.g., In Transit, Arrived, Departed, etc.).

Always In Transit if populated, since only In Transit sends currentLocation.

ExampleIn Transit
stopNum
string

The stop number associated with the current location status. Uses an integer format.

Maps to Stop (object) -> Number (field) in Revenova TMS.

Example2
statusDate
string (date)

The date associated with the current location status.

Format is YYYY-MM-DD.

Always the date the load status was generated.

Example2025-12-24
statusTime
string

The time associated with the current location status.

Format is HH:MM in 24-hour time.

Always the time the load status was generated.

Example08:30
timeZone
string

The timezone associated with the current location status.

Always LT (Local Time)

ExampleLT
city
string

The city associated with the current location status.

Maps to Load (object) -> Last Reported City (field) in Revenova TMS.

Max length40
ExampleBoston
state
string

The 2 character state code associated with the current location status.

Maps to Load (object) -> Last Reported State/Province (field) in Revenova TMS.

Max length2
ExampleMA
country
string

The 2-character ISO country code associated with the current location status.

Maps to Load (object) -> Last Reported Country (field) in Revenova TMS.

Max length2
ExampleUS
lat
number (decimal)

The latitude associated with the current location status.

Maps to Load (object) -> Last Reported Geolocation in Revenova TMS.

Example47.5292773045995
lon
number (decimal)

The longitude associated with the current location status.

Maps to Load (object) -> Last Reported Geolocation in Revenova TMS.

Example-87.20153829304499
stops
Array of object

A list of stops associated with the shipment.

object

A stop in the route of the shipment.

Maps to Stop (object) in Revenova TMS.

stopNum
number (integer)

The sequential number of the stop in the shipment.

Maps to Stop (object) -> Number (field) in Revenova TMS.

Example1.0
stopType
string

The type of stop (e.g., pickup, dropoff).

Maps to one of the following in Revenova TMS:

  • For pickup stops: Stop (object) -> Is Pickup (field)
  • For dropoff stops: Stop (object) -> Is Dropoff (field)
Valid values[ "pickup", "dropoff" ]
Examplepickup
apptRequired
boolean

Indicates whether an appointment is required for the stop.

Maps to Stop (object) -> Appointment Required (field) in Revenova TMS.

Exampletrue
expectedDate
string (date)

The expected date for the stop.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Expected Date (field) in Revenova TMS.

Example12-26-2025
expectedTimeStart
string

The expected start time for the stop.

Format is HH:MM in 24-hour format.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time (field)
Example12:30
expectedTimeEnd
string

The expected end time for the stop.

Format is HH:MM in 24-hour format.

Maps to Stop (object) -> Shipping/Receiving Hours (field) in Revenova TMS.

Example14:30
stopInstructions
Array of string

A list of specific instructions for the stop.

Maps to Stop (object) -> Instructions (field) in Revenova TMS.

Example[ "Careful Handling", "Drop off at door" ]
string

A specific instruction for the stop.

Max length2000
timeZone
string

The time zone for the stop.

Always LT (Local Time)

ExampleLT
company
object

The company information for the stop.

Maps to Account (object) in Revenova TMS.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
companyId
string

The unique identifier for the company.

Max length80
ExampleKLIQA
addr
string

The street address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
events
Array of object

A list of events that occurred at the stop.

object

The stop event and its location details.

status
string

The current status of the shipment (e.g., In Transit, Arrived, Departed, Appointment etc.).

ExampleIn Transit
statusDate
string (date)

The date associated with the current location status.

Format is YYYY-MM-DD.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Expected Date (field)
  • Stop (object) -> Arrival Date (field)
  • Stop (object) -> Departure Date (field)
  • Stop (object) -> Loading/Unloading Complete Date (field)
Example2025-12-24
statusTime
string

The time associated with the current location status.

Format is HH:MM in 24-hour time.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Appointment Time (field)
  • Stop (object) -> Arrival Time (field)
  • Stop (object) -> Departure Time (field)
  • Stop (object) -> Loading/Unloading Complete Time (field)
Example08:30
timeZone
string

The timezone associated with the current location status.

Always LT (Local Time)

ExampleLT
reason
string

The load status reason associated with the current location status.

Maps to Stop (object) -> Carrier Status Reason (field) in Revenova TMS.

Max length2
ExampleBG
lat
number (decimal)

The latitude associated with the current location status.

Maps to one of the following in Revenova TMS:

  • Account (object) -> Shipping Latitude (field)
  • Load (object) -> Last Reported Geolocation
Example47.5292773045995
lon
number (decimal)

The longitude associated with the current location status.

Maps to one of the following in Revenova TMS:

  • Account (object) -> Shipping Longitude (field)
  • Load (object) -> Last Reported Geolocation (field)
Example-87.20153829304499
referenceNums
Array of object

The list of reference numbers associated with this status message.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the shipment.

type
string

The type of reference number (e.g., PD for Pickup/Delivery Number).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

A description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
items
Array of object

A list of items associated with the shipment.

object

An item associated with the shipment.

Maps to Line Item (object) in Revenova TMS.

pickupStopNum
number (integer)

The pickup stop number for the item.

Maps to Line Item (object) -> Pickup Stop (field) in Revenova TMS.

Example1.0
dropoffStopNum
number (integer)

The dropoff stop number for the item.

Maps to Line Item (object) -> Delivery Stop (field) in Revenova TMS.

Example2.0
itemNum
string

The item number or SKU identifier.

Maps to Line Item (object) -> Name (field) in Revenova TMS.

Max length80
ExampleItem 1
description
string

The description of the item.

Maps to Line Item (object) -> Description (field) in Revenova TMS.

Max length255
ExampleCommodity AAA
handlingUnitCount
number (integer)

The count of handling units for the item.

Maps to Line Item (object) -> HU Count (field) in Revenova TMS.

Example1.0
handlingUnits
string

The type of handling unit.

Maps to Line Item (object) -> Handling Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
packagingUnitCount
number (integer)

The count of packaging units for the item.

Maps to Line Item (object) -> PU Count (field) in Revenova TMS.

Example20.0
packagingUnits
string

The type of packaging unit.

Maps to Line Item (object) -> Packaging Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
weight
number

The weight of the item.

Maps to Line Item (object) -> Weight (field) in Revenova TMS.

Example12.1
weightUnits
string

The units of weight for the item (lbs or kg).

Maps to Line Item (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplelbs
volume
number

The volume of the item.

Maps to Line Item (object) -> Volume (field) in Revenova TMS.

Example34.2
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
length
number (decimal)

The length of the item.

Maps to Line Item (object) -> Length (field) in Revenova TMS.

Example12.1
width
number (decimal)

The width of the item.

Maps to Line Item (object) -> Width (field) in Revenova TMS.

Example12.1
height
number (decimal)

The height of the item.

Maps to Line Item (object) -> Height (field) in Revenova TMS.

Example12.1
dimensionUnits
string

The units of dimension for the item (e.g., in, cm, ft, m).

Maps to Line Item (object) -> Dimension Units (field) in Revenova TMS.

Valid values[ "in", "cm", "ft", "m" ]
Exampleft
nmfcClass
string

The NMFC class for the item (e.g., "50", "55", "60", etc.).

Maps to Line Item (object) -> NMFC Class (field) in Revenova TMS.

Example55
nmfcNum
string

The NMFC code/subcode for the item.

Maps to Line Item (object) -> NMFC Number (field) in Revenova TMS.

Max length20
Example21652-02
isHazMat
boolean

Indicates if the item is hazardous material.

Maps to Line Item (object) -> HazMat (field) in Revenova TMS.

Examplefalse
referenceNums
Array of object

A list of reference numbers associated with the item.

object

A reference number associated with the item.

type
string

The type of reference number (e.g., PD for Pickup/Delivery).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The text description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
outboundEdi210
object (outboundEdi210)
tradingPartnerId
string

The trading partner ID of the carrier.

Maps to EDI Location (object) -> Name (field) in Revenova TMS.

Max length80
ExampleEDIC1
shipmentId
string

The unique identifier for the shipment load tender.

Maps to the Load (object) field set in TMS Admin > Configuration > EDI Shipment ID in Revenova TMS.

Max length255
Example12345
invoiceNum
string

The invoice number.

Maps to one of the following in Revenova TMS:

  • Non-Accounting Seed: Customer Invoice (object) -> Name (field)
  • Accounting Seed: Billing (object) -> Proprietary Billing Number (field)
  • Accounting Seed: Billing (object) -> Name (field)
Max length100
ExampleTESTINVNUM123
loadNum
string

The load number associated with this invoice.

Maps to Load (object) -> Load Number (field) in Revenova TMS.

Max length80
ExampleL-10
scac
string

The SCAC of the customer associated with the load.

Maps to Load (object) -> EDI SCAC (field) in Revenova TMS.

Max length10
ExampleAACT
totalWeight
number

The total weight for the shipment.

Maps to Load (object) -> Total Weight (field) in Revenova TMS:

Example5500.0
weightUnits
string

The units of weight for the item (lbs or kg).

Maps to Load (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplelbs
totalVolume
number

The total volume for the shipment.

Maps to Load (object) -> Total Volume (field) in Revenova TMS:

Example5500.0
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
containerNumber
string

The number of the container/trailer for the shipment.

Maps to Load (object) -> Container/Trailer Number (field) in Revenova TMS.

Max length80
ExampleMAEU1234567
customerBillTo
object

The customer to be billed for the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Billing Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Billing City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Billing State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Billing Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Billing Country Code (field) in Revenova TMS.

Max length80
ExampleUS
paymentTerms
string

The payment terms for the invoice (e.g., Prepaid, Collect, Third Party).

Maps to Load (object) -> Payment Terms (field) in Revenova TMS.

Valid values[ "Prepaid", "Collect", "Third Party" ]
ExampleThird Party
pickupDate
string (date)

The pickup date for the shipment.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Arrival Date (field) in Revenova TMS.

Example2025-12-23
deliveryDate
string (date)

The delivery date for the shipment.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Departure Date (field) in Revenova TMS.

Example2025-12-25
invoiceDate
string (date)

The date of the invoice.

Format is YYYY-MM-DD.

Maps to one of the following in Revenova TMS:

  • Non-Accounting Seed: Customer Invoice (object) -> Invoice Date (field) in Revenova TMS.
  • Accounting Seed: Billing (object) -> Date (field).
Example2025-12-26
currencyCode
string

The three-character ISO currency code for the invoice amounts, if multicurrency.

Maps to one of the following in Revenova TMS:

  • Non-Accounting Seed: Customer Invoice (object) -> Currency ISO Code (field) in Revenova TMS.
  • Accounting Seed: Billing (object) -> Currency ISO Code (field).
Max length3
ExampleUSD
referenceNums
Array of object

A list of reference numbers associated with the invoice.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the shipment.

type
string

The type of reference number (e.g., PD for Pickup/Delivery).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The text description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
charges
Array of object

A list of charges associated with the invoice.

object

A charge item associated with the invoice.

type
string

The type of charge (e.g., Line Haul, Fuel, Accessorial).

Valid values[ "Line Haul", "Fuel", "Accessorial" ]
ExampleLine Haul
description
string

The description of the charge.

Maps to one of the following in Revenova TMS:

  • Non-Accounting Seed: Customer Invoice Accessorial (object) -> Name (field)
  • Accounting Seed: Product (object) -> Name (field).
  • SMC3 LTL only: Customer Quote Freight Charge Item (object) -> Item Description (field)
Max length80
ExampleNet Line Haul
qty
number (decimal)

The quantity for the charge item.

Maps to one of the following in Revenova TMS:

  • SMC3 LTL only: Customer Quote Freight Charge Item (object) -> Weight (field)
  • Load (object) -> Distance (Miles) (field)
  • Customer Quote (object) -> Deficit Weight (field)
  • Customer Invoice (object) -> Freight Charge Quantity (field)
  • Customer Invoice (object) -> Fuel Surcharge Quantity (field)
  • Customer Invoice Accessorial (object) -> Quantity (field)
  • Accounting Seed: Billing Line (object) -> Hours/Units (field)
Example1200.0
rate
number (decimal)

The rate for the charge item.

Maps to one of the following in Revenova TMS:

  • SMC3 LTL only: Customer Quote Freight Charge Item (object) -> Rate (field)
  • Customer Quote (object) -> Deficit Rate (field)
  • Customer Invoice (object) -> Freight Charge Unit Price (field)
  • Customer Invoice (object) -> Fuel Surcharge Unit Price (field)
  • Customer Invoice (object) -> Transportation Total - Fuel surcharge - Accessorial Charges - Adjustments (fields, to derive net freight charges)
  • Customer Invoice (object) -> Fuel Surcharge (field)
  • Customer Invoice Accessorial (object) -> Unit Price (field)
  • Accounting Seed: Billing Line (object) -> Rate (field)
Example1.0
rateType
string

The rate type for the charge item.

Maps to one of the following in Revenova TMS:

  • Customer Quote (object) -> Freight Charge Unit (field)
  • Customer Invoice (object) -> Freight Charge Unit (field)
  • Customer Invoice (object) -> Fuel Surcharge Unit (field)
  • Customer Invoice Accessorial (object) -> Unit (field)
  • Accounting Seed: Billing Line (object) -> Unit (field)
Valid values[ "Fixed", "Flat Rate", "Fixed Cost", "Percent of Amount", "Percent of Freight", "Per Cubic Foot", "Per Cubic Meter", "Per Cwt", "Per Day", "Per Equipment Type", "Per Gallon", "Per Handling Unit", "Per Hour", "Per HU Position", "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" ]
ExamplePer Mile
amount
number

The total amount for the charge item.

Maps to various fields for the following objects in Revenova TMS:

  • Customer Invoice (object) -> Invoice Total (field)
  • Customer Invoice (object) -> Net Line Haul (field)
  • Customer Invoice (object) -> Fuel Surcharge (field)
  • Customer Invoice (object) -> Adjustments (field)
  • Customer Invoice (object) -> Accessorial Charges (field)
  • Customer Invoice Accessorial (object) -> Charge (field)
  • Customer Invoice Adjustment (object) -> Adjustment Amount (field)
  • Customer Invoice Tax (object) -> Tax Amount (field)
  • Customer Quote (object) -> Deficit Charge - (Discount / 100 x Deficit Charge) (fields)
  • Customer Quote Freight Charge Item (object) -> Freight Charge (field)
  • Customer Quote Freight Charge Item (object) -> Net Freight Charge (field)
  • Accounting Seed Billing (object) -> Total (field)
  • Accounting Seed Billing Line (object) -> Hours/Units * Rate (fields)
Example1200.0
subAmount
number

The subtotal amount for the charge item before discounts and taxes.

Maps to one of the following in Revenova TMS:

  • Customer Quote Freight Charge Item (object) -> Freight Charge (field)
  • Customer Quote (object) -> Deficit Charge (field)
Example1200.0
discount
number

The discount amount for the charge item.

Maps to one of the following in Revenova TMS:

  • Customer Quote Freight Charge Item (object) -> Discount Amount (field)
  • Customer Quote (object) -> Deficit Charge - (Discount / 100 x Deficit Charge) (fields)
Example1200.0
discountRate
number (decimal)

The discount rate for the charge item.

Maps to one of the following in Revenova TMS:

  • Customer Quote Freight Charge Item (object) -> Discount (field)
  • Customer Quote (object) -> Discount (field)
Example1200.0
ltlCharge
boolean

Indicates if the charge is an LTL charge. Only applies for Line Haul or Deficit charges.

True for SMC3 LTL line haul charge and deficit charges. False for all other charges.

Exampletrue
freightClass
string

The freight class associated with the charge item.

When drawing from line items, takes the lowest NMFC class from the items on the load. Uses "0" for all non-NMFC items.

Maps to one of the following in Revenova TMS:

  • Line Item (object) -> NMFC Class (field)
  • Customer Quote Freight Charge Item (object) -> NMFC Class (Rated As) (field)
Example50
lineItemDescription
string

The line item description associated with the charge item.

Uses "Deficit" for deficit charges

Maps to Customer Quote Freight Charge Item (object) -> Item Description (field) in Revenova TMS.

Max length255
ExampleSteel Beams
nmfcNum
string

The NMFC number associated with the charge item.

Maps to Line Item (object) -> NMFC Number (field) in Revenova TMS.

Max length20
Example21652-02
stopNum
number (integer)

The stop number associated with the charge item.

Maps to Stop (object) -> Number (field) in Revenova TMS.

Example2.0
taxes
Array of object

A list of taxes associated with the invoice.

object

A tax item associated with the invoice.

Maps to Customer Invoice Tax (object) or Accounting Seed: Billing Line (Object) in Revenova TMS.

taxName
string

The name of the sales tax.

Maps to one of the following in Revenova TMS:

  • Sales Tax (object) -> Name (field)
  • Accounting Seed: Product (object) -> Name (field)
Max length80
ExampleSales Tax
taxType
string

The type of sales tax.

Maps to Sales Tax (object) -> Tax Type (field) in Revenova TMS.

ExampleGST
taxIdNumber
string

The tax identification number.

Maps to Sales Tax (object) -> Tax ID Number (field) in Revenova TMS.

Max length50
Example51-2144346
taxRatePct
number (decimal)

The tax rate percentage.

Maps to Customer Invoice Tax (object) -> Tax Rate (field) in Revenova TMS.

Example0.08
taxAmount
number

The tax amount to be paid.

Maps to one of the following in Revenova TMS:

  • Customer Invoice Tax (object) -> Tax Amount (field)
  • Accounting Seed: Billing Line (object) -> Hours/Units * Rate (fields)
Example12.45
stops
Array of object

A list of stops associated with the invoice.

object

A stop associated with the shipment.

Maps to Stop (object) in Revenova TMS.

stopNum
number (integer)

The stop number in the route.

Maps to Stop (object) -> Number (field) in Revenova TMS.

Example1.0
stopType
string

The type of stop.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Is Pickup (field)
  • Stop (object) -> Is Dropoff (field)
Valid values[ "pickup", "dropoff" ]
Examplepickup
stopInstructions
Array of string

Special instructions for the stop. Total length of all instructions should not exceed 2000 characters.

Maps to Stop (object) -> Instructions (field) in Revenova TMS.

Example[ "Careful Handling", "Drop off at door" ]
string

A special instruction for the stop.

company
object

The company information for the stop.

Maps to Account (object) in Revenova TMS.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
companyId
string

The unique identifier for the company.

Maps to EDI Location (object) -> Name (field) in Revenova TMS.

Max length50
ExampleKLIQA
addr
string

The address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city of the company.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The ZIP or postal code of the company.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code of the company, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
referenceNums
Array of object

A list of reference numbers associated with the stop.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the stop.

type
string

The type of reference number (e.g., PD for Pickup/Delivery).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The text description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
items
Array of object

A list of items associated with the invoice.

object

An item associated with the shipment.

Maps to Line Item (object) in Revenova TMS.

pickupStopNum
number (integer)

The pickup stop number for the item.

Maps to Line Item (object) -> Pickup Stop (field) in Revenova TMS.

Example1.0
dropoffStopNum
number (integer)

The dropoff stop number for the item.

Maps to Line Item (object) -> Delivery Stop (field) in Revenova TMS.

Example2.0
itemNum
string

The item number or SKU identifier.

Maps to Line Item (object) -> Name (field) in Revenova TMS.

Max length80
ExampleItem 1
description
string

The description of the item.

Maps to Line Item (object) -> Description (field) in Revenova TMS.

Max length255
ExampleCommodity AAA
handlingUnitCount
number (integer)

The count of handling units for the item.

Maps to Line Item (object) -> HU Count (field) in Revenova TMS.

Example1.0
handlingUnits
string

The type of handling unit.

Maps to Line Item (object) -> Handling Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
packagingUnitCount
number (integer)

The count of packaging units for the item.

Maps to Line Item (object) -> PU Count (field) in Revenova TMS.

Example20.0
packagingUnits
string

The type of packaging unit.

Maps to Line Item (object) -> Packaging Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
weight
number

The weight of the item.

Maps to Line Item (object) -> Weight (field) in Revenova TMS.

Example12.1
weightUnits
string

The units of weight for the item (lbs or kg).

Maps to Line Item (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplelbs
volume
number

The volume of the item.

Maps to Line Item (object) -> Volume (field) in Revenova TMS.

Example34.2
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
length
number (decimal)

The length of the item.

Maps to Line Item (object) -> Length (field) in Revenova TMS.

Example12.1
width
number (decimal)

The width of the item.

Maps to Line Item (object) -> Width (field) in Revenova TMS.

Example12.1
height
number (decimal)

The height of the item.

Maps to Line Item (object) -> Height (field) in Revenova TMS.

Example12.1
dimensionUnits
string

The units of dimension for the item (e.g., in, cm, ft, m).

Maps to Line Item (object) -> Dimension Units (field) in Revenova TMS.

Valid values[ "in", "cm", "ft", "m" ]
Exampleft
nmfcClass
string

The NMFC class for the item (e.g, "50", "55", "60", etc.).

Maps to Line Item (object) -> NMFC Class (field) in Revenova TMS.

Example55
nmfcNum
string

The NMFC code/subcode for the item.

Maps to Line Item (object) -> NMFC Number (field) in Revenova TMS.

Max length20
Example21652-02
isHazMat
boolean

Indicates if the item is hazardous material.

Maps to Line Item (object) -> HazMat (field) in Revenova TMS.

Examplefalse
referenceNums
Array of object

A list of reference numbers associated with the item.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the item.

type
string

The type of reference number (e.g., PD for Pickup/Delivery).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The text description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
206

Valid authentication, valid parameters, no errors, but system detects more than the documented limit is available for processing - re-call the endpoint for more events.

204
[
  {
    "ediCode": 204,
    "inbound": false,
    "ediProviderRetrievalDatetime": "2025-12-19T20:35:42.061Z",
    "ediTransactionId": "a19E2000005sxOPIAY",
    "payload": {
      "carrierTradingPartnerId": "KLIQA",
      "scac": "FLSJ",
      "carrierScac": "AACT",
      "carrierQuoteId": "1122334455",
      "contractId": "QM11223344",
      "shipmentId": "12345",
      "purpose": "Original",
      "mode": "LTL",
      "equipmentType": "Dry Van 48'",
      "equipmentWeight": 1000,
      "equipmentWeightUnits": "kg",
      "containerNumber": "MAEU1234567",
      "specialInstructions": [
        "Special Instructions"
      ],
      "poNum": "12345",
      "orderNum": "45678",
      "bolNum": "98765",
      "sealNumber": "123627",
      "paymentTerms": "Third Party",
      "respondByDate": "2015-12-23",
      "respondByTime": "03:30",
      "timeZone": "LT",
      "currencyCode": "USD",
      "cargoValue": 1000,
      "insuranceAmount": 800,
      "mileage": 56.24,
      "originalTerminalLocation": "CHICAGO NORTH (DSP)",
      "destinationTerminalLocation": "ERIE/YOUNGSTOWN (WARD)",
      "movementType": "60",
      "totalWeight": 5500,
      "weightUnits": "lbs",
      "totalVolume": 5500,
      "volumeUnits": "Cubic Feet",
      "customerBillTo": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "carrierBillTo": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "companyId": "0015000000VvAAAAB",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "customsBroker": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "notifyParty": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "ultimateShipper": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "apptRequired": true,
        "expectedDate": "12-26-2025",
        "expectedTimeStart": "12:30",
        "expectedTimeEnd": "14:30",
        "timeZone": "LT",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "ultimateConsignee": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US",
        "apptRequired": true,
        "expectedDate": "12-26-2025",
        "expectedTimeStart": "12:30",
        "expectedTimeEnd": "14:30",
        "timeZone": "LT",
        "contact": {
          "contactName": "Felicia Wheaton",
          "phone": "555-555-5555",
          "fax": "666-666-6666",
          "email": "fwheaton@trucking.com"
        }
      },
      "referenceNums": [
        {
          "type": "PD",
          "text": "Pickup/Delivery Number",
          "value": "716263587126"
        }
      ],
      "stops": [
        {
          "stopNum": 1,
          "stopType": "pickup",
          "apptRequired": true,
          "expectedDate": "12-26-2025",
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "stopInstructions": [
            "Careful Handling",
            "Drop off at door"
          ],
          "timeZone": "LT",
          "company": {
            "companyName": "Test Company 1",
            "addr": "123 Test Street",
            "city": "Smalltown",
            "state": "MN",
            "zip": "12345",
            "country": "US",
            "companyId": "0015000000VvAAAAB"
          },
          "contacts": [
            {
              "contactName": "Felicia Wheaton",
              "phone": "555-555-5555",
              "fax": "666-666-6666",
              "email": "fwheaton@trucking.com"
            }
          ],
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ],
          "accessorials": [
            "Lift Gate Delivery",
            "After Hours Delivery"
          ]
        }
      ],
      "items": [
        {
          "pickupStopNum": 1,
          "dropoffStopNum": 2,
          "itemNum": "3366468010001",
          "description": "Commodity",
          "handlingUnitCount": 1,
          "handlingUnits": "Boxes",
          "packagingUnitCount": 20,
          "packagingUnits": "Boxes",
          "weight": 12.1,
          "weightUnits": "kg",
          "volume": 34.2,
          "volumeUnits": "Cubic Feet",
          "length": 12.1,
          "width": 12.1,
          "height": 12.1,
          "dimensionUnits": "m",
          "nmfcClass": "55",
          "nmfcNum": "21652-02",
          "stccCode": "01132",
          "isHazMat": false,
          "hazMatContactName": "George Smith",
          "hazMatContactPhone": "312-555-9999",
          "hazMatContactEmail": "georgesmith@company.com",
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ]
        }
      ],
      "charges": [
        {
          "type": "Line Haul",
          "description": "Lift Gate Delivery",
          "amount": 1000
        }
      ]
    }
  }
]
210
[
  {
    "ediCode": 210,
    "inbound": false,
    "ediProviderRetrievalDatetime": "2025-12-19T20:35:42.061Z",
    "ediTransactionId": "a19E2000005sxOPIAY",
    "payload": {
      "tradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "invoiceNum": "TESTINVNUM123",
      "loadNum": "L-10",
      "scac": "AACT",
      "totalWeight": 5500,
      "weightUnits": "lbs",
      "totalVolume": 5500,
      "volumeUnits": "Cubic Feet",
      "containerNumber": "MAEU1234567",
      "customerBillTo": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US"
      },
      "paymentTerms": "Third Party",
      "pickupDate": "2025-12-23",
      "deliveryDate": "2025-12-25",
      "invoiceDate": "2025-12-26",
      "currencyCode": "USD",
      "referenceNums": [
        {
          "type": "PD",
          "text": "Pickup/Delivery Number",
          "value": "716263587126"
        }
      ],
      "charges": [
        {
          "type": "Line Haul",
          "description": "Net Line Haul",
          "code": "123",
          "qty": 1200,
          "rate": 1,
          "rateType": "Per Mile",
          "amount": 1200,
          "subAmount": 1200,
          "discount": 1200,
          "discountRate": 1200,
          "ltlCharge": true,
          "freightClass": "50",
          "lineItemDescription": "Steel Beams",
          "nmfcClass": "55",
          "nmfcNum": "21652-02",
          "stopNum": 2
        }
      ],
      "taxes": [
        {
          "taxName": "Sales Tax",
          "taxType": "GST",
          "taxIdNumber": "51-2144346",
          "taxRatePct": 0.08,
          "taxAmount": 12.45
        }
      ],
      "stops": [
        {
          "stopNum": 1,
          "stopType": "pickup",
          "stopInstructions": [
            "Careful Handling",
            "Drop off at door"
          ],
          "company": {
            "companyName": "Test Company 1",
            "companyId": "KLIQA",
            "addr": "123 Test Street",
            "city": "Smalltown",
            "state": "MN",
            "zip": "12345",
            "country": "US"
          },
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ]
        }
      ],
      "items": [
        {
          "pickupStopNum": 1,
          "dropoffStopNum": 2,
          "itemNum": "Item 1",
          "description": "Commodity AAA",
          "handlingUnitCount": 1,
          "handlingUnits": "Boxes",
          "packagingUnitCount": 20,
          "packagingUnits": "Boxes",
          "weight": 12.1,
          "weightUnits": "lbs",
          "volume": 34.2,
          "volumeUnits": "Cubic Feet",
          "length": 12.1,
          "width": 12.1,
          "height": 12.1,
          "dimensionUnits": "ft",
          "nmfcClass": "55",
          "nmfcNum": "21652-02",
          "isHazMat": false,
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ]
        }
      ]
    }
  }
]
214
[
  {
    "ediCode": 214,
    "inbound": false,
    "ediProviderRetrievalDatetime": "2025-12-19T20:35:42.061Z",
    "ediTransactionId": "a19E2000005sxOPIAY",
    "payload": {
      "tradingPartnerId": "EDIC1",
      "scac": "FLSJ",
      "shipmentId": "12345",
      "loadNum": "L-10",
      "totalWeight": 5500,
      "weightUnits": "lbs",
      "totalVolume": 5500,
      "volumeUnits": "Cubic Feet",
      "containerNumber": "MAEU1234567",
      "customerBillTo": {
        "companyName": "Test Company 1",
        "addr": "123 Test Street",
        "city": "Smalltown",
        "state": "MN",
        "zip": "12345",
        "country": "US"
      },
      "referenceNums": [
        {
          "type": "PD",
          "text": "Pickup/Delivery Number",
          "value": "716263587126"
        }
      ],
      "currentLocation": {
        "status": "In Transit",
        "stopNum": "2",
        "statusDate": "2025-12-24",
        "statusTime": "08:30",
        "timeZone": "LT",
        "city": "Boston",
        "state": "MA",
        "country": "US",
        "lat": 47.5292773045995,
        "lon": -87.20153829304499
      },
      "stops": [
        {
          "stopNum": 1,
          "stopType": "pickup",
          "apptRequired": true,
          "expectedDate": "12-26-2025",
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "stopInstructions": [
            "Careful Handling",
            "Drop off at door"
          ],
          "timeZone": "LT",
          "company": {
            "companyName": "Test Company 1",
            "companyId": "KLIQA",
            "addr": "123 Test Street",
            "city": "Smalltown",
            "state": "MN",
            "zip": "12345",
            "country": "US"
          },
          "events": [
            {
              "status": "In Transit",
              "statusDate": "2025-12-24",
              "statusTime": "08:30",
              "timeZone": "LT",
              "reason": "BG",
              "lat": 47.5292773045995,
              "lon": -87.20153829304499
            }
          ],
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ]
        }
      ],
      "items": [
        {
          "pickupStopNum": 1,
          "dropoffStopNum": 2,
          "itemNum": "Item 1",
          "description": "Commodity AAA",
          "handlingUnitCount": 1,
          "handlingUnits": "Boxes",
          "packagingUnitCount": 20,
          "packagingUnits": "Boxes",
          "weight": 12.1,
          "weightUnits": "lbs",
          "volume": 34.2,
          "volumeUnits": "Cubic Feet",
          "length": 12.1,
          "width": 12.1,
          "height": 12.1,
          "dimensionUnits": "ft",
          "nmfcClass": "55",
          "nmfcNum": "21652-02",
          "isHazMat": false,
          "referenceNums": [
            {
              "type": "PD",
              "text": "Pickup/Delivery Number",
              "value": "716263587126"
            }
          ]
        }
      ]
    }
  }
]
990
[
  {
    "ediCode": 990,
    "inbound": false,
    "ediProviderRetrievalDatetime": "2025-12-19T20:35:42.061Z",
    "ediTransactionId": "a19E2000005sxOPIAY",
    "payload": {
      "tradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "loadNum": "L-10",
      "status": "Accept",
      "declineReasonCode": "TTI",
      "referenceNums": [
        {
          "type": "PD",
          "text": "Pickup/Delivery Number",
          "value": "716263587126"
        }
      ]
    }
  }
]
Expand All
object
ediCode
integer

The EDI codes to send or receive in the body of the request.

Valid values[ 204, 990, 214, 210, 404, 998, 824, 322, 410 ]
Example204
inbound
boolean
Examplefalse
ediProviderRetrievalDatetime
string (date-time)
Example2025-12-19T20:35:42.061Z
ediTransactionId
string
Examplea19E2000005sxOPIAY
payload
OneOf
outboundEdi204
object (outboundEdi204)
carrierTradingPartnerId
string

The trading partner identifier for the carrier receiving the load tender.

Maps to EDI Location (object) -> Name (field) in Revenova TMS.

Max length80
ExampleKLIQA
carrierScac
string

The SCAC of the carrier receiving the load tender.

Maps to Transportation Profile (object) -> SCAC (field) in Revenova TMS.

Max length6
ExampleAACT
carrierQuoteId
string

The unique identification reference for the carrier quote. Falls back on Load Name

Maps to one of the following in Revenova TMS:

  • Carrier Quote (object) -> Carrier Quote Reference (field)
  • Load (object) -> Name (field)
Max length100
Example1122334455
contractId
string

The contract identification for the carrier quote.

Maps to one of the following in Revenova TMS:

  • Carrier Quote (object) -> Contract Id (field)
  • Load (object) -> Name (field)
Max length100
ExampleQM11223344
shipmentId
string

The unique identifier for the shipment load tender.

Maps to Load (object) -> Load Number (field) in Revenova TMS.

Max length80
Example12345
purpose
string

The purpose of the load tender (e.g., Original, Update, Cancellation).

Valid values[ "Original", "Update", "Cancellation" ]
ExampleOriginal
mode
string

The mode of transportation for the shipment, from the carrier service on the carrier quote.

Maps to Mode (object) -> Name (field) in Revenova TMS.

Max length80
ExampleLTL
equipmentType
string

The type of equipment required for the shipment.

Maps to Load (object) -> Equipment Type (field) in Revenova TMS.

Max length80
ExampleDry Van 48'
equipmentWeight
number (integer)

The weight of the equipment type for the shipment.

Maps to Load (object) -> Equipment Weight (field) in Revenova TMS.

Example1000.0
equipmentWeightUnits
string

The weight units of the equipment type for the shipment.

Maps to Load (object) -> Equipment Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplekg
containerNumber
string

The number of the container/trailer for the shipment.

Maps to Load (object) -> Container/Trailer Number (field) in Revenova TMS.

Max length80
ExampleMAEU1234567
specialInstructions
Array of string

A singleton list of special instructions for the shipment.

Maps to Load (object) -> Other Instructions (field) in Revenova TMS.

Example[ "Special Instructions" ]
string

A special instruction for the shipment.

Max length3000
poNum
string

The purchase order number associated with the shipment.

Maps to Load (object) -> PO Number (field) in Revenova TMS.

Max length100
Example12345
orderNum
string

The order number associated with the shipment.

Maps to Load (object) -> Order Number (field) in Revenova TMS.

Max length50
Example45678
bolNum
string

The bill of lading number for the shipment.

Maps to Load (object) -> Bill of Lading Number (field) in Revenova TMS.

Max length55
Example98765
sealNumber
string

The seal number used in the shipment.

Maps to Load (object) -> Seal Number (field) in Revenova TMS.

Max length15
Example123627
paymentTerms
string

The payment terms for the shipment (e.g, Prepaid, Collect, Third Party).

Maps to Load (object) -> Payment Terms (field) in Revenova TMS.

Valid values[ "Prepaid", "Collect", "Third Party" ]
ExampleThird Party
respondByDate
string (date)

The date by which the carrier must respond to the load tender. Date the outbound tender got created.

Format is YYYY-MM-DD.

Example2015-12-23
respondByTime
string

The time by which the carrier must respond to the load tender. 2hrs after the tender got created.

Format is HH:MM in 24-hour format.

Example03:30
timeZone
string

The time zone for the respond by time.

Always LT (Local Time)

ExampleLT
currencyCode
string

The 3-character currency code for monetary values in the load tender.

Maps to Carrier Quote (object) -> Currency ISO Code (field) in Revenova TMS.

Max length3
ExampleUSD
cargoValue
number

The declared value of the cargo being shipped.

Maps to Load (object) -> Cargo Value (field) in Revenova TMS.

Example1000.0
insuranceAmount
number

The amount of insurance coverage for the shipment.

Maps to Load (object) -> Insurance Amount (field) in Revenova TMS.

Example800.0
mileage
number (decimal)

The total mileage for the shipment.

Maps to Load (object) -> Distance (Miles) (field) in Revenova TMS.

Example56.24
originalTerminalLocation
string

The original terminal location of the shipment.

Maps to Carrier Quote (object) -> Origin Terminal Location (field) in Revenova TMS.

Max length255
ExampleCHICAGO NORTH (DSP)
destinationTerminalLocation
string

The destination terminal location of the shipment.

Maps to Carrier Quote (object) -> Destination Terminal Location (field) in Revenova TMS.

Max length255
ExampleERIE/YOUNGSTOWN (WARD)
movementType
string

Code for the type of movement, related to mode

Maps to Carrier Quote (object) -> Movement Type (field) in Revenova TMS.

Valid values[ "Door to Door", "Door to Port", "Port to Door", "Port to Port", "15", "20", "22", "25", "27", "40", "42", "45", "47", "60", "62", "65", "67", "80", "82", "85", "87" ]
Example60
totalWeight
number

The total weight for the shipment.

Maps to Load (object) -> Total Weight (field) in Revenova TMS:

Example5500.0
weightUnits
string

The units of weight for the item (lbs or kg).

Maps to Load (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplelbs
totalVolume
number

The total volume for the shipment.

Maps to Load (object) -> Total Volume (field) in Revenova TMS:

Example5500.0
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
customerBillTo
object

The customer to be billed for the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Billing Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Billing City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Billing State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Billing Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Billing Country Code (field) in Revenova TMS.

Max length80
ExampleUS
contact
object

The contact person for the customer to be billed for the shipment.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
carrierBillTo
object

The company to be billed for the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
companyId
string

The Salesforce unique identifier for the company.

Max length18
Example0015000000VvAAAAB
contact
object

The contact to be billed to for the shipment.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
customsBroker
object

The customs broker associated with the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
contact
object

The customs broker contact for the shipment.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
notifyParty
object

The party to be notified about the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
contact
object

The contact to be notified about the shipment.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
ultimateShipper
object

The ultimate shipper of the load.

companyName
string

The name of the ultimate shipper for the shipment.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the ultimate shipper for the shipment.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city of the ultimate shipper for the shipment.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the ultimate shipper is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the ultimate shipper for the shipment.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code of the ultimate shipper for the shipment, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
apptRequired
boolean

Indicates whether an appointment is required for the ultimate shipper.

Maps to Stop (object) -> Appointment Required (field) in Revenova TMS.

Exampletrue
expectedDate
string (date)

The expected date for the ultimate shipper.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Expected Date (field) in Revenova TMS.

Example12-26-2025
expectedTimeStart
string

The expected start time for the ultimate shipper.

Format is HH:MM.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time(field)
Example12:30
expectedTimeEnd
string

The expected end time for the ultimate shipper.

Format must be HH:MM.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time(field)
Example14:30
timeZone
string

The time zone for the respond by time.

Always LT (Local Time)

ExampleLT
contact
object

The contact of the ultimate shipper for the load.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
ultimateConsignee
object
companyName
string

The name of the ultimate consignee for the shipment.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the ultimate consignee for the shipment.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city of the ultimate consignee for the shipment.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the ultimate consignee is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the ultimate consignee for the shipment.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code of the ultimate consignee for the shipment, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
apptRequired
boolean

Indicates whether an appointment is required for the ultimate consignee.

Maps to Stop (object) -> Appointment Required (field) in Revenova TMS.

Exampletrue
expectedDate
string (date)

The expected date for the ultimate consignee.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Expected Date (field) in Revenova TMS.

Example12-26-2025
expectedTimeStart
string

The expected start time for the ultimate consignee.

Format is HH:MM.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time(field)
Example12:30
expectedTimeEnd
string

The expected end time for the ultimate consignee.

Format is HH:MM.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time(field)
Example14:30
timeZone
string

The time zone for the respond by time.

Always LT (Local Time)

ExampleLT
contact
object

The contact of the ultimate consignee for the load.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
referenceNums
Array of object

A list of reference numbers for the stop.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the stop.

type
string

The type of reference number (e.g., PD, PO, etc.).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The description/label of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
stops
Array of object

A list of stops for the shipment.

Maps to Stop (object) in Revenova TMS.

object
stopNum
number (integer)

The sequential number of the stop in the shipment.

Maps to Stop (object) -> Number (field) in Revenova TMS.

Example1.0
stopType
string

The type of stop (e.g., pickup, dropoff).

Maps to one of the following in Revenova TMS:

  • For pickup stops: Stop (object) -> Is Pickup (field)
  • For dropoff stops: Stop (object) -> Is Dropoff (field)
Valid values[ "pickup", "dropoff" ]
Examplepickup
apptRequired
boolean

Indicates whether an appointment is required for the stop.

Maps to Stop (object) -> Appointment Required (field) in Revenova TMS.

Exampletrue
expectedDate
string (date)

The expected date for the stop.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Expected Date (field) in Revenova TMS.

Example12-26-2025
expectedTimeStart
string

The expected start time for the stop.

Format is HH:MM in 24-hour format.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time (field)
Example12:30
expectedTimeEnd
string

The expected end time for the stop.

Format is HH:MM in 24-hour format.

Maps to Stop (object) -> Shipping/Receiving Hours (field) in Revenova TMS.

Example14:30
stopInstructions
Array of string

A list of specific instructions for the stop.

Maps to Stop (object) -> Instructions (field) in Revenova TMS.

Example[ "Careful Handling", "Drop off at door" ]
string

A specific instruction for the stop.

Max length2000
timeZone
string

The time zone for the respond by time.

Always LT (Local Time)

ExampleLT
company
object

The company information for the stop.

Maps to Account (object) in Revenova TMS.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
companyId
string

The Salesforce unique identifier for the company.

Max length18
Example0015000000VvAAAAB
contacts
Array of object

A list of contacts for the stop.

Maps to Contact (object) in Revenova TMS.

object

A contact person for the stop.

contactName
string

The name of the contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleFelicia Wheaton
phone
string

The phone number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example555-555-5555
fax
string

The fax number of the contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Fax (field) in Revenova TMS.

Max length40
Example666-666-6666
email
string (email)

The email address of the contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplefwheaton@trucking.com
referenceNums
Array of object

A list of reference numbers for the stop.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the stop.

type
string

The type of reference number (e.g., PD, PO, etc.).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The description/label of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
accessorials
Array of string

A list of accessorials related to the stop.

Example[ "Lift Gate Delivery", "After Hours Delivery" ]
string

The accessorial related to the stop.

items
Array of object

A list of items being shipped in the load.

object

An item being shipped in the load.

Maps to Line Item (object) in Revenova TMS.

pickupStopNum
number (integer)

The stop number where the item is picked up.

Maps to Line Item (object) -> Pickup Stop (field) in Revenova TMS.

Example1.0
dropoffStopNum
number (integer)

The stop number where the item is dropped off.

Maps to Line Item (object) -> Delivery Stop (field) in Revenova TMS.

Example2.0
itemNum
string

The unique identifier (SKU) for the item.

Maps to Line Item (object) -> Name (field) in Revenova TMS.

Max length80
Example3366468010001
description
string

The description of the item being shipped.

Maps to Line Item (object) -> Description (field) in Revenova TMS.

Max length255
ExampleCommodity
handlingUnitCount
number (integer)

The number of handling units for the item.

Maps to Line Item (object) -> HU Count (field) in Revenova TMS.

Example1.0
handlingUnits
string

The type of handling unit.

Maps to Line Item (object) -> Handling Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
packagingUnitCount
number (integer)

The number of packaging units for the item.

Maps to Line Item (object) -> PU Count (field) in Revenova TMS.

Example20.0
packagingUnits
string

The type of packaging unit.

Maps to Line Item (object) -> Packaging Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
weight
number

The weight of the item.

Maps to Line Item (object) -> Weight (field) in Revenova TMS.

Example12.1
weightUnits
string

The weight units for the item.

Maps to Line Item (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplekg
volume
number

The volume of the item.

Maps to Line Item (object) -> Volume (field) in Revenova TMS.

Example34.2
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
length
number (decimal)

The length of the handling unit.

Maps to Line Item (object) -> Length (field) in Revenova TMS.

Example12.1
width
number (decimal)

The width of the handling unit.

Maps to Line Item (object) -> Width (field) in Revenova TMS.

Example12.1
height
number (decimal)

The height of the handling unit.

Maps to Line Item (object) -> Height (field) in Revenova TMS.

Example12.1
dimensionUnits
string

The dimension units for the handling unit (e.g, in, cm, ft, m).

Maps to Line Item (object) -> Dimension Units (field) in Revenova TMS.

Valid values[ "in", "cm", "ft", "m" ]
Examplem
nmfcClass
string

The NMFC class for the item (e.g., "50", "55", "60", etc.).

Maps to Line Item (object) -> NMFC Class (field) in Revenova TMS.

Example55
nmfcNum
string

The NMFC code/subcode for the item.

Maps to Line Item (object) -> NMFC Number (field) in Revenova TMS.

Max length20
Example21652-02
stccCode
string

The Standard Transportation Commodity Code (STCC) Code for the item.

Maps to Line Item (object) -> STCC Code (field) in Revenova TMS.

Example01132
isHazMat
boolean

Indicates whether the item is hazardous material.

Maps to Line Item (object) -> HazMat (field) in Revenova TMS.

Examplefalse
hazMatContactName
string

The name of the hazardous material contact person.

Combined First Name + Last Name. Max 80 characters first name, 40 characters for last name.

Maps to the following in Revenova TMS:

  • Contact (object) -> First Name (field)
  • Contact (object) -> Last Name (field)
ExampleGeorge Smith
hazMatContactPhone
string

The phone number of the hazardous material contact person.

Format is XXX-XXX-XXXX.

Maps to Contact (object) -> Phone (field) in Revenova TMS.

Max length40
Example312-555-9999
hazMatContactEmail
string

The email address of the hazardous material contact person.

Maps to Contact (object) -> Email (field) in Revenova TMS.

Max length80
Examplegeorgesmith@company.com
referenceNums
Array of object

A list of reference numbers for the stop.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the stop.

type
string

The type of reference number (e.g., PD, PO, etc.).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The description/label of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
charges
Array of object

A list of charges associated with the shipment.

Maps to Carrier Quote (object) in Revenova TMS.

object

A charge associated with the shipment.

type
string

The type of charge (e.g., Line Haul, Fuel, Accessorial).

Maps to Carrier Quote (object) in Revenova TMS.

Valid values[ "Line Haul", "Fuel", "Accessorial" ]
ExampleLine Haul
description
string

The description of the charge, or Accessorial Name.

Maps to Carrier Quote (object) in Revenova TMS.

Max length80
ExampleLift Gate Delivery
amount
number

The amount of the charge.

Maps to Carrier Quote (object) in Revenova TMS.

Example1000.0
outboundEdi990
object (outboundEdi990)
tradingPartnerId
string

The EDI Trading Partner ID of the Carrier sending the load tender acknowledgment.

Maps to EDI Location (object) -> Name (field) in Revenova TMS.

Max length80
ExampleEDIC1
shipmentId
string

The unique identifier for the shipment load tender.

Maps to the Load (object) field set in TMS Admin > Configuration > EDI Shipment ID in Revenova TMS.

Max length255
Example12345
loadNum
string

The load number associated with this status message.

Maps to Load (object) -> Load Number (field) in Revenova TMS.

Max length80
ExampleL-10
status
string

The status of the load tender acknowledgment (e.g., Accept, Decline, etc.).

Maps to Load (object) -> EDI Status (field) in Revenova TMS.

Valid values[ "Pending", "Accept", "Decline", "Update Pending from Customer", "Updated by Customer", "Cancelled by Customer" ]
ExampleAccept
declineReasonCode
string

The decline reason code for why the tender was declined (e.g., TTI, TAP, UPU, etc.).

Maps to Load (object) -> EDI Decline Reason (field) in Revenova TMS.

Codes:

  • 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
Valid values[ "TTI", "TAP", "UPU", "ECL", "OS", "STL", "DAI", "IR" ]
ExampleTTI
referenceNums
Array of object

The list of reference numbers associated with this status message.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the shipment.

type
string

The type of reference number (e.g., PD for Pickup/Delivery Number).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

A description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
outboundEdi214
object (outboundEdi214)
tradingPartnerId
string

The unique identifier for the trading partner (carrier) receiving the status message.

Maps to EDI Location (object) -> Name (field) in Revenova TMS.

Max length80
ExampleEDIC1
shipmentId
string

The unique identifier for the shipment load tender.

Maps to the Load (object) field set in TMS Admin > Configuration > EDI Shipment ID in Revenova TMS.

Max length255
Example12345
loadNum
string

The load number associated with this status message.

Maps to Load (object) -> Load Number (field) in Revenova TMS.

Max length80
ExampleL-10
scac
string

The SCAC of the customer associated with the load.

Maps to Load (object) -> EDI SCAC (field) in Revenova TMS.

Max length10
ExampleFLSJ
totalWeight
number

The total weight for the shipment.

Maps to Load (object) -> Total Weight (field) in Revenova TMS:

Example5500.0
weightUnits
string

The units of weight for the item (lbs or kg).

Maps to Load (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplelbs
totalVolume
number

The total volume for the shipment.

Maps to Load (object) -> Total Volume (field) in Revenova TMS:

Example5500.0
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
containerNumber
string

The number of the container/trailer for the shipment.

Maps to Load (object) -> Container/Trailer Number (field) in Revenova TMS.

Max length80
ExampleMAEU1234567
customerBillTo
object

The customer to be billed for the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Billing Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Billing City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Billing State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Billing Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Billing Country Code (field) in Revenova TMS.

Max length80
ExampleUS
referenceNums
Array of object

The list of reference numbers associated with this status message.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the shipment.

type
string

The type of reference number (e.g., PD for Pickup/Delivery Number).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

A description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
currentLocation
object

The current location details of the shipment.

status
string

The current status of the shipment (e.g., In Transit, Arrived, Departed, etc.).

Always In Transit if populated, since only In Transit sends currentLocation.

ExampleIn Transit
stopNum
string

The stop number associated with the current location status. Uses an integer format.

Maps to Stop (object) -> Number (field) in Revenova TMS.

Example2
statusDate
string (date)

The date associated with the current location status.

Format is YYYY-MM-DD.

Always the date the load status was generated.

Example2025-12-24
statusTime
string

The time associated with the current location status.

Format is HH:MM in 24-hour time.

Always the time the load status was generated.

Example08:30
timeZone
string

The timezone associated with the current location status.

Always LT (Local Time)

ExampleLT
city
string

The city associated with the current location status.

Maps to Load (object) -> Last Reported City (field) in Revenova TMS.

Max length40
ExampleBoston
state
string

The 2 character state code associated with the current location status.

Maps to Load (object) -> Last Reported State/Province (field) in Revenova TMS.

Max length2
ExampleMA
country
string

The 2-character ISO country code associated with the current location status.

Maps to Load (object) -> Last Reported Country (field) in Revenova TMS.

Max length2
ExampleUS
lat
number (decimal)

The latitude associated with the current location status.

Maps to Load (object) -> Last Reported Geolocation in Revenova TMS.

Example47.5292773045995
lon
number (decimal)

The longitude associated with the current location status.

Maps to Load (object) -> Last Reported Geolocation in Revenova TMS.

Example-87.20153829304499
stops
Array of object

A list of stops associated with the shipment.

object

A stop in the route of the shipment.

Maps to Stop (object) in Revenova TMS.

stopNum
number (integer)

The sequential number of the stop in the shipment.

Maps to Stop (object) -> Number (field) in Revenova TMS.

Example1.0
stopType
string

The type of stop (e.g., pickup, dropoff).

Maps to one of the following in Revenova TMS:

  • For pickup stops: Stop (object) -> Is Pickup (field)
  • For dropoff stops: Stop (object) -> Is Dropoff (field)
Valid values[ "pickup", "dropoff" ]
Examplepickup
apptRequired
boolean

Indicates whether an appointment is required for the stop.

Maps to Stop (object) -> Appointment Required (field) in Revenova TMS.

Exampletrue
expectedDate
string (date)

The expected date for the stop.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Expected Date (field) in Revenova TMS.

Example12-26-2025
expectedTimeStart
string

The expected start time for the stop.

Format is HH:MM in 24-hour format.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Shipping/Receiving Hours (field)
  • Stop (object) -> Appointment Time (field)
Example12:30
expectedTimeEnd
string

The expected end time for the stop.

Format is HH:MM in 24-hour format.

Maps to Stop (object) -> Shipping/Receiving Hours (field) in Revenova TMS.

Example14:30
stopInstructions
Array of string

A list of specific instructions for the stop.

Maps to Stop (object) -> Instructions (field) in Revenova TMS.

Example[ "Careful Handling", "Drop off at door" ]
string

A specific instruction for the stop.

Max length2000
timeZone
string

The time zone for the stop.

Always LT (Local Time)

ExampleLT
company
object

The company information for the stop.

Maps to Account (object) in Revenova TMS.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
companyId
string

The unique identifier for the company.

Max length80
ExampleKLIQA
addr
string

The street address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
events
Array of object

A list of events that occurred at the stop.

object

The stop event and its location details.

status
string

The current status of the shipment (e.g., In Transit, Arrived, Departed, Appointment etc.).

ExampleIn Transit
statusDate
string (date)

The date associated with the current location status.

Format is YYYY-MM-DD.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Expected Date (field)
  • Stop (object) -> Arrival Date (field)
  • Stop (object) -> Departure Date (field)
  • Stop (object) -> Loading/Unloading Complete Date (field)
Example2025-12-24
statusTime
string

The time associated with the current location status.

Format is HH:MM in 24-hour time.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Appointment Time (field)
  • Stop (object) -> Arrival Time (field)
  • Stop (object) -> Departure Time (field)
  • Stop (object) -> Loading/Unloading Complete Time (field)
Example08:30
timeZone
string

The timezone associated with the current location status.

Always LT (Local Time)

ExampleLT
reason
string

The load status reason associated with the current location status.

Maps to Stop (object) -> Carrier Status Reason (field) in Revenova TMS.

Max length2
ExampleBG
lat
number (decimal)

The latitude associated with the current location status.

Maps to one of the following in Revenova TMS:

  • Account (object) -> Shipping Latitude (field)
  • Load (object) -> Last Reported Geolocation
Example47.5292773045995
lon
number (decimal)

The longitude associated with the current location status.

Maps to one of the following in Revenova TMS:

  • Account (object) -> Shipping Longitude (field)
  • Load (object) -> Last Reported Geolocation (field)
Example-87.20153829304499
referenceNums
Array of object

The list of reference numbers associated with this status message.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the shipment.

type
string

The type of reference number (e.g., PD for Pickup/Delivery Number).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

A description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
items
Array of object

A list of items associated with the shipment.

object

An item associated with the shipment.

Maps to Line Item (object) in Revenova TMS.

pickupStopNum
number (integer)

The pickup stop number for the item.

Maps to Line Item (object) -> Pickup Stop (field) in Revenova TMS.

Example1.0
dropoffStopNum
number (integer)

The dropoff stop number for the item.

Maps to Line Item (object) -> Delivery Stop (field) in Revenova TMS.

Example2.0
itemNum
string

The item number or SKU identifier.

Maps to Line Item (object) -> Name (field) in Revenova TMS.

Max length80
ExampleItem 1
description
string

The description of the item.

Maps to Line Item (object) -> Description (field) in Revenova TMS.

Max length255
ExampleCommodity AAA
handlingUnitCount
number (integer)

The count of handling units for the item.

Maps to Line Item (object) -> HU Count (field) in Revenova TMS.

Example1.0
handlingUnits
string

The type of handling unit.

Maps to Line Item (object) -> Handling Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
packagingUnitCount
number (integer)

The count of packaging units for the item.

Maps to Line Item (object) -> PU Count (field) in Revenova TMS.

Example20.0
packagingUnits
string

The type of packaging unit.

Maps to Line Item (object) -> Packaging Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
weight
number

The weight of the item.

Maps to Line Item (object) -> Weight (field) in Revenova TMS.

Example12.1
weightUnits
string

The units of weight for the item (lbs or kg).

Maps to Line Item (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplelbs
volume
number

The volume of the item.

Maps to Line Item (object) -> Volume (field) in Revenova TMS.

Example34.2
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
length
number (decimal)

The length of the item.

Maps to Line Item (object) -> Length (field) in Revenova TMS.

Example12.1
width
number (decimal)

The width of the item.

Maps to Line Item (object) -> Width (field) in Revenova TMS.

Example12.1
height
number (decimal)

The height of the item.

Maps to Line Item (object) -> Height (field) in Revenova TMS.

Example12.1
dimensionUnits
string

The units of dimension for the item (e.g., in, cm, ft, m).

Maps to Line Item (object) -> Dimension Units (field) in Revenova TMS.

Valid values[ "in", "cm", "ft", "m" ]
Exampleft
nmfcClass
string

The NMFC class for the item (e.g., "50", "55", "60", etc.).

Maps to Line Item (object) -> NMFC Class (field) in Revenova TMS.

Example55
nmfcNum
string

The NMFC code/subcode for the item.

Maps to Line Item (object) -> NMFC Number (field) in Revenova TMS.

Max length20
Example21652-02
isHazMat
boolean

Indicates if the item is hazardous material.

Maps to Line Item (object) -> HazMat (field) in Revenova TMS.

Examplefalse
referenceNums
Array of object

A list of reference numbers associated with the item.

object

A reference number associated with the item.

type
string

The type of reference number (e.g., PD for Pickup/Delivery).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The text description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
outboundEdi210
object (outboundEdi210)
tradingPartnerId
string

The trading partner ID of the carrier.

Maps to EDI Location (object) -> Name (field) in Revenova TMS.

Max length80
ExampleEDIC1
shipmentId
string

The unique identifier for the shipment load tender.

Maps to the Load (object) field set in TMS Admin > Configuration > EDI Shipment ID in Revenova TMS.

Max length255
Example12345
invoiceNum
string

The invoice number.

Maps to one of the following in Revenova TMS:

  • Non-Accounting Seed: Customer Invoice (object) -> Name (field)
  • Accounting Seed: Billing (object) -> Proprietary Billing Number (field)
  • Accounting Seed: Billing (object) -> Name (field)
Max length100
ExampleTESTINVNUM123
loadNum
string

The load number associated with this invoice.

Maps to Load (object) -> Load Number (field) in Revenova TMS.

Max length80
ExampleL-10
scac
string

The SCAC of the customer associated with the load.

Maps to Load (object) -> EDI SCAC (field) in Revenova TMS.

Max length10
ExampleAACT
totalWeight
number

The total weight for the shipment.

Maps to Load (object) -> Total Weight (field) in Revenova TMS:

Example5500.0
weightUnits
string

The units of weight for the item (lbs or kg).

Maps to Load (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplelbs
totalVolume
number

The total volume for the shipment.

Maps to Load (object) -> Total Volume (field) in Revenova TMS:

Example5500.0
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
containerNumber
string

The number of the container/trailer for the shipment.

Maps to Load (object) -> Container/Trailer Number (field) in Revenova TMS.

Max length80
ExampleMAEU1234567
customerBillTo
object

The customer to be billed for the shipment.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
addr
string

The street address of the company.

Maps to Account (object) -> Billing Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city where the company is located.

Maps to Account (object) -> Billing City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Billing State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The postal code of the company's location.

Maps to Account (object) -> Billing Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code where the company is located, or full country name if picklists are disabled.

Maps to Account (object) -> Billing Country Code (field) in Revenova TMS.

Max length80
ExampleUS
paymentTerms
string

The payment terms for the invoice (e.g., Prepaid, Collect, Third Party).

Maps to Load (object) -> Payment Terms (field) in Revenova TMS.

Valid values[ "Prepaid", "Collect", "Third Party" ]
ExampleThird Party
pickupDate
string (date)

The pickup date for the shipment.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Arrival Date (field) in Revenova TMS.

Example2025-12-23
deliveryDate
string (date)

The delivery date for the shipment.

Format is YYYY-MM-DD.

Maps to Stop (object) -> Departure Date (field) in Revenova TMS.

Example2025-12-25
invoiceDate
string (date)

The date of the invoice.

Format is YYYY-MM-DD.

Maps to one of the following in Revenova TMS:

  • Non-Accounting Seed: Customer Invoice (object) -> Invoice Date (field) in Revenova TMS.
  • Accounting Seed: Billing (object) -> Date (field).
Example2025-12-26
currencyCode
string

The three-character ISO currency code for the invoice amounts, if multicurrency.

Maps to one of the following in Revenova TMS:

  • Non-Accounting Seed: Customer Invoice (object) -> Currency ISO Code (field) in Revenova TMS.
  • Accounting Seed: Billing (object) -> Currency ISO Code (field).
Max length3
ExampleUSD
referenceNums
Array of object

A list of reference numbers associated with the invoice.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the shipment.

type
string

The type of reference number (e.g., PD for Pickup/Delivery).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The text description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
charges
Array of object

A list of charges associated with the invoice.

object

A charge item associated with the invoice.

type
string

The type of charge (e.g., Line Haul, Fuel, Accessorial).

Valid values[ "Line Haul", "Fuel", "Accessorial" ]
ExampleLine Haul
description
string

The description of the charge.

Maps to one of the following in Revenova TMS:

  • Non-Accounting Seed: Customer Invoice Accessorial (object) -> Name (field)
  • Accounting Seed: Product (object) -> Name (field).
  • SMC3 LTL only: Customer Quote Freight Charge Item (object) -> Item Description (field)
Max length80
ExampleNet Line Haul
qty
number (decimal)

The quantity for the charge item.

Maps to one of the following in Revenova TMS:

  • SMC3 LTL only: Customer Quote Freight Charge Item (object) -> Weight (field)
  • Load (object) -> Distance (Miles) (field)
  • Customer Quote (object) -> Deficit Weight (field)
  • Customer Invoice (object) -> Freight Charge Quantity (field)
  • Customer Invoice (object) -> Fuel Surcharge Quantity (field)
  • Customer Invoice Accessorial (object) -> Quantity (field)
  • Accounting Seed: Billing Line (object) -> Hours/Units (field)
Example1200.0
rate
number (decimal)

The rate for the charge item.

Maps to one of the following in Revenova TMS:

  • SMC3 LTL only: Customer Quote Freight Charge Item (object) -> Rate (field)
  • Customer Quote (object) -> Deficit Rate (field)
  • Customer Invoice (object) -> Freight Charge Unit Price (field)
  • Customer Invoice (object) -> Fuel Surcharge Unit Price (field)
  • Customer Invoice (object) -> Transportation Total - Fuel surcharge - Accessorial Charges - Adjustments (fields, to derive net freight charges)
  • Customer Invoice (object) -> Fuel Surcharge (field)
  • Customer Invoice Accessorial (object) -> Unit Price (field)
  • Accounting Seed: Billing Line (object) -> Rate (field)
Example1.0
rateType
string

The rate type for the charge item.

Maps to one of the following in Revenova TMS:

  • Customer Quote (object) -> Freight Charge Unit (field)
  • Customer Invoice (object) -> Freight Charge Unit (field)
  • Customer Invoice (object) -> Fuel Surcharge Unit (field)
  • Customer Invoice Accessorial (object) -> Unit (field)
  • Accounting Seed: Billing Line (object) -> Unit (field)
Valid values[ "Fixed", "Flat Rate", "Fixed Cost", "Percent of Amount", "Percent of Freight", "Per Cubic Foot", "Per Cubic Meter", "Per Cwt", "Per Day", "Per Equipment Type", "Per Gallon", "Per Handling Unit", "Per Hour", "Per HU Position", "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" ]
ExamplePer Mile
amount
number

The total amount for the charge item.

Maps to various fields for the following objects in Revenova TMS:

  • Customer Invoice (object) -> Invoice Total (field)
  • Customer Invoice (object) -> Net Line Haul (field)
  • Customer Invoice (object) -> Fuel Surcharge (field)
  • Customer Invoice (object) -> Adjustments (field)
  • Customer Invoice (object) -> Accessorial Charges (field)
  • Customer Invoice Accessorial (object) -> Charge (field)
  • Customer Invoice Adjustment (object) -> Adjustment Amount (field)
  • Customer Invoice Tax (object) -> Tax Amount (field)
  • Customer Quote (object) -> Deficit Charge - (Discount / 100 x Deficit Charge) (fields)
  • Customer Quote Freight Charge Item (object) -> Freight Charge (field)
  • Customer Quote Freight Charge Item (object) -> Net Freight Charge (field)
  • Accounting Seed Billing (object) -> Total (field)
  • Accounting Seed Billing Line (object) -> Hours/Units * Rate (fields)
Example1200.0
subAmount
number

The subtotal amount for the charge item before discounts and taxes.

Maps to one of the following in Revenova TMS:

  • Customer Quote Freight Charge Item (object) -> Freight Charge (field)
  • Customer Quote (object) -> Deficit Charge (field)
Example1200.0
discount
number

The discount amount for the charge item.

Maps to one of the following in Revenova TMS:

  • Customer Quote Freight Charge Item (object) -> Discount Amount (field)
  • Customer Quote (object) -> Deficit Charge - (Discount / 100 x Deficit Charge) (fields)
Example1200.0
discountRate
number (decimal)

The discount rate for the charge item.

Maps to one of the following in Revenova TMS:

  • Customer Quote Freight Charge Item (object) -> Discount (field)
  • Customer Quote (object) -> Discount (field)
Example1200.0
ltlCharge
boolean

Indicates if the charge is an LTL charge. Only applies for Line Haul or Deficit charges.

True for SMC3 LTL line haul charge and deficit charges. False for all other charges.

Exampletrue
freightClass
string

The freight class associated with the charge item.

When drawing from line items, takes the lowest NMFC class from the items on the load. Uses "0" for all non-NMFC items.

Maps to one of the following in Revenova TMS:

  • Line Item (object) -> NMFC Class (field)
  • Customer Quote Freight Charge Item (object) -> NMFC Class (Rated As) (field)
Example50
lineItemDescription
string

The line item description associated with the charge item.

Uses "Deficit" for deficit charges

Maps to Customer Quote Freight Charge Item (object) -> Item Description (field) in Revenova TMS.

Max length255
ExampleSteel Beams
nmfcNum
string

The NMFC number associated with the charge item.

Maps to Line Item (object) -> NMFC Number (field) in Revenova TMS.

Max length20
Example21652-02
stopNum
number (integer)

The stop number associated with the charge item.

Maps to Stop (object) -> Number (field) in Revenova TMS.

Example2.0
taxes
Array of object

A list of taxes associated with the invoice.

object

A tax item associated with the invoice.

Maps to Customer Invoice Tax (object) or Accounting Seed: Billing Line (Object) in Revenova TMS.

taxName
string

The name of the sales tax.

Maps to one of the following in Revenova TMS:

  • Sales Tax (object) -> Name (field)
  • Accounting Seed: Product (object) -> Name (field)
Max length80
ExampleSales Tax
taxType
string

The type of sales tax.

Maps to Sales Tax (object) -> Tax Type (field) in Revenova TMS.

ExampleGST
taxIdNumber
string

The tax identification number.

Maps to Sales Tax (object) -> Tax ID Number (field) in Revenova TMS.

Max length50
Example51-2144346
taxRatePct
number (decimal)

The tax rate percentage.

Maps to Customer Invoice Tax (object) -> Tax Rate (field) in Revenova TMS.

Example0.08
taxAmount
number

The tax amount to be paid.

Maps to one of the following in Revenova TMS:

  • Customer Invoice Tax (object) -> Tax Amount (field)
  • Accounting Seed: Billing Line (object) -> Hours/Units * Rate (fields)
Example12.45
stops
Array of object

A list of stops associated with the invoice.

object

A stop associated with the shipment.

Maps to Stop (object) in Revenova TMS.

stopNum
number (integer)

The stop number in the route.

Maps to Stop (object) -> Number (field) in Revenova TMS.

Example1.0
stopType
string

The type of stop.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Is Pickup (field)
  • Stop (object) -> Is Dropoff (field)
Valid values[ "pickup", "dropoff" ]
Examplepickup
stopInstructions
Array of string

Special instructions for the stop. Total length of all instructions should not exceed 2000 characters.

Maps to Stop (object) -> Instructions (field) in Revenova TMS.

Example[ "Careful Handling", "Drop off at door" ]
string

A special instruction for the stop.

company
object

The company information for the stop.

Maps to Account (object) in Revenova TMS.

companyName
string

The name of the company.

Maps to Account (object) -> Name (field) in Revenova TMS.

Max length255
ExampleTest Company 1
companyId
string

The unique identifier for the company.

Maps to EDI Location (object) -> Name (field) in Revenova TMS.

Max length50
ExampleKLIQA
addr
string

The address of the company.

Maps to Account (object) -> Shipping Street (field) in Revenova TMS.

Max length255
Example123 Test Street
city
string

The city of the company.

Maps to Account (object) -> Shipping City (field) in Revenova TMS.

Max length40
ExampleSmalltown
state
string

The 2 character state/province abbreviation where the company is located, or full state name if picklists are disabled.

Maps to Account (object) -> Shipping State Code (field) in Revenova TMS.

Max length80
ExampleMN
zip
string

The ZIP or postal code of the company.

Maps to Account (object) -> Shipping Postal Code (field) in Revenova TMS.

Max length20
Example12345
country
string

The 2-character ISO country code of the company, or full country name if picklists are disabled.

Maps to Account (object) -> Shipping Country Code (field) in Revenova TMS.

Max length80
ExampleUS
referenceNums
Array of object

A list of reference numbers associated with the stop.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the stop.

type
string

The type of reference number (e.g., PD for Pickup/Delivery).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The text description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
items
Array of object

A list of items associated with the invoice.

object

An item associated with the shipment.

Maps to Line Item (object) in Revenova TMS.

pickupStopNum
number (integer)

The pickup stop number for the item.

Maps to Line Item (object) -> Pickup Stop (field) in Revenova TMS.

Example1.0
dropoffStopNum
number (integer)

The dropoff stop number for the item.

Maps to Line Item (object) -> Delivery Stop (field) in Revenova TMS.

Example2.0
itemNum
string

The item number or SKU identifier.

Maps to Line Item (object) -> Name (field) in Revenova TMS.

Max length80
ExampleItem 1
description
string

The description of the item.

Maps to Line Item (object) -> Description (field) in Revenova TMS.

Max length255
ExampleCommodity AAA
handlingUnitCount
number (integer)

The count of handling units for the item.

Maps to Line Item (object) -> HU Count (field) in Revenova TMS.

Example1.0
handlingUnits
string

The type of handling unit.

Maps to Line Item (object) -> Handling Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
packagingUnitCount
number (integer)

The count of packaging units for the item.

Maps to Line Item (object) -> PU Count (field) in Revenova TMS.

Example20.0
packagingUnits
string

The type of packaging unit.

Maps to Line Item (object) -> Packaging Units (field) in Revenova TMS for the following payload schemas:

  • inboundEdi204
  • outboundEdi204
  • outboundEdi214
  • outboundEdi210
Valid values[ "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" ]
ExampleBoxes
weight
number

The weight of the item.

Maps to Line Item (object) -> Weight (field) in Revenova TMS.

Example12.1
weightUnits
string

The units of weight for the item (lbs or kg).

Maps to Line Item (object) -> Weight Units (field) in Revenova TMS.

Valid values[ "lbs", "kg" ]
Examplelbs
volume
number

The volume of the item.

Maps to Line Item (object) -> Volume (field) in Revenova TMS.

Example34.2
volumeUnits
string

The type of volume unit.

List of payload schemas and their possible maps to Revenova TMS fields:

  • inboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi204:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi214:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
  • outboundEdi210:
    • Load (object) -> Volume Units (field)
    • Line Item (object) -> Volume Units (field)
Valid values[ "Cubic Feet", "Cubic Inches", "Cubic Meters", "Cubic Centimeters", "Gallons", "Liters" ]
ExampleCubic Feet
length
number (decimal)

The length of the item.

Maps to Line Item (object) -> Length (field) in Revenova TMS.

Example12.1
width
number (decimal)

The width of the item.

Maps to Line Item (object) -> Width (field) in Revenova TMS.

Example12.1
height
number (decimal)

The height of the item.

Maps to Line Item (object) -> Height (field) in Revenova TMS.

Example12.1
dimensionUnits
string

The units of dimension for the item (e.g., in, cm, ft, m).

Maps to Line Item (object) -> Dimension Units (field) in Revenova TMS.

Valid values[ "in", "cm", "ft", "m" ]
Exampleft
nmfcClass
string

The NMFC class for the item (e.g, "50", "55", "60", etc.).

Maps to Line Item (object) -> NMFC Class (field) in Revenova TMS.

Example55
nmfcNum
string

The NMFC code/subcode for the item.

Maps to Line Item (object) -> NMFC Number (field) in Revenova TMS.

Max length20
Example21652-02
isHazMat
boolean

Indicates if the item is hazardous material.

Maps to Line Item (object) -> HazMat (field) in Revenova TMS.

Examplefalse
referenceNums
Array of object

A list of reference numbers associated with the item.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the item.

type
string

The type of reference number (e.g., PD for Pickup/Delivery).

Maps to Load Reference (object) -> Type (field) in Revenova TMS.

Max length30
ExamplePD
text
string

The text description of the reference number.

Maps to Load Reference (object) -> Label (field) in Revenova TMS.

Max length100
ExamplePickup/Delivery Number
value
string

The value of the reference number.

Maps to Load Reference (object) -> Value (field) in Revenova TMS.

Max length200
Example716263587126
400

EDICode url param is not one of the available options we support

string
ExampleBad request: EDI Code provided in url "<ediCode>" is not a supported EDI code (204, 404, 998, 990, 824, 214, 322, 210, 410)
401

Unauthorized credentials. Provided by Salesforce.

object
message
string

Description of the error

ExampleSession expired or invalid
errorcode
string

Unique ID for the error

ExampleINVALID_SESSION_ID
403

Forbidden User.

object
message
string

Description of the error

ExampleYou do not have access to the Apex class named: EDIService
errorcode
string

Unique ID for the error

ExampleFORBIDDEN
invalidContextUser

The context user set up in the connected app doesn't match any of the edi provider context users in TMS Admin, check setup.

"Forbidden: Invalid EDI Context User"
nonMatchingProvider

The edi transaction whose status is attempted to be patched is not for the provider identified in authentication

"Forbidden: EDI Transaction  does not match provider"
string
500

Catchall for any unexpected errors encountered when trying to queue edi events

string
ExampleInternal Server Error
503

EDI Rest API isn't enabled in TMS Admin

string
ExampleService Unavailable: Rest API not enabled for EDI in TMS Admin