Parcel

Book shipment

This endpoint can be used to book a parcel shipment with a carrier.

<div class="blockquote alert-important"> <div class="alert-important-title">Important</div> In order for a shipment to be booked successfully, the following fields are required when <a href="#tag/Parcel/operation/parcelCreateShipment">creating</a> the parcel shipment. </div>

Required fields on a shipment for it to be booked

  • pickupDate
  • origin
    • company
    • address
    • city
    • state
    • postalCode
    • country
    • contactName
    • contactPhone
    • opensAt
    • closesAt
  • destination
    • company
    • address
    • city
    • state
    • postalCode
    • country
    • contactName
  • items
    • type
    • weight
    • description
post/v2.0/shipments/parcel/{shipmentId}/book

Request

  • Base URL: https://api.freightview.dev
  • URL: https://api.freightview.dev/v2.0/shipments/parcel/{shipmentId}/book
  • 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 that is being used to book the shipment.

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.

<div class="blockquote alert-note"> <div class="alert-note-title">Note</div> Specifying email addresses in this array will append to (not replace) any email addresses already specified in the <code>shareShipmentEmails</code> array in the "Create shipment" request. </div>

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.