Skip to main content

Freightview Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Freightview location.
freightview_api.png

Freightview

Create a Freightview Destination​

  1. Click the + icon on the Nexset that will be sent to the Freightview destination, and select the Send to Destination option from the menu.

  2. Select the Freightview connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Freightview organization, and click Next; or, create a new Freightview credential for use in this flow.

  3. Freightview destinations can be manually configured to send data to any valid Freightview API endpoint. This enables workflows such as programmatically booking LTL shipments, requesting rate quotes, or creating new shipment records directly from your Nexla data flows.

    First, select the API method that will be used for calls to the Freightview API from the Method pulldown menu. Common methods for Freightview destination use cases include:

    • POST: For creating new shipment records, booking shipments, or submitting rate requests
    • PUT: For updating existing shipment records
    • PATCH: For partial updates to existing shipment data

Data Format​

  1. Select the format in which the Nexset data will be sent to the Freightview API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Freightview API accepts and returns data in JSON format, so selecting JSON is recommended for most use cases.

API Endpoint URL​

  1. Enter the URL of the Freightview API endpoint to which you want to send the Nexset data in the URL field. The Freightview API base URL is https://www.freightview.com/api/v1.0/. Common endpoint paths for destination use cases include:
    • https://www.freightview.com/api/v1.0/shipments — for creating new shipment records or booking freight
    • https://www.freightview.com/api/v1.0/rates — for submitting rate requests

For update or upsert operations targeting a specific shipment record, include the shipment ID at the end of the URL. For example: https://www.freightview.com/api/v1.0/shipments/{shipment_id}. For the complete list of available endpoints and required request body parameters, see the Freightview API Reference.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. The Freightview API's Authorization header (HTTP Basic Auth) is handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Freightview destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Property Inside JSON Object

  1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
  2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

Code

  1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the Freightview API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call, such as the shipment ID assigned to a newly booked LTL shipment or the bill of lading number generated by Freightview.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Freightview API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing​

After all endpoint settings have been configured, Nexla can send a test payload to the Freightview API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Freightview API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured Freightview endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to Freightview until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.