Accepts Inbound EDI Events

Prev Next
Post
/services/apexrest/rtms/ediService

POST endpoint for accepting inbound EDI Events, with mixed EDI codes and payloads. Send 0 to 200 events per request, with up to 100 events guaranteed to process in-order for the same shipmentId.

Security
OAuth

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

FlowClient Credentials
Token URL/services/oauth2/token
Body parameters
204 (Maximal - Original)
[
  {
    "inbound": true,
    "ediCode": 204,
    "payload": {
      "tradingPartnerId": "KLIQA",
      "totalCharge": 5500,
      "totalWeight": 5500,
      "weightUnits": "lbs",
      "totalVolume": 5500,
      "volumeUnits": "Cubic Feet",
      "timeZone": "LT",
      "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"
        }
      },
      "stops": [
        {
          "stopType": "pickup",
          "stopNum": 1,
          "stopInstructions": [
            "Careful Handling"
          ],
          "referenceNums": [
            {
              "value": "VALUE",
              "type": "STOP",
              "text": "Text"
            },
            {
              "value": "2024-04-25",
              "type": "AD",
              "text": "Arrival Date"
            },
            {
              "value": "2024-04-25",
              "type": "DD",
              "text": "Departure Date"
            },
            {
              "value": "716263587126",
              "type": "PD",
              "text": "Pickup/Delivery Number"
            }
          ],
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "expectedDate": "12/26/2025",
          "contacts": [
            {
              "Phone": "555-555-5555",
              "Fax": "666-666-6666",
              "Email": "fwheaton@trucking.com",
              "ContactName": "Felicia Wheaton"
            }
          ],
          "company": {
            "zip": "12345",
            "state": "MN",
            "country": "US",
            "companyName": "Test Company 1",
            "city": "Smalltown",
            "addr": "123 Test Street"
          },
          "apptRequired": false
        },
        {
          "stopType": "dropoff",
          "stopInstructions": [
            "Careful Handling"
          ],
          "referenceNums": [
            {
              "value": "980938459",
              "type": "PD",
              "text": "Pickup/Delivery Number"
            }
          ],
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "expectedDate": "12/28/2025",
          "contacts": [
            {
              "Phone": "777-777-7777",
              "Fax": "888-888-8888",
              "Email": "jwilliams@test.com",
              "ContactName": "Jason Williams"
            }
          ],
          "company": {
            "zip": "54321",
            "state": "IL",
            "country": "US",
            "companyName": "Test Company 2",
            "city": "Chicago",
            "addr": "456 Test Street"
          },
          "apptRequired": true
        }
      ],
      "specialInstructions": [
        "Special Instruction 1",
        "Special Instruction 2"
      ],
      "shipmentId": "12345",
      "scac": "FLSJ",
      "respondByTime": "03:30",
      "respondByDate": "2015-12-23",
      "referenceNums": [
        {
          "value": "1001624728",
          "type": "IL",
          "text": "Internal Order Number"
        },
        {
          "value": "45734",
          "type": "PO",
          "text": "PO Number"
        },
        {
          "value": "2024-04-19",
          "type": "OD",
          "text": "Order Date"
        },
        {
          "value": "FLSJ",
          "type": "SCA",
          "text": "SCAC"
        }
      ],
      "purpose": "Original",
      "poNum": "12345",
      "paymentTerms": "Third Party",
      "orderNum": "45678",
      "mode": "Truckload",
      "mileage": 56.24,
      "items": [
        {
          "width": 12.1,
          "weightUnits": "lbs",
          "weight": 2319.12,
          "volumeUnits": "Cubic Feet",
          "volume": 34.2,
          "referenceNums": [
            {
              "value": "2333",
              "type": "HZ",
              "text": "Hazmat Number"
            },
            {
              "value": "Item-1",
              "type": "IN",
              "text": "Item Number"
            }
          ],
          "pickupStopNum": 1,
          "packagingUnits": "Other",
          "packagingUnitCount": 2000,
          "nmfcClass": "55",
          "length": 12.1,
          "itemNum": "3366468010001",
          "isHazMat": true,
          "height": 12.1,
          "hazMatPackagingGroup": "III",
          "hazMatNumberType": "UN",
          "hazMatNumber": "1234",
          "hazMatContactPhone": "312-555-9999",
          "hazMatContactName": "George Smiley",
          "hazMatContactEmail": "beggerman@thecircus.com",
          "hazMatClassDivision": "4.1",
          "handlingUnits": "Pallets",
          "handlingUnitCount": 1,
          "dropoffStopNum": 2,
          "dimensionUnits": "ft",
          "description": "Commodity"
        },
        {
          "width": 12.1,
          "weightUnits": "lbs",
          "weight": 2319.12,
          "volumeUnits": "Cubic Feet",
          "volume": 34.2,
          "referenceNums": [],
          "pickupStopNum": 1,
          "packagingUnits": "Other",
          "packagingUnitCount": 2000,
          "nmfcClass": "55",
          "length": 12.1,
          "itemNum": "3234468010001",
          "isHazMat": false,
          "height": 12.1,
          "handlingUnits": "Pallets",
          "handlingUnitCount": 1,
          "dropoffStopNum": 2,
          "dimensionUnits": "ft",
          "description": "Stuff"
        }
      ],
      "insuranceAmount": 800,
      "equipmentType": "Dry Van 48'",
      "currencyCode": "USD",
      "charges": [
        {
          "type": "Line Haul",
          "description": "Line Haul",
          "amount": 5000
        },
        {
          "type": "Fuel",
          "description": "Fuel Surcharge",
          "amount": 200
        },
        {
          "type": "Accessorial",
          "description": "Lift Gate Delivery",
          "amount": 100
        },
        {
          "type": "Accessorial",
          "description": "Lumper Delivery",
          "amount": 200
        }
      ],
      "cargoValue": 1000,
      "bolNum": "98765"
    }
  }
]
204 (Maximal - Update)
[
  {
    "inbound": true,
    "ediCode": 204,
    "payload": {
      "tradingPartnerId": "KLIQA",
      "totalCharge": 5500,
      "totalWeight": 5500,
      "weightUnits": "lbs",
      "totalVolume": 5500,
      "volumeUnits": "Cubic Feet",
      "timeZone": "LT",
      "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"
        }
      },
      "stops": [
        {
          "stopType": "pickup",
          "stopNum": 1,
          "stopInstructions": [
            "Careful Handling"
          ],
          "referenceNums": [
            {
              "value": "VALUE",
              "type": "STOP",
              "text": "Text"
            },
            {
              "value": "2024-04-25",
              "type": "AD",
              "text": "Arrival Date"
            },
            {
              "value": "2024-04-25",
              "type": "DD",
              "text": "Departure Date"
            },
            {
              "value": "716263587126",
              "type": "PD",
              "text": "Pickup/Delivery Number"
            }
          ],
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "expectedDate": "12/26/2025",
          "contacts": [
            {
              "Phone": "555-555-5555",
              "Fax": "666-666-6666",
              "Email": "fwheaton@trucking.com",
              "ContactName": "Felicia Wheaton"
            }
          ],
          "company": {
            "zip": "12345",
            "state": "MN",
            "country": "US",
            "companyName": "Test Company 1",
            "city": "Smalltown",
            "addr": "123 Test Street"
          },
          "apptRequired": false
        },
        {
          "stopType": "dropoff",
          "stopInstructions": [
            "Careful Handling"
          ],
          "referenceNums": [
            {
              "value": "980938459",
              "type": "PD",
              "text": "Pickup/Delivery Number"
            }
          ],
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "expectedDate": "12/28/2025",
          "contacts": [
            {
              "Phone": "777-777-7777",
              "Fax": "888-888-8888",
              "Email": "jwilliams@test.com",
              "ContactName": "Jason Williams"
            }
          ],
          "company": {
            "zip": "54321",
            "state": "IL",
            "country": "US",
            "companyName": "Test Company 2",
            "city": "Chicago",
            "addr": "456 Test Street"
          },
          "apptRequired": true
        }
      ],
      "specialInstructions": [
        "Special Instruction 1",
        "Special Instruction 2"
      ],
      "shipmentId": "100012",
      "scac": "FLSJ",
      "respondByTime": "03:30",
      "respondByDate": "2015-12-23",
      "referenceNums": [
        {
          "value": "1001624728",
          "type": "IL",
          "text": "Internal Order Number"
        },
        {
          "value": "45734",
          "type": "PO",
          "text": "PO Number"
        },
        {
          "value": "2024-04-19",
          "type": "OD",
          "text": "Order Date"
        },
        {
          "value": "FLSJ",
          "type": "SCA",
          "text": "SCAC"
        }
      ],
      "purpose": "Update",
      "poNum": "12345",
      "paymentTerms": "Third Party",
      "orderNum": "45678",
      "mode": "Truckload",
      "mileage": 56.24,
      "items": [
        {
          "width": 12.1,
          "weightUnits": "lbs",
          "weight": 2319.12,
          "volumeUnits": "Cubic Feet",
          "volume": 34.2,
          "referenceNums": [
            {
              "value": "2333",
              "type": "HZ",
              "text": "Hazmat Number"
            },
            {
              "value": "Item-1",
              "type": "IN",
              "text": "Item Number"
            }
          ],
          "pickupStopNum": 1,
          "packagingUnits": "Other",
          "packagingUnitCount": 2000,
          "nmfcClass": "55",
          "length": 12.1,
          "itemNum": "3366468010001",
          "isHazMat": true,
          "height": 12.1,
          "hazMatPackagingGroup": "III",
          "hazMatNumberType": "UN",
          "hazMatNumber": "1234",
          "hazMatContactPhone": "312-555-9999",
          "hazMatContactName": "George Smiley",
          "hazMatContactEmail": "beggerman@thecircus.com",
          "hazMatClassDivision": "4.1",
          "handlingUnits": "Pallets",
          "handlingUnitCount": 1,
          "dropoffStopNum": 2,
          "dimensionUnits": "Ft",
          "description": "Commodity"
        },
        {
          "width": 12.1,
          "weightUnits": "lbs",
          "weight": 2319.12,
          "volumeUnits": "Cubic Feet",
          "volume": 34.2,
          "referenceNums": [],
          "pickupStopNum": 1,
          "packagingUnits": "Other",
          "packagingUnitCount": 2000,
          "nmfcClass": "55",
          "length": 12.1,
          "itemNum": "3234468010001",
          "isHazMat": false,
          "height": 12.1,
          "handlingUnits": "Pallets",
          "handlingUnitCount": 1,
          "dropoffStopNum": 2,
          "dimensionUnits": "Ft",
          "description": "Stuff"
        }
      ],
      "insuranceAmount": 800,
      "equipmentType": "Dry Van 48'",
      "containerNumber": "MAEU1234567",
      "currencyCode": "USD",
      "charges": [
        {
          "type": "Line Haul",
          "description": "Line Haul",
          "amount": 5000
        },
        {
          "type": "Fuel",
          "description": "Fuel Surcharge",
          "amount": 200
        },
        {
          "type": "Accessorial",
          "description": "Lift Gate Delivery",
          "amount": 100
        },
        {
          "type": "Accessorial",
          "description": "Lumper Delivery",
          "amount": 200
        }
      ],
      "cargoValue": 1000,
      "bolNum": "98765"
    }
  }
]
204 (Minimal - Original)
[
  {
    "inbound": true,
    "ediCode": 204,
    "payload": {
      "tradingPartnerId": "KLIQA",
      "stops": [
        {
          "stopType": "pickup",
          "expectedDate": "12/26/2025",
          "company": {
            "companyName": "Test Company 1"
          }
        },
        {
          "stopType": "dropoff",
          "expectedDate": "2025-12-28",
          "company": {
            "companyName": "Test Company 2"
          }
        }
      ],
      "shipmentId": "12345",
      "purpose": "Original"
    }
  }
]
204 (Minimal - Update)
[
  {
    "inbound": true,
    "ediCode": 204,
    "payload": {
      "tradingPartnerId": "KLIQA",
      "stops": [
        {
          "stopType": "pickup",
          "expectedDate": "12/26/2025",
          "company": {
            "zip": "12345",
            "state": "MN",
            "country": "US",
            "companyName": "Test Company 1",
            "city": "Smalltown",
            "addr": "123 Test Street"
          }
        },
        {
          "stopType": "dropoff",
          "expectedDate": "2025-12-28",
          "company": {
            "zip": "54321",
            "state": "IL",
            "country": "US",
            "companyName": "Test Company 2",
            "city": "Chicago",
            "addr": "456 Test Street"
          }
        }
      ],
      "shipmentId": "12345",
      "purpose": "Update"
    }
  }
]
204 (Cancellation)
[
  {
    "inbound": true,
    "ediCode": 204,
    "payload": {
      "tradingPartnerId": "KLIQA",
      "shipmentId": "12345",
      "purpose": "Cancellation"
    }
  }
]
404 (Maximal - Original)
[
  {
    "inbound": true,
    "ediCode": 404,
    "payload": {
      "tradingPartnerId": "KLIQA",
      "totalCharge": 5500,
      "totalWeight": 5500,
      "weightUnits": "lbs",
      "totalVolume": 5500,
      "volumeUnits": "Cubic Feet",
      "timeZone": "LT",
      "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"
        }
      },
      "stops": [
        {
          "stopType": "pickup",
          "stopNum": 1,
          "stopInstructions": [
            "Careful Handling"
          ],
          "referenceNums": [
            {
              "value": "VALUE",
              "type": "STOP",
              "text": "Text"
            },
            {
              "value": "2024-04-25",
              "type": "AD",
              "text": "Arrival Date"
            },
            {
              "value": "2024-04-25",
              "type": "DD",
              "text": "Departure Date"
            },
            {
              "value": "716263587126",
              "type": "PD",
              "text": "Pickup/Delivery Number"
            }
          ],
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "expectedDate": "12/26/2025",
          "contacts": [
            {
              "Phone": "555-555-5555",
              "Fax": "666-666-6666",
              "Email": "fwheaton@trucking.com",
              "ContactName": "Felicia Wheaton"
            }
          ],
          "company": {
            "zip": "12345",
            "state": "MN",
            "country": "US",
            "companyName": "Test Company 1",
            "city": "Smalltown",
            "addr": "123 Test Street"
          },
          "apptRequired": false
        },
        {
          "stopType": "dropoff",
          "stopInstructions": [
            "Careful Handling"
          ],
          "referenceNums": [
            {
              "value": "980938459",
              "type": "PD",
              "text": "Pickup/Delivery Number"
            }
          ],
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "expectedDate": "12/28/2025",
          "contacts": [
            {
              "Phone": "777-777-7777",
              "Fax": "888-888-8888",
              "Email": "jwilliams@test.com",
              "ContactName": "Jason Williams"
            }
          ],
          "company": {
            "zip": "54321",
            "state": "IL",
            "country": "US",
            "companyName": "Test Company 2",
            "city": "Chicago",
            "addr": "456 Test Street"
          },
          "apptRequired": true
        }
      ],
      "specialInstructions": [
        "Special Instruction 1",
        "Special Instruction 2"
      ],
      "shipmentId": "12345",
      "scac": "FLSJ",
      "respondByTime": "03:30",
      "respondByDate": "2015-12-23",
      "referenceNums": [
        {
          "value": "1001624728",
          "type": "IL",
          "text": "Internal Order Number"
        },
        {
          "value": "45734",
          "type": "PO",
          "text": "PO Number"
        },
        {
          "value": "2024-04-19",
          "type": "OD",
          "text": "Order Date"
        },
        {
          "value": "FLSJ",
          "type": "SCA",
          "text": "SCAC"
        }
      ],
      "purpose": "Original",
      "poNum": "12345",
      "paymentTerms": "Third Party",
      "orderNum": "45678",
      "mode": "Truckload",
      "mileage": 56.24,
      "items": [
        {
          "width": 12.1,
          "weightUnits": "lbs",
          "weight": 2319.12,
          "volumeUnits": "Cubic Feet",
          "volume": 34.2,
          "referenceNums": [
            {
              "value": "2333",
              "type": "HZ",
              "text": "Hazmat Number"
            },
            {
              "value": "Item-1",
              "type": "IN",
              "text": "Item Number"
            }
          ],
          "pickupStopNum": 1,
          "packagingUnits": "Other",
          "packagingUnitCount": 2000,
          "nmfcClass": "55",
          "length": 12.1,
          "itemNum": "3366468010001",
          "isHazMat": true,
          "height": 12.1,
          "hazMatPackagingGroup": "III",
          "hazMatNumberType": "UN",
          "hazMatNumber": "1234",
          "hazMatContactPhone": "312-555-9999",
          "hazMatContactName": "George Smiley",
          "hazMatContactEmail": "beggerman@thecircus.com",
          "hazMatClassDivision": "4.1",
          "handlingUnits": "Pallets",
          "handlingUnitCount": 1,
          "dropoffStopNum": 2,
          "dimensionUnits": "ft",
          "description": "Commodity"
        },
        {
          "width": 12.1,
          "weightUnits": "lbs",
          "weight": 2319.12,
          "volumeUnits": "Cubic Feet",
          "volume": 34.2,
          "referenceNums": [],
          "pickupStopNum": 1,
          "packagingUnits": "Other",
          "packagingUnitCount": 2000,
          "nmfcClass": "55",
          "length": 12.1,
          "itemNum": "3234468010001",
          "isHazMat": false,
          "height": 12.1,
          "handlingUnits": "Pallets",
          "handlingUnitCount": 1,
          "dropoffStopNum": 2,
          "dimensionUnits": "ft",
          "description": "Stuff"
        }
      ],
      "insuranceAmount": 800,
      "equipmentType": "Dry Van 48'",
      "currencyCode": "USD",
      "charges": [
        {
          "type": "Line Haul",
          "description": "Line Haul",
          "amount": 5000
        },
        {
          "type": "Fuel",
          "description": "Fuel Surcharge",
          "amount": 200
        },
        {
          "type": "Accessorial",
          "description": "Lift Gate Delivery",
          "amount": 100
        },
        {
          "type": "Accessorial",
          "description": "Lumper Delivery",
          "amount": 200
        }
      ],
      "cargoValue": 1000,
      "bolNum": "98765"
    }
  }
]
404 (Maximal - Update)
[
  {
    "inbound": true,
    "ediCode": 404,
    "payload": {
      "tradingPartnerId": "KLIQA",
      "totalCharge": 5500,
      "totalWeight": 5500,
      "weightUnits": "lbs",
      "totalVolume": 5500,
      "volumeUnits": "Cubic Feet",
      "timeZone": "LT",
      "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"
        }
      },
      "stops": [
        {
          "stopType": "pickup",
          "stopNum": 1,
          "stopInstructions": [
            "Careful Handling"
          ],
          "referenceNums": [
            {
              "value": "VALUE",
              "type": "STOP",
              "text": "Text"
            },
            {
              "value": "2024-04-25",
              "type": "AD",
              "text": "Arrival Date"
            },
            {
              "value": "2024-04-25",
              "type": "DD",
              "text": "Departure Date"
            },
            {
              "value": "716263587126",
              "type": "PD",
              "text": "Pickup/Delivery Number"
            }
          ],
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "expectedDate": "12/26/2025",
          "contacts": [
            {
              "Phone": "555-555-5555",
              "Fax": "666-666-6666",
              "Email": "fwheaton@trucking.com",
              "ContactName": "Felicia Wheaton"
            }
          ],
          "company": {
            "zip": "12345",
            "state": "MN",
            "country": "US",
            "companyName": "Test Company 1",
            "city": "Smalltown",
            "addr": "123 Test Street"
          },
          "apptRequired": false
        },
        {
          "stopType": "dropoff",
          "stopInstructions": [
            "Careful Handling"
          ],
          "referenceNums": [
            {
              "value": "980938459",
              "type": "PD",
              "text": "Pickup/Delivery Number"
            }
          ],
          "expectedTimeStart": "12:30",
          "expectedTimeEnd": "14:30",
          "expectedDate": "12/28/2025",
          "contacts": [
            {
              "Phone": "777-777-7777",
              "Fax": "888-888-8888",
              "Email": "jwilliams@test.com",
              "ContactName": "Jason Williams"
            }
          ],
          "company": {
            "zip": "54321",
            "state": "IL",
            "country": "US",
            "companyName": "Test Company 2",
            "city": "Chicago",
            "addr": "456 Test Street"
          },
          "apptRequired": true
        }
      ],
      "specialInstructions": [
        "Special Instruction 1",
        "Special Instruction 2"
      ],
      "shipmentId": "100012",
      "scac": "FLSJ",
      "respondByTime": "03:30",
      "respondByDate": "2015-12-23",
      "referenceNums": [
        {
          "value": "1001624728",
          "type": "IL",
          "text": "Internal Order Number"
        },
        {
          "value": "45734",
          "type": "PO",
          "text": "PO Number"
        },
        {
          "value": "2024-04-19",
          "type": "OD",
          "text": "Order Date"
        },
        {
          "value": "FLSJ",
          "type": "SCA",
          "text": "SCAC"
        }
      ],
      "purpose": "Update",
      "poNum": "12345",
      "paymentTerms": "Third Party",
      "orderNum": "45678",
      "mode": "Truckload",
      "mileage": 56.24,
      "items": [
        {
          "width": 12.1,
          "weightUnits": "lbs",
          "weight": 2319.12,
          "volumeUnits": "Cubic Feet",
          "volume": 34.2,
          "referenceNums": [
            {
              "value": "2333",
              "type": "HZ",
              "text": "Hazmat Number"
            },
            {
              "value": "Item-1",
              "type": "IN",
              "text": "Item Number"
            }
          ],
          "pickupStopNum": 1,
          "packagingUnits": "Other",
          "packagingUnitCount": 2000,
          "nmfcClass": "55",
          "length": 12.1,
          "itemNum": "3366468010001",
          "isHazMat": true,
          "height": 12.1,
          "hazMatPackagingGroup": "III",
          "hazMatNumberType": "UN",
          "hazMatNumber": "1234",
          "hazMatContactPhone": "312-555-9999",
          "hazMatContactName": "George Smiley",
          "hazMatContactEmail": "beggerman@thecircus.com",
          "hazMatClassDivision": "4.1",
          "handlingUnits": "Pallets",
          "handlingUnitCount": 1,
          "dropoffStopNum": 2,
          "dimensionUnits": "Ft",
          "description": "Commodity"
        },
        {
          "width": 12.1,
          "weightUnits": "lbs",
          "weight": 2319.12,
          "volumeUnits": "Cubic Feet",
          "volume": 34.2,
          "referenceNums": [],
          "pickupStopNum": 1,
          "packagingUnits": "Other",
          "packagingUnitCount": 2000,
          "nmfcClass": "55",
          "length": 12.1,
          "itemNum": "3234468010001",
          "isHazMat": false,
          "height": 12.1,
          "handlingUnits": "Pallets",
          "handlingUnitCount": 1,
          "dropoffStopNum": 2,
          "dimensionUnits": "Ft",
          "description": "Stuff"
        }
      ],
      "insuranceAmount": 800,
      "equipmentType": "Dry Van 48'",
      "containerNumber": "MAEU1234567",
      "currencyCode": "USD",
      "charges": [
        {
          "type": "Line Haul",
          "description": "Line Haul",
          "amount": 5000
        },
        {
          "type": "Fuel",
          "description": "Fuel Surcharge",
          "amount": 200
        },
        {
          "type": "Accessorial",
          "description": "Lift Gate Delivery",
          "amount": 100
        },
        {
          "type": "Accessorial",
          "description": "Lumper Delivery",
          "amount": 200
        }
      ],
      "cargoValue": 1000,
      "bolNum": "98765"
    }
  }
]
404 (Minimal - Original)
[
  {
    "inbound": true,
    "ediCode": 404,
    "payload": {
      "tradingPartnerId": "KLIQA",
      "stops": [
        {
          "stopType": "pickup",
          "expectedDate": "12/26/2025",
          "company": {
            "companyName": "Test Company 1"
          }
        },
        {
          "stopType": "dropoff",
          "expectedDate": "2025-12-28",
          "company": {
            "companyName": "Test Company 2"
          }
        }
      ],
      "shipmentId": "12345",
      "purpose": "Original"
    }
  }
]
404 (Minimal - Update)
[
  {
    "inbound": true,
    "ediCode": 404,
    "payload": {
      "tradingPartnerId": "KLIQA",
      "stops": [
        {
          "stopType": "pickup",
          "expectedDate": "12/26/2025",
          "company": {
            "zip": "12345",
            "state": "MN",
            "country": "US",
            "companyName": "Test Company 1",
            "city": "Smalltown",
            "addr": "123 Test Street"
          }
        },
        {
          "stopType": "dropoff",
          "expectedDate": "2025-12-28",
          "company": {
            "zip": "54321",
            "state": "IL",
            "country": "US",
            "companyName": "Test Company 2",
            "city": "Chicago",
            "addr": "456 Test Street"
          }
        }
      ],
      "shipmentId": "12345",
      "purpose": "Update"
    }
  }
]
998 (Cancellation)
[
  {
    "inbound": true,
    "ediCode": 404,
    "payload": {
      "tradingPartnerId": "KLIQA",
      "shipmentId": "12345",
      "purpose": "Cancellation"
    }
  }
]
990 (Maximal - Accept)
[
  {
    "ediCode": 990,
    "inbound": true,
    "payload": {
      "bookingNumber": "Booking",
      "carrierTradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "status": "Accept",
      "waybillNumber": "Waybill"
    }
  }
]
990 (Maximal - Decline)
[
  {
    "ediCode": 990,
    "inbound": true,
    "payload": {
      "bookingNumber": "Booking",
      "carrierTradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "status": "Decline",
      "tenderDeclinedComments": "Invalid load for some reason",
      "tenderDeclinedReasonCodes": [
        "ASV",
        "RTN"
      ],
      "tenderExceptionComments": "Encountered an issue processing",
      "waybillNumber": "Waybill"
    }
  }
]
990 (Minimal - Accept)
[
  {
    "ediCode": 990,
    "inbound": true,
    "payload": {
      "carrierTradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "status": "Accept"
    }
  }
]
990 (Minimal - Decline)
[
  {
    "ediCode": 990,
    "inbound": true,
    "payload": {
      "carrierTradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "status": "Decline"
    }
  }
]
824 (Maximal - Accept)
[
  {
    "ediCode": 824,
    "inbound": true,
    "payload": {
      "bookingNumber": "Booking",
      "carrierTradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "status": "Accept",
      "waybillNumber": "Waybill"
    }
  }
]
824 (Maximal - Decline)
[
  {
    "ediCode": 824,
    "inbound": true,
    "payload": {
      "bookingNumber": "Booking",
      "carrierTradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "status": "Decline",
      "tenderDeclinedComments": "Invalid load for some reason",
      "tenderDeclinedReasonCodes": [
        "ASV",
        "RTN"
      ],
      "tenderExceptionComments": "Encountered an issue processing",
      "waybillNumber": "Waybill"
    }
  }
]
824 (Minimal - Accept)
[
  {
    "ediCode": 824,
    "inbound": true,
    "payload": {
      "carrierTradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "status": "Accept"
    }
  }
]
824 (Minimal - Decline)
[
  {
    "ediCode": 824,
    "inbound": true,
    "payload": {
      "carrierTradingPartnerId": "EDIC1",
      "shipmentId": "12345",
      "status": "Decline"
    }
  }
]
214 (Maximal)
[
  {
    "ediCode": 214,
    "inbound": true,
    "payload": {
      "bookingNumber": "1234672137",
      "carrierTradingPartnerId": "EDIC1",
      "containerNumber": "MAEU1234567",
      "eventCity": "Chicago",
      "eventCode": "AF",
      "eventCountry": "US",
      "eventDate": "2025-07-04",
      "eventDetail": "This is the detail",
      "eventState": "IL",
      "eventTime": "08:30",
      "eventTimeZone": "LT",
      "eventZip": "60603",
      "latitude": 47.5292773045995,
      "longitude": -87.20153829304499,
      "proNumber": "PRO1234567",
      "sealNumber": "2372499345",
      "stopNumber": 2,
      "shipmentId": "12345",
      "waybillNumber": "45678910"
    }
  }
]
214 (Minimal)
[
  {
    "ediCode": 214,
    "inbound": true,
    "payload": {
      "carrierTradingPartnerId": "EDIC1",
      "shipmentId": "12345"
    }
  }
]
322 (Maximal)
[
  {
    "ediCode": 322,
    "inbound": true,
    "payload": {
      "bookingNumber": "1234672631",
      "carrierTradingPartnerId": "EDIC1",
      "containerNumber": "MAEU14564513",
      "eventCity": "Chicago",
      "eventCode": "AF",
      "eventCountry": "US",
      "eventDate": "2025-07-04",
      "eventDetail": "This is the detail",
      "eventState": "IL",
      "eventTime": "08:30",
      "eventTimeZone": "LT",
      "eventZip": "60603",
      "latitude": 47.5292773045995,
      "longitude": -87.20153829304499,
      "proNumber": "PRO1234567",
      "sealNumber": "2372499345",
      "stopNumber": 2,
      "shipmentId": "12345",
      "waybillNumber": "45678910"
    }
  }
]
322 (Minimal)
[
  {
    "ediCode": 322,
    "inbound": true,
    "payload": {
      "carrierTradingPartnerId": "EDIC1",
      "shipmentId": "12345"
    }
  }
]
210 (Maximal)
[
  {
    "inbound": true,
    "ediCode": 210,
    "payload": {
      "waybillNumber": "way12345",
      "ultimateShipperStreet": "526 Beacon Street",
      "ultimateShipperState": "MA",
      "ultimateShipperPostalCode": "02215",
      "ultimateShipperName": "Ultimate Shipper ABC",
      "ultimateShipperCountry": "US",
      "ultimateShipperCity": "Boston",
      "ultimateConsigneeStreet": "1526 Beacon Street",
      "ultimateConsigneeState": "MA",
      "ultimateConsigneePostalCode": "02219",
      "ultimateConsigneeName": "Ultimate Consignee DEF",
      "ultimateConsigneeCountry": "US",
      "ultimateConsigneeCity": "Bostona",
      "shipmentId": "12345",
      "proNumber": "pro12345",
      "originStreet": "2333 Waukegan Rd.",
      "originState": "IL",
      "originPostalCode": "60045",
      "originName": "ABC Shipper",
      "originCountry": "US",
      "originCity": "Bannockburn",
      "items": [
        {
          "weightUnits": "lbs",
          "weight": 100,
          "rateType": "Per Mile",
          "rate": 0.25,
          "quantity": 10,
          "freightClass": "50",
          "description": "Commodity AAA",
          "amount": 100
        }
      ],
      "invoiceNum": "TESTINVNUM123",
      "invoiceDueDate": "2025-10-07",
      "invoiceDate": "2025-09-22",
      "destinationStreet": "526 Beacon Street",
      "destinationState": "MA",
      "destinationPostalCode": "02215",
      "destinationName": "ABC Shipper",
      "destinationCountry": "US",
      "destinationCity": "Boston",
      "currencyCode": "USD",
      "charges": [
        {
          "type": "Line Haul",
          "rateType": "Per Mile",
          "rate": 1,
          "qty": 1200,
          "description": "Net Line Haul",
          "amount": 1200
        },
        {
          "type": "Fuel",
          "rateType": "Per Mile",
          "rate": 0.25,
          "qty": 1200,
          "description": "Fuel Surcharge",
          "amount": 300
        },
        {
          "type": "Accessorial",
          "stopNum": 2,
          "rateType": "Fixed Cost",
          "rate": 75,
          "qty": 1,
          "description": "After Hours Delivery",
          "amount": 75
        }
      ],
      "carrierTradingPartnerId": "EDIC1",
      "carrierBillToStreet": "1526 Beacon Street",
      "carrierBillToState": "MA",
      "carrierBillToPostalCode": "02219",
      "carrierBillToName": "Ultimate Consignee DEF",
      "carrierBillToCountry": "US",
      "carrierBillToCity": "Bostona"
    }
  }
]
210 (Minimal)
[
  {
    "inbound": true,
    "ediCode": 210,
    "payload": {
      "shipmentId": "12345",
      "invoiceDate": "2025-11-11",
      "carrierTradingPartnerId": "EDIC1"
    }
  }
]
410 (Maximal)
[
  {
    "inbound": true,
    "ediCode": 410,
    "payload": {
      "waybillNumber": "way12345",
      "ultimateShipperStreet": "526 Beacon Street",
      "ultimateShipperState": "MA",
      "ultimateShipperPostalCode": "02215",
      "ultimateShipperName": "Ultimate Shipper ABC",
      "ultimateShipperCountry": "US",
      "ultimateShipperCity": "Boston",
      "ultimateConsigneeStreet": "1526 Beacon Street",
      "ultimateConsigneeState": "MA",
      "ultimateConsigneePostalCode": "02219",
      "ultimateConsigneeName": "Ultimate Consignee DEF",
      "ultimateConsigneeCountry": "US",
      "ultimateConsigneeCity": "Bostona",
      "shipmentId": "12345",
      "proNumber": "pro12345",
      "originStreet": "2333 Waukegan Rd.",
      "originState": "IL",
      "originPostalCode": "60045",
      "originName": "ABC Shipper",
      "originCountry": "US",
      "originCity": "Bannockburn",
      "items": [
        {
          "weightUnits": "lbs",
          "weight": 100,
          "rateType": "Per Mile",
          "rate": 0.25,
          "quantity": 10,
          "freightClass": "50",
          "description": "Commodity AAA",
          "amount": 100
        }
      ],
      "invoiceNum": "TESTINVNUM123",
      "invoiceDueDate": "2025-10-07",
      "invoiceDate": "2025-09-22",
      "destinationStreet": "526 Beacon Street",
      "destinationState": "MA",
      "destinationPostalCode": "02215",
      "destinationName": "ABC Shipper",
      "destinationCountry": "US",
      "destinationCity": "Boston",
      "currencyCode": "USD",
      "charges": [
        {
          "type": "Line Haul",
          "rateType": "Per Mile",
          "rate": 1,
          "qty": 1200,
          "description": "Net Line Haul",
          "amount": 1200
        },
        {
          "type": "Fuel",
          "rateType": "Per Mile",
          "rate": 0.25,
          "qty": 1200,
          "description": "Fuel Surcharge",
          "amount": 300
        },
        {
          "type": "Accessorial",
          "stopNum": 2,
          "rateType": "Fixed Cost",
          "rate": 75,
          "qty": 1,
          "description": "After Hours Delivery",
          "amount": 75
        }
      ],
      "carrierTradingPartnerId": "EDIC1",
      "carrierBillToStreet": "1526 Beacon Street",
      "carrierBillToState": "MA",
      "carrierBillToPostalCode": "02219",
      "carrierBillToName": "Ultimate Consignee DEF",
      "carrierBillToCountry": "US",
      "carrierBillToCity": "Bostona"
    }
  }
]
410 (Minimal)
[
  {
    "inbound": true,
    "ediCode": 410,
    "payload": {
      "shipmentId": "12345",
      "invoiceDate": "2025-11-11",
      "carrierTradingPartnerId": "EDIC1"
    }
  }
]
Array of object

