Truckload

Award shipment to carrier

This endpoint can be used to award a truckload shipment to a carrier.

  • Add full address detail for each location.
  • Add contact information for each location.
  • Add location appointment times (if needed).
  • If creating a bill of lading, include all handling unit information in the items array.
post/v2.0/shipments/truckload/{shipmentId}/award

Request

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

Path parameters

shipmentIdstring required

The unique identifier in Freightview for the shipment.

Request body

quoteIdstring required

The unique identifier for the quote in Freightview.

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

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

Response

No Content

Changes

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