LTL

Book customer routed shipment

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

See here for additional information on booking customer routed shipments.

post/v2.0/shipments/ltl/book/freight-collect

Request

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

Query parameters

labelSize'2.25x4' | '3x4' | '3x5' | '3.5x5' | '4x1' | '4x2' | '4x3.3' | '4x6' | '4x8' | '5.5x8.5' | '8.5x11'

The size of labels you would like to generate for the shipment.

labelCount1 | 2 | 4

The number of labels (per shipping item e.g. pallet) you would like to have returned for the shipment. See here for more details on labels.

Request body

pickupDatestring required

The date when the shipment should be picked up. Must be ISO 8601 format. YYYY-MM-DD

bolNumberstring

The Bill of Lading number for the shipment. Auto-generated by Freightview upon booking the shipment unless a value is provided.

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.

schedulePickupboolean
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.

paymentTerms'third-party-prepaid' | 'outbound-collect' required

The payment terms applicable for the billing of the shipment.

  • outbound-collect - the destination location is the responsible party for the shipping costs.
  • third-party-prepaid - a third party is the responsible party for the shipping costs.

Example request

{
  "origin": {
    "shipType": "business dock"
  },
  "destination": {
    "shipType": "business dock"
  }
}

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.