A list of Inbound EDI Events.

Max items200
object

An Inbound EDI Event with EDI code and payload.

ediCode
integer Required

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
Exampletrue
payload
OneOf
inboundEdi204
object (inboundEdi204)
tradingPartnerId
string Required

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

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

Max length50
ExampleKLIQA
shipmentId
string Required

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
scac
string

The SCAC of the customer associated with the load.

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

Max length10
ExampleFLSJ
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
purpose
string Required

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

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

The mode of transportation for the shipment.

Maps to Mode (object) -> Name (field) in Revenova TMS. Mode must be pre-defined in Revenova TMS.

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'
specialInstructions
Array of string

A list of special instructions for the shipment.

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

Example[ "Special Instruction 1", "Special Instruction 2" ]
string

A special instruction for the shipment.

Max length3000
poNum
string

The purchase order number associated with the shipment. Combines with any PO Numbers identified in reference nums with semicolons.

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
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.

Format can be YYYY-MM-DD, MM/DD/YYYY, YYYYMMDD, or MMDDYYYY.

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

Example2015-12-23
respondByTime
string

The time by which the carrier must respond to the load tender.

Format must be HH:MM in 24-hour format.

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

Example03:30
timeZone
string

The time zone for the respond by time.

LT = Local Time

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

ExampleLT
currencyCode
string

