Truckload

Create shipment

This endpoint can be used to create a truckload shipment.

  • A successfully created shipment returns a shipmentId with a status of pending, and echoes the shipment data passed in.
  • It also includes any additional default data from Freightview (e.g. a location's latitude, longitude, & timezone, and the default account bill-to information if none was specified in the create request).
post/v2.0/shipments/truckload

Request

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

Request body

bolNumberstring

The Bill of Lading number for the shipment. Auto-generated by Freightview upon awarding unless value provided by shipper.

isLiveLoadboolean required

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".
shareShipmentEmailsstring[]

An array of email addresses with which to share the shipment. This will allow the email recipient to view the shipment bill of lading and tracking status.

glCodestring

The GL (General Ledger) code to assign to the shipment for accounting purposes. The GL code must already exist in your account's GL codes list.

Example request

{
  "locations": [
    {
      "postalCode": "10111",
      "country": "us",
      "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"
        }
      ]
    }
  ],
  "glCode": "4000-100"
}

Response

Created

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.