Shipments

Search shipments

This endpoint can be used to retrieve shipments from Freightview, via a search query parameter and/or various filters available as query parameters (e.g. status).

Query Parameters

All query parameters that are arrays are serialized in form style (i.e. the query parameter is repeated for each value in the array).

For example, a search for shipments that are in confirmed or delivered status, should be sent like this: https://{baseUrl}/shipments?status=confirmed&status=delivered.

get/v2.0/shipments

Request

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

Query parameters

continuationTokenstring
  • If search results exceed 20 shipments, then a continuationToken value will be returned in the response body.
  • Pass the continuationToken returned in the response body as a query parameter to retrieve the next set of results.
  • If continuationToken is not present, then no further results are available.
searchstring

Search Freightview for shipments with this value.

Examples of searches:

  • PRO number - 123456789
  • Tracking number - 1Z999999999999999
  • Shipment reference number - PO#123456
  • Bill of Lading number - 7654321
  • Location company name - ACME Corporation
  • Location city name - Chicago
  • Location postal code - 60601
auditStatus'outstanding' | 'accepted' | 'disputed' | 'archived'

Search shipments by their current audit status.

  • outstanding - Invoice balance is fully outstanding
  • accepted - Payment has been approved
  • disputed - Invoiced amount is in dispute
  • archived - Invoice has been remitted for payment

A shipment can have multiple audit statuses. For example, when partial payment for an invoice has been approved while still disputing the remaining balance.

deliveryDateStartstring date
Example:2024-10-01

Start of delivery date range (for searching shipments by delivery date range).

deliveryDateEndstring date
Example:2024-10-01

End of delivery date range (for searching shipments by delivery date range).

bookedDateStartstring date
Example:2024-10-01

Start of booked date range (for searching shipments by booked date range).

bookedDateEndstring date
Example:2024-10-01

End of booked date range (for searching shipments by booked date range).

createdDateStartstring date
Example:2024-10-01

Start of created date range (for searching shipments by created date range).

createdDateEndstring date
Example:2024-10-01

End of created date range (for searching shipments by created date range).

directionstring[]

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

equipmentTypeEquipmentType[]

The shipment equipment type key. This can be repeated to search for multiple equipment types.

Example: equipmentType=dry-van-53&equipmentType=flatbed-53

isArchivedboolean

A flag to indicate whether the shipment has been archived in Freightview.

isFreightCollectboolean

A flag to indicate whether the freight charges for the shipment are being paid by the party creating the shipment. Also known as "customer routed" freight.

  • true - The freight charges for the shipment will not be paid by the party setting up the shipment.
  • false - The freight charges for the shipment will be paid by the party setting up the shipment.
isInterlineboolean

A flag that indicates whether another carrier will be used to provide a portion of the transport for the shipment.

modestring[]

The mode of transport used for the shipment.

pickupDateStartstring date
Example:2024-10-01

Start of pickup date range (for searching shipments by pickup date range).

pickupDateEndstring date
Example:2024-10-01

End of pickup date range (for searching shipments by pickup date range).

pricingMethodstring[]

The method for the pricing.

  • contracted - The pricing is based on customer's contract with the carrier.
  • capacity - The pricing is based on the carrier's current capacity in a given lane. (e.g. a spot quote).
pricingTypestring[]

The type of pricing.

statusstring[]
  • 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.
[
  "pending",
  "awarded"
]
bolNumberstring

The Bill of Lading number for the shipment.

referenceNumberstring

A reference number associated with the shipment.

trackingNumberstring

The tracking or PRO number for the shipment.

pickupConfirmationNumberstring

The pickup confirmation number for the shipment.

locationstring[]

Filter shipments by account locationId(s). Use the account locations endpoint to retrieve valid locationId values.

carrierstring[]

Filter shipments by carrierId(s). Use the account carriers endpoint to retrieve valid carrierId values.

quotedBystring[]

Filter shipments by the userId(s) who quoted the shipment. Use the account users endpoint to retrieve valid userId values.

bookedBystring[]

Filter shipments by the userId(s) who booked the shipment. Use the account users endpoint to retrieve valid userId values.

originAccountstring[]

Filter shipments by origin account location ID(s). Use the account locations endpoint to retrieve valid locationId values.

originCitystring[]

Filter shipments by origin city name(s).

originStatestring[]

Filter shipments by origin state code(s).

originZipstring[]

Filter shipments by origin postal code(s).

destAccountstring[]

Filter shipments by destination account location ID(s). Use the account locations endpoint to retrieve valid locationId values.

destCitystring[]

Filter shipments by destination city name(s).

destStatestring[]

Filter shipments by destination state code(s).

destZipstring[]

Filter shipments by destination postal code(s).

Response

Success

continuationTokenstring
  • If search results (in the shipments array) exceed 20 shipments, then a continuationToken value will be returned.
  • Pass the continuationToken as a query parameter to retrieve the next set of search results.
  • If continuationToken is not present, then no further results are available.

Example response

{
  "shipments": [
    {
      "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.