LTL

Edit shipment

This endpoint can be used to edit an LTL shipment.

  • The required fields in each object differ based on whether a shipment has been booked or not.
  • A successfully edited shipment echoes the shipment data passed in, as well as any additional default data from Freightview.
  • If there are notices that result from the editing of a booked shipment, those will be populated in the notices array in the response.

LTL unbooked shipment

If the LTL shipment is unbooked (i.e. it's status is pending), then you can specify returnQuotes as true, so that the response will include an updated quotes array, based on the changes made to the shipment. Editing the following field types will result in the shipment being re-rated with your LTL carrier rates:

  • Pickup date
  • Item information (weight, type, dimensions, etc)
  • Accessorial information
  • Location ship type (business dock, limited access, etc)
  • Origin/destination postal code

LTL booked shipment

  • Once a shipment has been booked with an LTL carrier (and thus it's status is not pending or canceled), editing its details in Freightview will result in an updated BOL, but will not currently update the information already sent to the carrier in the pickup request or carrier BOL / PRO record.
  • If any of the above-mentioned rate-affecting fields were edited, Freightview will attempt to re-rate the shipment using the same carrier & service type and will reflect the newly updated rate in the selectedQuote object in the response.
  • If the re-rating of the shipment was unsuccessful, then there will be a corresponding notice in the notices array in the response.
put/v2.0/shipments/ltl/{shipmentId}

Request

  • Base URL: https://api.freightview.dev
  • URL: https://api.freightview.dev/v2.0/shipments/ltl/{shipmentId}
  • Auth: OAuth 2 (client credentials, token URL /v2.0/auth/token)

Path parameters

shipmentIdstring required

The unique identifier in Freightview for the shipment.

Query parameters

returnQuotesboolean
Example:true

A boolean value to indicate whether Freightview should include rates in the response.

  • false - Freightview will create the shipment but available rates will not be returned.
  • true - Freightview will create the shipment and return available rates from LTL carriers.

This parameter affects whether the quotes arrays is returned when editing an unbooked shipment.

waitDurationinteger
Example:10

An integer value to indicate the number of seconds to wait for rates before returning the shipment.

Request body

OR

Example request

{
  "origin": {
    "shipType": "business dock"
  },
  "destination": {
    "shipType": "business dock"
  },
  "glCode": "4000-100"
}

Response

Success

shipmentIdstring

The unique identifier in Freightview for this shipment.

bookedDatestring date-time

Date / time when shipment was awarded to carrier.

createdDatestring date-time

Date / time when shipment was created.

pickupDatestring date

The requested date for pickup of the shipment.

status'pending' | 'awarded' | 'confirmed' | 'picked-up' | 'delivered' | 'canceled'
  • pending - Shipment has been created.
  • awarded - Shipment has been awarded to a carrier.
  • confirmed - Shipment has been confirmed by carrier.
  • picked-up - Shipment has been picked up.
  • delivered - Shipment has been delivered.
  • canceled - Shipment has been canceled by the shipper.
isLiveLoadboolean

A flag to indicate whether the shipper considers the shipment a "live load".

  • true - This is a "live load" that will be shipped.
  • false - This shipment is "quote only".
isArchivedboolean

A flag to indicate whether the shipment has been archived in Freightview.

direction'inbound' | 'outbound' | 'third-party'

The direction of the the shipment (based on the locations setup for the account).

quotedBystring

The name of the user who quoted the shipment.

bookedBystring

The name of the user who booked the shipment.

noticesstring[]

Notices from Freightview regarding the shipment.

glCodestring

The GL (General Ledger) code assigned to the shipment for accounting purposes.

shipmentDetailsUrlstring

A direct link to access the details for this shipment within Freightview.

shipmentQuotePageUrlstring

A direct link to access all of the quotes for this shipment within Freightview.

Example response

{
  "locations": [
    {
      "postalCode": "10111",
      "country": "us",
      "shipType": "business dock",
      "stopDate": "2021-03-01",
      "accessorials": [
        {
          "opensAt": "15:30",
          "closesAt": "15:30"
        }
      ],
      "opensAt": "15:30",
      "closesAt": "15:30"
    }
  ],
  "billTo": {
    "postalCode": "10111",
    "country": "us",
    "contactPhone": "(555) 555-5555"
  },
  "equipment": {
    "declaredValueCurrency": "usd"
  },
  "customsBroker": {
    "country": "us",
    "phone": "(555) 555-5555",
    "postalCode": "10111"
  },
  "customsBrokers": [
    {
      "country": "us",
      "phone": "(555) 555-5555",
      "postalCode": "10111"
    }
  ],
  "emergencyContact": {
    "phone": "(555) 555-5555"
  },
  "items": [
    {
      "customsValueCurrency": "usd",
      "declaredValueCurrency": "usd",
      "type": "pallet",
      "contains": [
        {
          "customsValueCurrency": "usd",
          "declaredValueCurrency": "usd"
        }
      ]
    }
  ],
  "selectedQuote": {
    "expirationDate": "2021-03-01"
  },
  "tracking": {
    "deliveryDateEstimate": "2021-03-01",
    "items": [
      {
        "deliveryDateEstimate": "2021-03-01"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.