The 3-character currency code for monetary values in the load tender, relevant for multicurrency orgs only

Maps to Load (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
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
totalCharge
number

The total charge for the shipment.

Maps to one of the following Load in Revenova TMS:

  • Load (object) -> EDI Quote Total (field)
  • Customer Quote (object) -> Customer Quote Total (field)
Example5500.0
referenceNums
Array of object

A list of reference numbers associated with the shipment.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the shipment.

Can have 0-to-many reference numbers.

type
string

The type of reference number.

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.

Requires 2 or more stops.

Maps to Stop (object) in Revenova TMS.

object
stopType
string Required

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) Required

The expected date for the stop.

Format can be YYYY-MM-DD, MM/DD/YYYY, YYYYMMDD, or MMDDYYYY.

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

Example12-26-2025
expectedTimeStart
string

The expected start time for the stop.

Format must be 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 must be 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)
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
company
object Required

The company information for the stop.

Maps to Account (object) in Revenova TMS.

companyName
string Required

The name of the company.

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

Max length80
ExampleTest Company 1
companyId
string

The EDI Trading Partner ID of the company.

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

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
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.

Can have 0-to-many contacts.

contactName
string Required

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 (phone)

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 (phone)

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.

Can have 0-to-many reference numbers.

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
items
Array of object

