Parcel

Create & rate shipment

This endpoint can be used to create a parcel shipment.

A successfully created shipment returns a shipmentId with a status of pending, and echoes the shipment data passed in.
The shipmentId should be used as the path parameter for the book shipment endpoint.

The response also includes any additional default data from Freightview (e.g. a location's latitude, longitude, & timezone, and the bill-to information (based on the direction of the shipment if none was specified in the create request).

<div class="blockquote alert-important"> <div class="alert-important-title">Important</div> The <code>quotes</code> array in the response will only be populated if <code>returnQuotes=true</code> was specified as a query parameter. </div>

post/v2.0/shipments/parcel

Request

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

Query parameters

carriersstring

Example:fxfe,upss

A comma-separated list of carrier codes to include in the response. Carrier must be setup on your account.

fxfe - FedEx
upss - UPS
gson - GLS

returnQuotesboolean

Example:true

A boolean value to indicate whether Freightview should include rates in the response.

false - Freightview will create the shipment but available rates will not be returned.
true - Freightview will create the shipment and return available rates from parcel carriers.

waitDurationinteger

Example:10

An integer value to indicate the number of seconds to wait for rates before returning the response.

Request body

pickupDatestring date required

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

schedulePickupboolean

A flag that determines whether a pickup request is sent to the parcel carrier when the shipment is booked.

<div class="blockquote alert-tip"> <div class="alert-tip-title">Tip</div> If the origin location has a daily/recurring pickup with the carrier, set to <code>false</code>. </div>

shareShipmentEmailsstring[]

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

Example request

{
  "origin": {
    "contactPhone": "(555) 555-5555",
    "opensAt": "08:00",
    "closesAt": "17:00"
  },
  "destination": {
    "contactPhone": "(555) 555-5555"
  },
  "items": [
    {
      "description": "Widgets"
    }
  ]
}

Response

Created

shipmentIdstring

The unique identifier in Freightview for this shipment.

createdDatestring date-time

Date / time when shipment was created.

pickupDatestring date

The requested date for pickup of the shipment.

status'pending'

Shipment has been created.

The type of equipment used for the transport of the shipment.

direction'inbound' | 'outbound' | 'third-party'

The direction of the the shipment (based on the locations setup for the account).

glCodestring

The GL (General Ledger) code assigned to the shipment for accounting purposes.

quotedBystring

The name of the user who quoted the shipment.

shipmentQuotePageUrlstring

A direct link to access all of the quotes for this shipment within Freightview.

Example response

{
  "quotes": [
    {
      "expirationDate": "2021-03-01"
    }
  ],
  "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"
  },
  "customsBrokers": [
    {
      "country": "us",
      "phone": "(555) 555-5555",
      "postalCode": "10111"
    }
  ],
  "emergencyContact": {
    "phone": "(555) 555-5555"
  }
}

Changes

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