POST rate/getRates/V2

Deprecated This API will be removed in Dec. of 2023. Please use /rates/getRates/V3 instead.

Return the rates provided by carriers

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

EndPoint

Production Url: https://enterprise.freightpop.com/rate/getRates/V2

Sandbox Url: https://sandbox-api.freightpop.com/rate/getRates/V2

Request Information

URI Parameters

None.

Body Parameters

RateRequest
NameDescriptionTypeAdditional information
ConsigneeAddress

Consignee address

RateAddress
Required
Carriers

Provide carrier details to get rates for specific carriers. Rates for all carriers will be fetched if left empty.

Collection of Carrier
Optional
CarrierType

If CarrierType is passed then system will pick some carriers automatically get rates. CarrierType should only be passed if list of carriers is not passed. If list of carriers is passed then we will ignore this. If you want to get the rates of Truckload and Ocean Freight then you don't need to pass this and mention it in the PackageType of the first item of Shipment Items detail

CarrierType
Optional
Items

Shipment Items detail

Collection of Item
Required
ShipDate

Ship date in UTC

date
Optional
ShipperAddress

Shipper address

RateAddress
Required
AdditionalDetails

Additional details

AdditionalDetails2
Optional

Request Formats

application/json, text/json

Sample:
{
  "ConsigneeAddress": {
    "CompanyId": "sample string 1",
    "City": "sample string 2",
    "Country": "sample string 3",
    "Street": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6",
    "OrderType": "sample string 7"
  },
  "Carriers": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "AccountNickName": "sample string 3",
      "CarrierType": "sample string 4",
      "Other": 0,
      "Services": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "AccountNickName": "sample string 3",
      "CarrierType": "sample string 4",
      "Other": 0,
      "Services": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "CarrierType": 1,
  "Items": [
    {
      "Description": "sample string 1",
      "FreightClass": 2.1,
      "Height": 3.1,
      "Length": 4.1,
      "PackageType": 1,
      "Quantity": 5,
      "Weight": 6.1,
      "Unit": 1,
      "Width": 7.1,
      "PackageId": "sample string 8",
      "NMFC": "sample string 9",
      "Hazmat": true,
      "UnNo": "sample string 11"
    },
    {
      "Description": "sample string 1",
      "FreightClass": 2.1,
      "Height": 3.1,
      "Length": 4.1,
      "PackageType": 1,
      "Quantity": 5,
      "Weight": 6.1,
      "Unit": 1,
      "Width": 7.1,
      "PackageId": "sample string 8",
      "NMFC": "sample string 9",
      "Hazmat": true,
      "UnNo": "sample string 11"
    }
  ],
  "ShipDate": "2024-05-17T18:49:54.8582725-07:00",
  "ShipperAddress": {
    "CompanyId": "sample string 1",
    "City": "sample string 2",
    "Country": "sample string 3",
    "Street": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6",
    "OrderType": "sample string 7"
  },
  "AdditionalDetails": {
    "Accessorials": [
      1,
      1
    ],
    "CarrierInsuranceAmount": 1.0,
    "CODDetails": {
      "Amount": 1.0,
      "ChargeCode": "sample string 2",
      "PaymentType": 1,
      "RemitAddress": {
        "AttentionTo": "sample string 1",
        "City": "sample string 2",
        "CompanyId": "sample string 3",
        "Company": "sample string 4",
        "Country": "sample string 5",
        "Email": "sample string 6",
        "State": "sample string 7",
        "Street1": "sample string 8",
        "Street2": "sample string 9",
        "Phone": "sample string 10",
        "Zip": "sample string 11",
        "OrderType": "sample string 12"
      }
    },
    "DeliveryConfirmation": 1,
    "HazmatEmergencyNo": "sample string 2",
    "HazmatContact": "sample string 3",
    "IsSaturdayDelivery": true,
    "IsDeliveryDutyPaid": true,
    "SpecialInstructions": "sample string 6",
    "PickupSpecialInstructions": "sample string 7",
    "Alcohol": true
  }
}

Response Information

Resource Description

RateResponse
NameDescriptionTypeAdditional information
Data

Rate response object

RateResponseObject

None.

Code

Response code returned by api

HttpStatusCode

None.

Message

Human readable message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "Rates": [
      {
        "Id": "sample string 1",
        "AccountName": "sample string 2",
        "CarrierSCAC": "sample string 3",
        "Carrier": "sample string 4",
        "Currency": "sample string 5",
        "DeliveryDate": "2024-05-17T18:49:54.8752721-07:00",
        "DeliveryDays": 6,
        "QuoteId": "sample string 7",
        "CarrierQuoteId": "sample string 8",
        "Service": "sample string 9",
        "ListCost": 10.0,
        "TotalCost": 11.0
      },
      {
        "Id": "sample string 1",
        "AccountName": "sample string 2",
        "CarrierSCAC": "sample string 3",
        "Carrier": "sample string 4",
        "Currency": "sample string 5",
        "DeliveryDate": "2024-05-17T18:49:54.8752721-07:00",
        "DeliveryDays": 6,
        "QuoteId": "sample string 7",
        "CarrierQuoteId": "sample string 8",
        "Service": "sample string 9",
        "ListCost": 10.0,
        "TotalCost": 11.0
      }
    ],
    "ErrorMessages": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Code": 100,
  "Message": "sample string 1"
}