A list of items being shipped in the load.

Maps to Line Item (object) in Revenova TMS.

object

An item being shipped in the load.

Can have 0-to-many line items.

pickupStopNum
number (integer) Required

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) Required

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 length50
Example3366468010001
description
string Required

The description of the item being shipped. Autofills with itemNum if left out.

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 Required

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
isHazMat
boolean

Indicates whether the item is hazardous material.

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

Examplefalse
hazMatNumberType
string

The hazardous material number type (e.g., UN, NA).

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

Valid values[ "UN", "NA" ]
ExampleNA
hazMatNumber
string

The hazardous material number.

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

Max length4
Example1234
hazMatClassDivision
string

The hazardous material class/division.

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

Valid values[ "1.1", "1.2", "1.3", "1.4", "1.5", "1.6", "2.1", "2.2", "2.3", "3", "4.1", "4.2", "4.3", "5.1", "5.2", "6.1", "6.2", "7", "8", "9" ]
Example6.1
hazMatPackagingGroup
string

The hazardous material packaging group.

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

Valid values[ "I", "II", "III" ]
ExampleI
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 Contact (object) -> Name (field) in Revenova TMS.

Max length80
ExampleGeorge Smith
hazMatContactPhone
string (phone)

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 (email)

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 line item.

Maps to Load Reference (object) in Revenova TMS.

