Truckload

Book shipment (freight collect)

This endpoint can be used to create and book a truckload shipment that is billing the recipient or a third party.

  • Omit shipmentId to create and book a new freight collect shipment. Returns HTTP 201.
  • Include shipmentId to rebook an existing freight collect shipment with a new carrier. The same required fields as a new booking must be provided. Returns HTTP 200.
  • A successfully booked shipment returns a shipmentId with a status of awarded.
  • The carrierId must belong to a spot quote contact carrier on your account.
post/v2.0/shipments/truckload/freight-collect

Request

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

Request body

carrierIdstring required

The unique identifier for the carrier to book the shipment with. The carrier must be configured as a spot quote contact on your account. Use the get account carriers endpoint to retrieve valid carrierId values.

shipmentIdstring

The unique identifier for an existing freight collect shipment to rebook with a new carrier. When omitted, a new freight collect shipment is created and booked. When provided, all other required fields must still be supplied in the request body.

createBOLboolean

A flag to indicate whether a Bill of Lading should be created for the shipment.

schedulePickupboolean

A flag to indicate whether the shipment should be scheduled with the carrier for pickup.

bolNumberstring

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

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.

Example request

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

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.