Public API Documentation
      Back to home
      1. Knowledge Base
      2. Public API Documentation

      External Load Board

      The goal of this feature is to allow outside External Vendors to post/repost/delete onto Load Boards.

      Setup:

      The setup beings with a new Integration Source - External Load Board. This can be created within the LSP (Integration Sources) Drop Down or the Rates (Integration Sources) Drop Down. 

      Integration Source:

      • Source Information:
        • Source Name: This name will be displayed within Truckload Quoting Page as the Name of the Loadboard Integration
          • Integration Source Example:
          • Truckload Quoting Page Example:
        • Username: This can be used to store any API Username if necessary
        • Password: This can be used to store any API Password if necessary
        • License Key: This can be used to store any potential Tokens if necessary
        • Account Number: This can be used to store any Account Numbers if necessary
      • Source Settings:
        • (Required) CreateEndpoint
          • Triggered by Posting to the Integration Source
          • This will send a POST request to the endpoint
            • Example:
            • {
                "externalLoadBoardAction": "Post",
                "loadBoardInformation": {
                  "userName": "TestUserName",
                  "password": "TestPassword",
                  "licenseKey": "TestLicenseKey",
                  "account": "TestAccoutnNumber",
                  "loadBoardSourceId": "39831",
                  "loadBoardSettings": [
                    {
                      "name": "UseBearerToken",
                      "value": "true"
                    },
                    {
                      "name": "AdditionalSetting",
                      "value": "Trucking"
                    },
                    {
                      "name": "SettingTwo",
                      "value": "Post"
                    }
                  ]
                },
                "shipment": {
                  "shipmentId": 122012808,
                  "offerRate": "10",
                  "stackable": false,
                  "shipmentType": "Truckload",
                  "trailerType": "Refrigerated",
                  "trailerSize": "Full",
                  "weightUnits": "lbs",
                  "dimensionUnits": "in",
                  "serviceLevel": "Normal",
                  "shipmentReferenceNumbers": [
                    {
                      "referenceType": "Shipment ID",
                      "value": "122012808"
                    }
                  ],
                  "stops": [
                    {
                      "shipmentStopId": 0,
                      "companyName": "Pickup Company Name",
                      "streetAddress": "123 Main St",
                      "streetAddressTwo": "Suite 123",
                      "city": "Huntington Beach",
                      "state": "CA",
                      "zipCode": "92648",
                      "country": "US",
                      "contactName": "",
                      "phone": "5555555555",
                      "email": "",
                      "estimatedReadyDateTime": "2025-03-07T00:00:00",
                      "estimatedCloseDateTime": "2025-03-07T00:00:00",
                      "stopType": "First Pickup",
                      "shipmentStopReferenceNumbers": []
                    },
                    {
                      "shipmentStopId": 0,
                      "companyName": "Delivery Company Name",
                      "streetAddress": "321 Main St",
                      "streetAddressTwo": "Suite 321",
                      "city": "Alcoa",
                      "state": "TN",
                      "zipCode": "37701",
                      "country": "US",
                      "contactName": "",
                      "phone": "5555555555",
                      "email": "",
                      "estimatedReadyDateTime": "2025-02-24T00:00:00",
                      "estimatedCloseDateTime": "2025-02-24T00:00:00",
                      "stopType": "Last Drop",
                      "shipmentStopReferenceNumbers": []
                    }
                  ],
                  "commodities": [
                    {
                      "handlingQuantity": 1,
                      "packagingType": "Pallet",
                      "length": 48,
                      "width": 40,
                      "height": 48,
                      "weightTotal": 20000,
                      "hazardousMaterial": false,
                      "piecesTotal": 0,
                      "freightClass": "No Class",
                      "description": "Food",
                      "hazardClasses": [],
                      "shipmentCommodityReferenceNumbers": []
                    }
                  ],
                  "accessorialCodes": [],
                  "shipmentAlerts": [
                    {
                      "type": "Tai Email Assistant",
                      "createdDate": "2025-02-11T15:55:44.7166667",
                      "resolved": false
                    }
                  ]
                }
              }
               
        • (Required) RepostEndpoint
          • This will send a PUT Request to the endpoint
            • The trigger for this is based on the Repost Frequency set on the Truckload Quoting Page 
            • Example
            • {
                "loadPostNumber": "12345",
                "externalLoadBoardAction": "Post",
                "loadBoardInformation": {
                  "userName": "TestUserName",
                  "password": "TestPassword",
                  "licenseKey": "TestLicenseKey",
                  "account": "TestAccoutnNumber",
                  "loadBoardSourceId": "39831",
                  "loadBoardSettings": [
                    {
                      "name": "UseBearerToken",
                      "value": "true"
                    },
                    {
                      "name": "AdditionalSetting",
                      "value": "Trucking"
                    },
                    {
                      "name": "SettingTwo",
                      "value": "Post"
                    }
                  ]
                },
                "shipment": {
                  "shipmentId": 122012808,
                  "offerRate": "10",
                  "stackable": false,
                  "shipmentType": "Truckload",
                  "trailerType": "Refrigerated",
                  "trailerSize": "Full",
                  "weightUnits": "lbs",
                  "dimensionUnits": "in",
                  "serviceLevel": "Normal",
                  "shipmentReferenceNumbers": [
                    {
                      "referenceType": "Shipment ID",
                      "value": "122012808"
                    }
                  ],
                  "stops": [
                    {
                      "shipmentStopId": 0,
                      "companyName": "Pickup Company Name",
                      "streetAddress": "123 Main St",
                      "streetAddressTwo": "Suite 123",
                      "city": "Huntington Beach",
                      "state": "CA",
                      "zipCode": "92648",
                      "country": "US",
                      "contactName": "",
                      "phone": "5555555555",
                      "email": "",
                      "estimatedReadyDateTime": "2025-03-07T00:00:00",
                      "estimatedCloseDateTime": "2025-03-07T00:00:00",
                      "stopType": "First Pickup",
                      "shipmentStopReferenceNumbers": []
                    },
                    {
                      "shipmentStopId": 0,
                      "companyName": "Delivery Company Name",
                      "streetAddress": "321 Main St",
                      "streetAddressTwo": "Suite 321",
                      "city": "Alcoa",
                      "state": "TN",
                      "zipCode": "37701",
                      "country": "US",
                      "contactName": "",
                      "phone": "5555555555",
                      "email": "",
                      "estimatedReadyDateTime": "2025-02-24T00:00:00",
                      "estimatedCloseDateTime": "2025-02-24T00:00:00",
                      "stopType": "Last Drop",
                      "shipmentStopReferenceNumbers": []
                    }
                  ],
                  "commodities": [
                    {
                      "handlingQuantity": 1,
                      "packagingType": "Pallet",
                      "length": 48,
                      "width": 40,
                      "height": 48,
                      "weightTotal": 20000,
                      "hazardousMaterial": false,
                      "piecesTotal": 0,
                      "freightClass": "No Class",
                      "description": "Food",
                      "hazardClasses": [],
                      "shipmentCommodityReferenceNumbers": []
                    }
                  ],
                  "accessorialCodes": [],
                  "shipmentAlerts": [
                    {
                      "type": "Tai Email Assistant",
                      "createdDate": "2025-02-11T15:55:44.7166667",
                      "resolved": false
                    }
                  ]
                }
              }

               

        • (Required) DeleteEndpoint
          • This will send a DELETE Request to the endpoint
            • Triggers:
              • Delete Post
              • Carrier Assigned to Load 
            • Example
            • {
                "loadPostNumber": "12345",
                "shipmentId": "122012808",
                "externalLoadBoardAction": "Delete",
                "loadBoardInformation": {
                  "userName": "TestUserName",
                  "password": "TestPassword",
                  "licenseKey": "TestLicenseKey",
                  "account": "TestAccoutnNumber",
                  "loadBoardSourceId": "39831",
                  "loadBoardSettings": [
                    {
                      "name": "UseBearerToken",
                      "value": "true"
                    },
                    {
                      "name": "AdditionalSetting",
                      "value": "Trucking"
                    },
                    {
                      "name": "SettingTwo",
                      "value": "Post"
                    }
                  ]
                }
              }
        • (Optional) UseBearerToken
          • Binary (True or False)
          • This will allow the License Key to be passed as an Authorization Bearer Token
            • Example: Authorization: Bearer {LicenseKey}
        • (Optional) AuthParameter
          • If additional Authorization Parameters are required, you can enter any number of AuthParameter_{Name} in the Source Setting. 
          • This will add the Header with {Name} and the value will be based on the Value specified in the Source Setting
          • Example:
        • loadBoardSettings
          • Any values added under Source Parameters will be displayed as loadBoardSettings.
            • This does not include the following
              • PostEndpoint
              • RepostEndpoint
              • DeleteEndpoint
              • AuthParameter

      Ideal Workflow:

      1. POST Endpoint is triggered
        1. A loadboard posting will occur on a loadboard platform
          1. Cache the Integration Source ID and Shipment ID
        2. The reference number returned needs to be passed back to Tai
      2. Use Tai Public API Endpoint
        1. PUT /PublicApi/Loadboard/v2/UpdateFromLoadboard
          1. This will allow the reference number associated with the Posting to be stored in Tai
          2. This reference number will appear in future Repost / Delete triggers
      3. REPOST Endpoint is triggered
        1. This will trigger based on teh frequency set on the Truckload Quoting Page
        2. This will allow the integration to know which Loadboard Posting may be required to Post towards the top
          1. Remove the Loadboard on the External Load Board
      4. Use Tai Public API Endpoint
        1. PUT /PublicApi/Loadboard/v2/UpdateFromLoadboard
          1. Reference the fresh reference number 
      5. DELETE Endpoint is triggered
        1. This will trigger in two cases
          1. when the REPOST expires
          2. when the load has been covered
        2. This will allow you to remove the Posting from the Loadboard if no longer needed