object

A reference number associated with the line item.

Can have 0-to-many reference numbers.

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 Customer Quote and Carrier Quote (objects) in Revenova TMS.

object

A charge associated with the shipment.

Can have 0-to-many charges.

type
string Required

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

Maps to Customer Quote and Carrier Quote (objects) in Revenova TMS.

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

The description of the charge.

Maps to Customer Quote Accessorial (object) -> Name (field) in Revenova TMS.

Max length80
ExampleLift Gate Delivery
amount
number Required

The amount of the charge.

Maps to Customer Quote and Carrier Quote (objects) in Revenova TMS.

Example1000.0
inboundEdi990
object (inboundEdi990)
carrierTradingPartnerId
string Required

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 Required

The unique identifier for the shipment this load tender acknowledgment is for.

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

Max length80
Example12345
status
string

The status of the load tender acknowledgment: accept or decline. Treated as decline if not populated.

Valid values[ "Accept", "Accept with Exception", "Decline" ]
ExampleAccept
waybillNumber
string

The Waybill Number assigned by the carrier for the load.

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

Max length40
ExampleWAY12345
bookingNumber
string

The Booking Number assigned by the carrier for the load.

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

Max length30
ExampleBooking12345
tenderDeclinedReasonCodes
Array of string

A list of reason codes for declining the load tender.

string

The reason code for declining the load tender.

Maps to Carrier Quote (object) -> Tender Declined Reasons (field) in Revenova TMS.

Valid values[ "827", "828", "137", "ASA", "AVE", "ASV", "NOC", "RTN", "2", "1", "CHK", "847", "114", "COV", "819", "820", "821", "849", "129", "CAL", "28", "27", "26", "29", "DDT", "6", "815", "3", "DBL", "111", "DRC", "119", "121", "817", "DUP", "101", "810", "Equipment Breakdown", "Equipment No Longer Available", "142", "102", "INC", "848", "DTE", "126", "833", "ICG", "ICA", "12", "4", "CUR", "LOC", "SEV", "TYP", "9", "802", "IDC", "IDN", "MU", "MS", "IID", "IQT", "IMD", "832", "SCA", "36", "RTE", "SPL", "122", "123", "INF", "NIF", "STR", "UNP", "VIN", "SCD", "IWT", "104", "105", "106", "133", "108", "500", "115", "818", "7", "MDN", "805", "809", "MT", "MR", "MID", "128", "110", "124", "MC", "MM", "831", "C", "ME", "MH", "834", "806", "D", "MF", "MD", "134", "O", "Q", "P", "107", "F", "E", "MP", "MQ", "807", "K", "813", "N", "804", "803", "B", "G", "MB", "J", "808", "A", "MI", "ML", "MK", "140", "I", "MA", "M", "R", "L", "MJ", "801", "MG", "MN", "H", "139", "V", "U", "S", "112", "113", "MQT", "812", "MWT", "MBL", "109", "NCL", "NCR", "NDP", "826", "NRA", "RAT", "NAU", "NDT", "11", "NOD", "VOS", "ZZZ", "24", "OTH", "8", "W", "829", "825", "824", "823", "811", "PND", "PPD", "PRM", "NRS", "141", "138", "POI", "HUG", "HUL", "QTY", "RU", "814", "136", "830", "116", "5", "117", "118", "STA", "STP", "120", "IPR", "10", "822", "TRN", "130", "T", "UCN", "UKN", "UNV", "125", "UAU", "VND", "ZDS", "131" ]
ExampleASV
tenderDeclinedComments
string

Additional comments regarding the load tender decline.

Maps to Carrier Quote (object) -> Tender Declined Comments (field) in Revenova TMS.

Max length255
ExampleInvalid load for some reason
tenderExceptionComments
string

Additional comments regarding the load tender exception.

Maps to Carrier Quote (object) -> Tender Exception Comments (field) in Revenova TMS.

Max length255
ExampleEncountered an issue processing
inboundEdi214
object (inboundEdi214)
carrierTradingPartnerId
string Required

The EDI Trading Partner ID of the Carrier sending the shipment status.

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

Max length80
ExampleEDIC1
shipmentId
string Required

The unique identifier for the shipment this status is associated with.

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

Max length80
Example12345
stopNumber
number (integer)

The stop number on the load this status is associated with.

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

Example2.0
eventCode
string

The event code representing the type of shipment status event. Affects stop status.

Valid values[ "X3", "AF", "I1", "RL", "RA", "RD", "AG", "X6", "AR", "UR", "NT", "OA", "X1", "S1", "D1", "CD", "TA", "A", "AL", "Z", "D", "J", "P", "B", "CB", "CC", "AD", "NF", "I", "T", "TM", "L", "R", "XA", "RN", "G", "S", "VA", "VD", "W" ]
eventDetail
string

Additional details about the event.

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

Max length255
ExampleThis is the detail
eventDate
string (date)

The date the event occurred.

Format is YYYY-MM-DD.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Carrier ETA Date (field) for estimated events
  • Stop (object) -> Arrival Date (field) for arrival events
  • Stop (object) -> Departure Date (field) for departure events
Example2025-07-04
eventTime
string

The time the event occurred.

Format is HH:MM in 24-hour time.

Maps to one of the following in Revenova TMS:

  • Stop (object) -> Carrier ETA Time (field) for estimated events
  • Stop (object) -> Arrival Time (field) for arrival events
  • Stop (object) -> Departure Time (field) for departure events
Example08:30
eventTimeZone
string

The time zone of the event time.

LT = Local Time

ExampleLT
eventCity
string

The city where the event occurred.

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

Max length40
ExampleBoston
eventState
string

US, CA, or MX State/Province Abbreviation. Include the country code to distinguish between same-named states/provinces in different countries.

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

  • inboundEdi214:
    • Load (object) -> Last Reported State/Province (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin State (field)
    • Vendor Invoice (object) -> Destination State (field)
    • Vendor Invoice (object) -> Ultimate Shipper State (field)
    • Vendor Invoice (object) -> Ultimate Consignee State (field)
    • Vendor Invoice (object) -> Carrier Bill To State (field)
Valid values[ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WI", "WV", "WY", "AG", "BS", "CM", "CH", "CS", "CL", "DF", "DG", "GT", "GR", "HG", "JA", "NA", "OA", "PB", "QE", "QR", "SL", "SI", "SO", "TB", "TM", "TL", "VE", "YU", "ZA", "AB", "BC", "MB", "NB", "NL", "NS", "NT", "NU", "ON", "PE", "QC", "SK", "YT" ]
ExampleIL
eventZip
string

The postal code where the event occurred.

Example60603
eventCountry
string

Country Code ISO 3166-1 alpha-2 (two-letters)

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

  • inboundEdi214:
    • Load (object) -> Last Reported Country (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin Country (field)
    • Vendor Invoice (object) -> Destination Country (field)
    • Vendor Invoice (object) -> Ultimate Shipper Country (field)
    • Vendor Invoice (object) -> Ultimate Consignee Country (field)
    • Vendor Invoice (object) -> Carrier Bill To Country (field)
Valid values[ "US", "CA", "MX" ]
ExampleUS
latitude
number

The latitude coordinate where the event occurred.

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

Example47.5292773045995
longitude
number

The longitude coordinate where the event occurred.

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

Example-87.20153829304499
containerNumber
string

The container number associated with this shipment status.

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

Max length80
ExampleMAEU1234567
proNumber
string

The PRO Number associated with this shipment status.

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

Max length40
ExamplePRO1234567
waybillNumber
string

The Waybill Number associated with this shipment status.

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

Max length40
Example45678910
bookingNumber
string

The Booking Number associated with this shipment status.

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

Max length30
Example1234672137
sealNumber
string

The Seal Number associated with this shipment status.

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

Max length15
Example2372499345
inboundEdi210
object (inboundEdi210)
carrierTradingPartnerId
string Required

The EDI Trading Partner ID of the Carrier sending the invoice.

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

Max length80
ExampleEDIC1
shipmentId
string Required

The unique identifier for the shipment this invoice is associated with.

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

Max length80
ExampleLoad-5243
proNumber
string

The PRO Number associated with this invoice.

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

Max length40
ExamplePRO1234567
waybillNumber
string

The Waybill Number associated with this invoice.

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

Max length40
ExampleWAY1234567
invoiceNum
string

The unique invoice number assigned by the Carrier.

Maps the following in Revenova TMS:

  • Vendor Invoice (object) -> Name (field)
  • Vendor Invoice (object) -> Payee Reference (field)
Max length80
ExampleINV-123456789
currencyCode
string

The ISO currency code for the invoice amounts, only relevant for multicurrency orgs

Maps the following in Revenova TMS:

  • Vendor Invoice (object) -> Currency ISO Code (field)
  • Vendor Invoice Accessorial (object) -> Currency ISO Code (field)
Max length3
ExampleUSD
invoiceDate
string (date) Required

The date the invoice was created.

Format must be YYYY-MM-DD.

Maps to Vendor Invoice (object) -> Invoice Date (field) in Revenova TMS.

Example2025-09-22
invoiceDueDate
string (date)

The date the invoice payment is due.

Format must be YYYY-MM-DD.

Maps to Vendor Invoice (object) -> Invoice Due Date (field) in Revenova TMS.

Example2025-10-07
originName
string

The name of the origin location for the shipment.

Maps to Vendor Invoice (object) -> Origin Name (field) in Revenova TMS.

Max length80
ExampleRevenova HQ
originStreet
string

The street address of the origin location for the shipment.

Maps to Vendor Invoice (object) -> Origin Street (field) in Revenova TMS.

Max length255
Example2333 Waukegan Rd.
originCity
string

The city of the origin location for the shipment.

Maps to Vendor Invoice (object) -> Origin City (field) in Revenova TMS.

Max length40
ExampleBannockburn
originState
string

US, CA, or MX State/Province Abbreviation. Include the country code to distinguish between same-named states/provinces in different countries.

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

  • inboundEdi214:
    • Load (object) -> Last Reported State/Province (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin State (field)
    • Vendor Invoice (object) -> Destination State (field)
    • Vendor Invoice (object) -> Ultimate Shipper State (field)
    • Vendor Invoice (object) -> Ultimate Consignee State (field)
    • Vendor Invoice (object) -> Carrier Bill To State (field)
Valid values[ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WI", "WV", "WY", "AG", "BS", "CM", "CH", "CS", "CL", "DF", "DG", "GT", "GR", "HG", "JA", "NA", "OA", "PB", "QE", "QR", "SL", "SI", "SO", "TB", "TM", "TL", "VE", "YU", "ZA", "AB", "BC", "MB", "NB", "NL", "NS", "NT", "NU", "ON", "PE", "QC", "SK", "YT" ]
ExampleIL
originPostalCode
string

The postal code of the origin location for the shipment.

Maps to Vendor Invoice (object) -> Origin Postal Code (field) in Revenova TMS.

Max length20
Example60015
originCountry
string

Country Code ISO 3166-1 alpha-2 (two-letters)

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

  • inboundEdi214:
    • Load (object) -> Last Reported Country (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin Country (field)
    • Vendor Invoice (object) -> Destination Country (field)
    • Vendor Invoice (object) -> Ultimate Shipper Country (field)
    • Vendor Invoice (object) -> Ultimate Consignee Country (field)
    • Vendor Invoice (object) -> Carrier Bill To Country (field)
Valid values[ "US", "CA", "MX" ]
ExampleUS
destinationName
string

The name of the destination location for the shipment.

Maps to Vendor Invoice (object) -> Destination Name (field) in Revenova TMS.

Max length80
ExampleBoston Beans
destinationStreet
string

The street address of the destination location for the shipment.

Maps to Vendor Invoice (object) -> Destination Street (field) in Revenova TMS.

Max length255
Example526 Beacon Street
destinationCity
string

The city of the destination location for the shipment.

Maps to Vendor Invoice (object) -> Destination City (field) in Revenova TMS.

Max length40
ExampleBoston
destinationState
string

US, CA, or MX State/Province Abbreviation. Include the country code to distinguish between same-named states/provinces in different countries.

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

  • inboundEdi214:
    • Load (object) -> Last Reported State/Province (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin State (field)
    • Vendor Invoice (object) -> Destination State (field)
    • Vendor Invoice (object) -> Ultimate Shipper State (field)
    • Vendor Invoice (object) -> Ultimate Consignee State (field)
    • Vendor Invoice (object) -> Carrier Bill To State (field)
Valid values[ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WI", "WV", "WY", "AG", "BS", "CM", "CH", "CS", "CL", "DF", "DG", "GT", "GR", "HG", "JA", "NA", "OA", "PB", "QE", "QR", "SL", "SI", "SO", "TB", "TM", "TL", "VE", "YU", "ZA", "AB", "BC", "MB", "NB", "NL", "NS", "NT", "NU", "ON", "PE", "QC", "SK", "YT" ]
ExampleIL
destinationPostalCode
string

The postal code of the destination location for the shipment.

Maps to Vendor Invoice (object) -> Destination Postal Code (field) in Revenova TMS.

Max length20
Example02215
destinationCountry
string

Country Code ISO 3166-1 alpha-2 (two-letters)

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

  • inboundEdi214:
    • Load (object) -> Last Reported Country (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin Country (field)
    • Vendor Invoice (object) -> Destination Country (field)
    • Vendor Invoice (object) -> Ultimate Shipper Country (field)
    • Vendor Invoice (object) -> Ultimate Consignee Country (field)
    • Vendor Invoice (object) -> Carrier Bill To Country (field)
Valid values[ "US", "CA", "MX" ]
ExampleUS
ultimateShipperName
string

The name of the ultimate shipper for the shipment.

Maps to Vendor Invoice (object) -> Ultimate Shipper Name (field) in Revenova TMS.

Max length80
ExampleRevenova HQ
ultimateShipperStreet
string

The street address of the ultimate shipper for the shipment.

Maps to Vendor Invoice (object) -> Ultimate Shipper Street (field) in Revenova TMS.

Max length255
Example2555 Waukegan Rd.
ultimateShipperCity
string

The city of the ultimate shipper for the shipment.

Maps to Vendor Invoice (object) -> Ultimate Shipper City (field) in Revenova TMS.

Max length40
ExampleBannockburn
ultimateShipperState
string

US, CA, or MX State/Province Abbreviation. Include the country code to distinguish between same-named states/provinces in different countries.

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

  • inboundEdi214:
    • Load (object) -> Last Reported State/Province (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin State (field)
    • Vendor Invoice (object) -> Destination State (field)
    • Vendor Invoice (object) -> Ultimate Shipper State (field)
    • Vendor Invoice (object) -> Ultimate Consignee State (field)
    • Vendor Invoice (object) -> Carrier Bill To State (field)
Valid values[ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WI", "WV", "WY", "AG", "BS", "CM", "CH", "CS", "CL", "DF", "DG", "GT", "GR", "HG", "JA", "NA", "OA", "PB", "QE", "QR", "SL", "SI", "SO", "TB", "TM", "TL", "VE", "YU", "ZA", "AB", "BC", "MB", "NB", "NL", "NS", "NT", "NU", "ON", "PE", "QC", "SK", "YT" ]
ExampleIL
ultimateShipperPostalCode
string

The postal code of the ultimate shipper for the shipment.

Maps to Vendor Invoice (object) -> Ultimate Shipper Postal Code (field) in Revenova TMS.

Max length20
Example60015
ultimateShipperCountry
string

Country Code ISO 3166-1 alpha-2 (two-letters)

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

  • inboundEdi214:
    • Load (object) -> Last Reported Country (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin Country (field)
    • Vendor Invoice (object) -> Destination Country (field)
    • Vendor Invoice (object) -> Ultimate Shipper Country (field)
    • Vendor Invoice (object) -> Ultimate Consignee Country (field)
    • Vendor Invoice (object) -> Carrier Bill To Country (field)
Valid values[ "US", "CA", "MX" ]
ExampleUS
ultimateConsigneeName
string

The name of the ultimate consignee for the shipment.

Maps to Vendor Invoice (object) -> Ultimate Consignee Name (field) in Revenova TMS.

Max length80
ExampleBoston Beans
ultimateConsigneeStreet
string

The street address of the ultimate consignee for the shipment.

Maps to Vendor Invoice (object) -> Ultimate Consignee Street (field) in Revenova TMS.

Max length255
Example526 Beacon Street
ultimateConsigneeCity
string

The city of the ultimate consignee for the shipment.

Maps to Vendor Invoice (object) -> Ultimate Consignee City (field) in Revenova TMS.

Max length40
ExampleBoston
ultimateConsigneeState
string

US, CA, or MX State/Province Abbreviation. Include the country code to distinguish between same-named states/provinces in different countries.

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

  • inboundEdi214:
    • Load (object) -> Last Reported State/Province (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin State (field)
    • Vendor Invoice (object) -> Destination State (field)
    • Vendor Invoice (object) -> Ultimate Shipper State (field)
    • Vendor Invoice (object) -> Ultimate Consignee State (field)
    • Vendor Invoice (object) -> Carrier Bill To State (field)
Valid values[ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WI", "WV", "WY", "AG", "BS", "CM", "CH", "CS", "CL", "DF", "DG", "GT", "GR", "HG", "JA", "NA", "OA", "PB", "QE", "QR", "SL", "SI", "SO", "TB", "TM", "TL", "VE", "YU", "ZA", "AB", "BC", "MB", "NB", "NL", "NS", "NT", "NU", "ON", "PE", "QC", "SK", "YT" ]
ExampleIL
ultimateConsigneePostalCode
string

The postal code of the ultimate consignee for the shipment.

Maps to Vendor Invoice (object) -> Ultimate Consignee Postal Code (field) in Revenova TMS.

Max length20
Example02219
ultimateConsigneeCountry
string

Country Code ISO 3166-1 alpha-2 (two-letters)

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

  • inboundEdi214:
    • Load (object) -> Last Reported Country (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin Country (field)
    • Vendor Invoice (object) -> Destination Country (field)
    • Vendor Invoice (object) -> Ultimate Shipper Country (field)
    • Vendor Invoice (object) -> Ultimate Consignee Country (field)
    • Vendor Invoice (object) -> Carrier Bill To Country (field)
Valid values[ "US", "CA", "MX" ]
ExampleUS
carrierBillToName
string

The name of the carrier bill-to party for the invoice.

Maps to Vendor Invoice (object) -> Carrier Bill To Name (field) in Revenova TMS.

Max length80
ExampleEmail Carrier One
carrierBillToStreet
string

The street address of the carrier bill-to party for the invoice.

Maps to Vendor Invoice (object) -> Carrier Bill To Street (field) in Revenova TMS.

Max length255
Example1526 Beacon Street
carrierBillToCity
string

The city of the carrier bill-to party for the invoice.

Maps to Vendor Invoice (object) -> Carrier Bill To City (field) in Revenova TMS.

Max length40
ExampleBoston
carrierBillToState
string

US, CA, or MX State/Province Abbreviation. Include the country code to distinguish between same-named states/provinces in different countries.

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

  • inboundEdi214:
    • Load (object) -> Last Reported State/Province (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin State (field)
    • Vendor Invoice (object) -> Destination State (field)
    • Vendor Invoice (object) -> Ultimate Shipper State (field)
    • Vendor Invoice (object) -> Ultimate Consignee State (field)
    • Vendor Invoice (object) -> Carrier Bill To State (field)
Valid values[ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WI", "WV", "WY", "AG", "BS", "CM", "CH", "CS", "CL", "DF", "DG", "GT", "GR", "HG", "JA", "NA", "OA", "PB", "QE", "QR", "SL", "SI", "SO", "TB", "TM", "TL", "VE", "YU", "ZA", "AB", "BC", "MB", "NB", "NL", "NS", "NT", "NU", "ON", "PE", "QC", "SK", "YT" ]
ExampleIL
carrierBillToPostalCode
string

The postal code of the carrier bill-to party for the invoice.

Maps to Vendor Invoice (object) -> Carrier Bill To Postal Code (field) in Revenova TMS.

Max length20
Example02219
carrierBillToCountry
string

Country Code ISO 3166-1 alpha-2 (two-letters)

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

  • inboundEdi214:
    • Load (object) -> Last Reported Country (field)
  • inboundEdi210:
    • Vendor Invoice (object) -> Origin Country (field)
    • Vendor Invoice (object) -> Destination Country (field)
    • Vendor Invoice (object) -> Ultimate Shipper Country (field)
    • Vendor Invoice (object) -> Ultimate Consignee Country (field)
    • Vendor Invoice (object) -> Carrier Bill To Country (field)
Valid values[ "US", "CA", "MX" ]
ExampleUS
charges
Array of object

The list of charges associated with this invoice.

Requires 1-to-many charges.

Example[ { "amount": 1200.0, "description": "Net Line Haul", "qty": 1200.0, "rate": 1.0, "rateType": "Per Mile", "type": "Line Haul" }, { "amount": 300.0, "description": "Fuel Surcharge", "qty": 1200.0, "rate": 0.25, "rateType": "Per Mile", "type": "Fuel" }, { "amount": 75.0, "description": "After Hours Delivery", "qty": 1.0, "rate": 75.0, "rateType": "Fixed Cost", "stopNum": 2.0, "type": "Accessorial" } ]
object

A line item charge on the invoice.

type
string Required

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

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

A description of the accessorial name, if applicable.

Max length80
ExampleLift Gate Delivery
qty
number

The quantity associated with the charge.

Format can have up to 2 decimal places and 16 total digits (including the decimal places).

Maps to Vendor Invoice Accessorial (object) -> Quantity (field) in Revenova TMS.

Example1200.0
rateType
string

The type of rate applied to the charge (e.g., Fixed Cost, Per Mile).

Maps to Vendor Invoice Accessorial (object) -> Unit (field) in Revenova TMS.

Valid values[ "Fixed Cost", "Per Mile", "Per Kilometer", "Percent of Freight" ]
rate
number

The rate applied to the charge.

Format can have up to 2 decimal places and 10 total digits (including the decimal places).

Maps to Vendor Invoice Accessorial (object) -> Unit Price (field) in Revenova TMS.

Example1.0
amount
number Required

The total amount for the charge.

Format can have up to 2 decimal places and 16 total digits (including the decimal places).

Maps to one of the following in Revenova TMS based on the charge type:

  • Line Haul: Vendor Invoice (object) -> Freight Charges (field)
  • Fuel: Vendor Invoice (object) -> Fuel Surcharge (field)
  • Accessorial: Vendor Invoice Accessorial (object) -> Charge (field)
Example1200.0
stopNum
number

The stop number associated with the charge, if applicable.

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

Example2.0
items
Array of object

The list of items associated with this invoice.

Requires 1-to-many items.

Example[ { "amount": 100.0, "description": "Commodity AAA", "freightClass": "50", "quantity": 10.0, "rate": 0.25, "rateType": "Per Mile", "weight": 100.0, "weightUnits": "lbs" } ]
object

A line item on the invoice.

description
string

A description of the item.

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

Max length255
ExampleCommodity AAA
freightClass
string

The freight class of the item.

Maps to Vendor Invoice Freight Charge Item (object) -> NMFC Class (field) in Revenova TMS.

Valid values[ "50", "55", "60", "65", "70", "77.5", "85", "92.5", "100", "110", "125", "150", "175", "200", "250", "300", "400", "500" ]
quantity
number

The quantity of the item.

Format can have up to 2 decimal places and 16 total digits (including the decimal places).

Maps to Vendor Invoice Freight Charge Item (object) -> Quantity (field) in Revenova TMS.

Example10.0
rate
number

The rate for the item.

Format can have up to 2 decimal places and 10 total digits (including the decimal places).

Maps to Vendor Invoice Freight Charge Item (object) -> Rate (field) in Revenova TMS.

Example0.25
rateType
string

The type of rate applied to the item (e.g., Per Mile, Per Pound).

Maps to Vendor Invoice Freight Charge Item (object) -> Unit (field) in Revenova TMS.

Valid values[ "Fixed Cost", "Percent of Amount", "Per Cubic Foot", "Per Cubic Meter", "Per Cwt", "Per Day", "Per Equipment Type", "Per Gallon", "Per Handling Unit", "Per Hour", "Per 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" ]
amount
number

The total amount for the item.

Format can have up to 2 decimal places and 16 total digits (including the decimal places).

Maps to Vendor Invoice Freight Charge Item (object) -> Freight Charge (field) in Revenova TMS.

Example100.0
weight
number (integer)

The weight of the item.

Format can have up 18 total digits.

Maps to Vendor Invoice Freight Charge Item (object) -> Weight (field) in Revenova TMS.

Example100.0
weightUnits
string

The weight units for the item (e.g., lbs, kg).

Maps to Vendor Invoice Freight Charge Item (object) -> Weight Units (field) in Revenova TMS.

Examplelbs
Responses
200

Valid authentication, Empty list provided in POST body

string
ExampleNo EDI Events to publish
201

Valid authentication, All events passed model validation. EDI Events successfully queue.

string
ExampleEDI events queued
400

EDI Event(s) fail validation

ediCodeMissing

Missing or null EDI Code

"Bad request: EDI Event at index : EDICode is missing"
ediCodeNotNumber

EDI Code is not an integer

"Bad request: EDI Event at index : EDICode must be an integer. Actual: "
ediCodeUnsupported

EDI Code is not supported (204, 404, 998, 990, 824, 214, 322, 210, 410)

"Bad request: EDI Event at index : Unsupported EDI Code: "
payloadRequired

Missing or null payload

"Bad request: EDI Event at index : Payload required"
payloadTooLarge

Payload is too large

"Bad request: EDI Event at index : Payload longer than 130000 chars ( chars)"
badPayload

Payload does not match expected request model

"Bad request: Could not deserialize request"
string
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. Provided by Salesforce.

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
string
ExampleForbidden: Invalid EDI Context User
413

More than 200 events in the json payload, EDI van needs to batch these calls, and call the POST endpoint more than once

string
ExampleContent too large: <N> events is more than the supported 200 events per call
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