POST rate/getRates/V3

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/V3

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

Request Information

URI Parameters

None.

Body Parameters

RateRequestV3
NameDescriptionTypeAdditional information
ConsigneeAddress

Consignee address

RateAddressV3
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
CustomerId

Company ID for customers when Logistics Provider flag is turned on. Otherwise it will be ignored.

string

None.

Items

Shipment Items detail

Collection of Item
Required
ShipDate

Ship date in UTC

date
Optional
ShipperAddress

Shipper address

RateAddressV3
Required
AdditionalDetails

Additional details

AdditionalDetailsV3
Optional
ProductDetails

Product details

Collection of ProductDetail

None.

ITN

International transaction number

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ConsigneeAddress": {
    "CompanyId": "sample string 1",
    "Company": "sample string 2",
    "AttentionTo": "sample string 3",
    "Street": "sample string 4",
    "Street2": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "Country": "sample string 9",
    "Phone": "sample string 10",
    "Email": "sample string 11",
    "OrderType": "sample string 12",
    "RequiredArrivalDate": "2024-05-17T21:14:35.2586313-07:00",
    "TMStoDetermineResidential": true,
    "AddressValidation": true
  },
  "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,
  "CustomerId": "sample string 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-17T21:14:35.2586313-07:00",
  "ShipperAddress": {
    "CompanyId": "sample string 1",
    "Company": "sample string 2",
    "AttentionTo": "sample string 3",
    "Street": "sample string 4",
    "Street2": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "Country": "sample string 9",
    "Phone": "sample string 10",
    "Email": "sample string 11",
    "OrderType": "sample string 12",
    "RequiredArrivalDate": "2024-05-17T21:14:35.2586313-07:00",
    "TMStoDetermineResidential": true,
    "AddressValidation": true
  },
  "AdditionalDetails": {
    "Accessorials": [
      1,
      1
    ],
    "ReturnDutiesandTaxes": true,
    "Vin": "sample string 2",
    "BuyerId": "sample string 3",
    "Year": 4,
    "StockNumber": "sample string 5",
    "Make": "sample string 6",
    "PicturesLink": "sample string 7",
    "Model": "sample string 8",
    "SalvageId": "sample string 9",
    "VehicleCondition": 0,
    "UserDefinedField1": "sample string 10",
    "UserDefinedField2": "sample string 11",
    "UserDefinedField3": "sample string 12",
    "UserDefinedField4": "sample string 13",
    "UserDefinedField5": "2024-05-17T21:14:35.2586313-07:00",
    "UserDefinedField6": "2024-05-17T21:14:35.2586313-07:00",
    "MainIncoterm": "sample string 14",
    "InvoiceComments": "sample string 15",
    "PaymentTerms": "sample string 16",
    "PackingSlipComments": "sample string 17",
    "PaymentDueDate": "2024-05-17T21:14:35.2586313-07:00",
    "Tins": "sample string 18",
    "TinsType": "sample string 19",
    "PostalCode": "sample string 20",
    "PersonName": "sample string 21",
    "CompanyName": "sample string 22",
    "PhoneNumber": "sample string 23",
    "EmailAddress": "sample string 24",
    "StreetLine1": "sample string 25",
    "StreetLine2": "sample string 26",
    "City": "sample string 27",
    "StateOrProvinceCode": "sample string 28",
    "CountryCode": "sample string 29",
    "IsBrokerSelected": true,
    "FedExBrokerType": "sample string 31",
    "ThirdPartyInsuranceAmount": 32.0,
    "ThirdPartyInsuranceCommodityCode": "sample string 33",
    "CarrierInsuranceAmount": 34.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 35",
    "HazmatContact": "sample string 36",
    "IsSaturdayDelivery": true,
    "IsDeliveryDutyPaid": true,
    "SpecialInstructions": "sample string 39",
    "PickupSpecialInstructions": "sample string 40",
    "Alcohol": true
  },
  "ProductDetails": [
    {
      "Country": "sample string 1",
      "HTSCode": "sample string 2",
      "Description": "sample string 3",
      "Number": "sample string 4",
      "PackageId": "sample string 5",
      "PricePerPiece": 6.0,
      "PricePerPiece2": 7.0,
      "PricePerPiece3": 8.0,
      "PricePerPiece4": 9.0,
      "Quantity": 10,
      "Quantity2": 11,
      "Quantity3": 12,
      "Quantity4": 13,
      "Unit": "sample string 14",
      "OrderNumber": "sample string 15",
      "LineType": "sample string 16",
      "LineNumber": "sample string 17",
      "UPC": "sample string 18",
      "Category": "sample string 19",
      "SKU": "sample string 20"
    },
    {
      "Country": "sample string 1",
      "HTSCode": "sample string 2",
      "Description": "sample string 3",
      "Number": "sample string 4",
      "PackageId": "sample string 5",
      "PricePerPiece": 6.0,
      "PricePerPiece2": 7.0,
      "PricePerPiece3": 8.0,
      "PricePerPiece4": 9.0,
      "Quantity": 10,
      "Quantity2": 11,
      "Quantity3": 12,
      "Quantity4": 13,
      "Unit": "sample string 14",
      "OrderNumber": "sample string 15",
      "LineType": "sample string 16",
      "LineNumber": "sample string 17",
      "UPC": "sample string 18",
      "Category": "sample string 19",
      "SKU": "sample string 20"
    }
  ],
  "ITN": "sample string 2"
}

Response Information

Resource Description

RateResponseV3
NameDescriptionTypeAdditional information
Data

Rate response object

RateResponseObjectV3

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",
        "CarrierId": 5,
        "InternalVendorID": "sample string 6",
        "CarrierRating": "sample string 7",
        "QuoteId": 8,
        "CarrierQuoteId": "sample string 9",
        "Service": "sample string 10",
        "ServiceId": 11,
        "Currency": "sample string 12",
        "DeliveryDate": "2024-05-17T21:14:35.2616329-07:00",
        "DeliveryDays": 13,
        "ListCost": 14.0,
        "BaseRate": 15.0,
        "MarkedUpRate": 16.0,
        "DutiesAndTaxes": 17.0,
        "BaseRateTotal": 18.0,
        "MarkedUpRateTotal": 19.0,
        "IsMultiLegRate": true,
        "MultiLegs": [
          {
            "LegSequenceId": 1,
            "FromAddress": "sample string 2",
            "FromCompanyId": "sample string 3",
            "FromCompanyName": "sample string 4",
            "FromAttentionTo": "sample string 5",
            "FromStreet1": "sample string 6",
            "FromStreet2": "sample string 7",
            "FromCity": "sample string 8",
            "FromState": "sample string 9",
            "FromZip": "sample string 10",
            "FromCountry": "sample string 11",
            "ToAddress": "sample string 12",
            "ToCompanyId": "sample string 13",
            "ToCompanyName": "sample string 14",
            "ToAttentionTo": "sample string 15",
            "ToStreet1": "sample string 16",
            "ToStreet2": "sample string 17",
            "ToCity": "sample string 18",
            "ToState": "sample string 19",
            "ToZip": "sample string 20",
            "ToCountry": "sample string 21",
            "LaneCode": "sample string 22",
            "TranistDays": 23,
            "CarrierName": "sample string 24",
            "CarrierId": 25,
            "ServiceName": "sample string 26",
            "InternalVendorID": "sample string 27",
            "ListCost": 28.0,
            "BaseRate": 29.0,
            "MarkedUpRate": 30.0,
            "ServiceCharges": 31.0,
            "FromMailingCompany": "sample string 32",
            "FromMailingAttentionTo": "sample string 33",
            "FromMailingStreet1": "sample string 34",
            "FromMailingStreet2": "sample string 35",
            "FromMailingCity": "sample string 36",
            "FromMailingState": "sample string 37",
            "FromMailingZip": "sample string 38",
            "FromMailingCountry": "sample string 39",
            "FromMailingNotes": "sample string 40",
            "FromMailingPhone": "sample string 41",
            "FromMailingEmail": "sample string 42",
            "ToMailingCompany": "sample string 43",
            "ToMailingAttentionTo": "sample string 44",
            "ToMailingStreet1": "sample string 45",
            "ToMailingStreet2": "sample string 46",
            "ToMailingCity": "sample string 47",
            "ToMailingState": "sample string 48",
            "ToMailingZip": "sample string 49",
            "ToMailingCountry": "sample string 50",
            "ToMailingNotes": "sample string 51",
            "ToMailingPhone": "sample string 52",
            "ToMailingEmail": "sample string 53",
            "ExtraCharges": [
              {
                "CompanyName": "sample string 1",
                "InternalVendorId": "sample string 2",
                "Direction": "sample string 3",
                "DirectionCode": 1,
                "CostPerShipment": 4.0,
                "ServiceName": "sample string 5"
              },
              {
                "CompanyName": "sample string 1",
                "InternalVendorId": "sample string 2",
                "Direction": "sample string 3",
                "DirectionCode": 1,
                "CostPerShipment": 4.0,
                "ServiceName": "sample string 5"
              }
            ]
          },
          {
            "LegSequenceId": 1,
            "FromAddress": "sample string 2",
            "FromCompanyId": "sample string 3",
            "FromCompanyName": "sample string 4",
            "FromAttentionTo": "sample string 5",
            "FromStreet1": "sample string 6",
            "FromStreet2": "sample string 7",
            "FromCity": "sample string 8",
            "FromState": "sample string 9",
            "FromZip": "sample string 10",
            "FromCountry": "sample string 11",
            "ToAddress": "sample string 12",
            "ToCompanyId": "sample string 13",
            "ToCompanyName": "sample string 14",
            "ToAttentionTo": "sample string 15",
            "ToStreet1": "sample string 16",
            "ToStreet2": "sample string 17",
            "ToCity": "sample string 18",
            "ToState": "sample string 19",
            "ToZip": "sample string 20",
            "ToCountry": "sample string 21",
            "LaneCode": "sample string 22",
            "TranistDays": 23,
            "CarrierName": "sample string 24",
            "CarrierId": 25,
            "ServiceName": "sample string 26",
            "InternalVendorID": "sample string 27",
            "ListCost": 28.0,
            "BaseRate": 29.0,
            "MarkedUpRate": 30.0,
            "ServiceCharges": 31.0,
            "FromMailingCompany": "sample string 32",
            "FromMailingAttentionTo": "sample string 33",
            "FromMailingStreet1": "sample string 34",
            "FromMailingStreet2": "sample string 35",
            "FromMailingCity": "sample string 36",
            "FromMailingState": "sample string 37",
            "FromMailingZip": "sample string 38",
            "FromMailingCountry": "sample string 39",
            "FromMailingNotes": "sample string 40",
            "FromMailingPhone": "sample string 41",
            "FromMailingEmail": "sample string 42",
            "ToMailingCompany": "sample string 43",
            "ToMailingAttentionTo": "sample string 44",
            "ToMailingStreet1": "sample string 45",
            "ToMailingStreet2": "sample string 46",
            "ToMailingCity": "sample string 47",
            "ToMailingState": "sample string 48",
            "ToMailingZip": "sample string 49",
            "ToMailingCountry": "sample string 50",
            "ToMailingNotes": "sample string 51",
            "ToMailingPhone": "sample string 52",
            "ToMailingEmail": "sample string 53",
            "ExtraCharges": [
              {
                "CompanyName": "sample string 1",
                "InternalVendorId": "sample string 2",
                "Direction": "sample string 3",
                "DirectionCode": 1,
                "CostPerShipment": 4.0,
                "ServiceName": "sample string 5"
              },
              {
                "CompanyName": "sample string 1",
                "InternalVendorId": "sample string 2",
                "Direction": "sample string 3",
                "DirectionCode": 1,
                "CostPerShipment": 4.0,
                "ServiceName": "sample string 5"
              }
            ]
          }
        ],
        "BaseRateBreakDown": {
          "FreightCharges": 1.1,
          "FuelCharges": 2.1,
          "OtherCharges": 3.1,
          "OtherChargesBreakDown": [
            {
              "Key": "sample string 1",
              "Value": 2.1
            },
            {
              "Key": "sample string 1",
              "Value": 2.1
            }
          ]
        }
      },
      {
        "Id": "sample string 1",
        "AccountName": "sample string 2",
        "CarrierSCAC": "sample string 3",
        "Carrier": "sample string 4",
        "CarrierId": 5,
        "InternalVendorID": "sample string 6",
        "CarrierRating": "sample string 7",
        "QuoteId": 8,
        "CarrierQuoteId": "sample string 9",
        "Service": "sample string 10",
        "ServiceId": 11,
        "Currency": "sample string 12",
        "DeliveryDate": "2024-05-17T21:14:35.2616329-07:00",
        "DeliveryDays": 13,
        "ListCost": 14.0,
        "BaseRate": 15.0,
        "MarkedUpRate": 16.0,
        "DutiesAndTaxes": 17.0,
        "BaseRateTotal": 18.0,
        "MarkedUpRateTotal": 19.0,
        "IsMultiLegRate": true,
        "MultiLegs": [
          {
            "LegSequenceId": 1,
            "FromAddress": "sample string 2",
            "FromCompanyId": "sample string 3",
            "FromCompanyName": "sample string 4",
            "FromAttentionTo": "sample string 5",
            "FromStreet1": "sample string 6",
            "FromStreet2": "sample string 7",
            "FromCity": "sample string 8",
            "FromState": "sample string 9",
            "FromZip": "sample string 10",
            "FromCountry": "sample string 11",
            "ToAddress": "sample string 12",
            "ToCompanyId": "sample string 13",
            "ToCompanyName": "sample string 14",
            "ToAttentionTo": "sample string 15",
            "ToStreet1": "sample string 16",
            "ToStreet2": "sample string 17",
            "ToCity": "sample string 18",
            "ToState": "sample string 19",
            "ToZip": "sample string 20",
            "ToCountry": "sample string 21",
            "LaneCode": "sample string 22",
            "TranistDays": 23,
            "CarrierName": "sample string 24",
            "CarrierId": 25,
            "ServiceName": "sample string 26",
            "InternalVendorID": "sample string 27",
            "ListCost": 28.0,
            "BaseRate": 29.0,
            "MarkedUpRate": 30.0,
            "ServiceCharges": 31.0,
            "FromMailingCompany": "sample string 32",
            "FromMailingAttentionTo": "sample string 33",
            "FromMailingStreet1": "sample string 34",
            "FromMailingStreet2": "sample string 35",
            "FromMailingCity": "sample string 36",
            "FromMailingState": "sample string 37",
            "FromMailingZip": "sample string 38",
            "FromMailingCountry": "sample string 39",
            "FromMailingNotes": "sample string 40",
            "FromMailingPhone": "sample string 41",
            "FromMailingEmail": "sample string 42",
            "ToMailingCompany": "sample string 43",
            "ToMailingAttentionTo": "sample string 44",
            "ToMailingStreet1": "sample string 45",
            "ToMailingStreet2": "sample string 46",
            "ToMailingCity": "sample string 47",
            "ToMailingState": "sample string 48",
            "ToMailingZip": "sample string 49",
            "ToMailingCountry": "sample string 50",
            "ToMailingNotes": "sample string 51",
            "ToMailingPhone": "sample string 52",
            "ToMailingEmail": "sample string 53",
            "ExtraCharges": [
              {
                "CompanyName": "sample string 1",
                "InternalVendorId": "sample string 2",
                "Direction": "sample string 3",
                "DirectionCode": 1,
                "CostPerShipment": 4.0,
                "ServiceName": "sample string 5"
              },
              {
                "CompanyName": "sample string 1",
                "InternalVendorId": "sample string 2",
                "Direction": "sample string 3",
                "DirectionCode": 1,
                "CostPerShipment": 4.0,
                "ServiceName": "sample string 5"
              }
            ]
          },
          {
            "LegSequenceId": 1,
            "FromAddress": "sample string 2",
            "FromCompanyId": "sample string 3",
            "FromCompanyName": "sample string 4",
            "FromAttentionTo": "sample string 5",
            "FromStreet1": "sample string 6",
            "FromStreet2": "sample string 7",
            "FromCity": "sample string 8",
            "FromState": "sample string 9",
            "FromZip": "sample string 10",
            "FromCountry": "sample string 11",
            "ToAddress": "sample string 12",
            "ToCompanyId": "sample string 13",
            "ToCompanyName": "sample string 14",
            "ToAttentionTo": "sample string 15",
            "ToStreet1": "sample string 16",
            "ToStreet2": "sample string 17",
            "ToCity": "sample string 18",
            "ToState": "sample string 19",
            "ToZip": "sample string 20",
            "ToCountry": "sample string 21",
            "LaneCode": "sample string 22",
            "TranistDays": 23,
            "CarrierName": "sample string 24",
            "CarrierId": 25,
            "ServiceName": "sample string 26",
            "InternalVendorID": "sample string 27",
            "ListCost": 28.0,
            "BaseRate": 29.0,
            "MarkedUpRate": 30.0,
            "ServiceCharges": 31.0,
            "FromMailingCompany": "sample string 32",
            "FromMailingAttentionTo": "sample string 33",
            "FromMailingStreet1": "sample string 34",
            "FromMailingStreet2": "sample string 35",
            "FromMailingCity": "sample string 36",
            "FromMailingState": "sample string 37",
            "FromMailingZip": "sample string 38",
            "FromMailingCountry": "sample string 39",
            "FromMailingNotes": "sample string 40",
            "FromMailingPhone": "sample string 41",
            "FromMailingEmail": "sample string 42",
            "ToMailingCompany": "sample string 43",
            "ToMailingAttentionTo": "sample string 44",
            "ToMailingStreet1": "sample string 45",
            "ToMailingStreet2": "sample string 46",
            "ToMailingCity": "sample string 47",
            "ToMailingState": "sample string 48",
            "ToMailingZip": "sample string 49",
            "ToMailingCountry": "sample string 50",
            "ToMailingNotes": "sample string 51",
            "ToMailingPhone": "sample string 52",
            "ToMailingEmail": "sample string 53",
            "ExtraCharges": [
              {
                "CompanyName": "sample string 1",
                "InternalVendorId": "sample string 2",
                "Direction": "sample string 3",
                "DirectionCode": 1,
                "CostPerShipment": 4.0,
                "ServiceName": "sample string 5"
              },
              {
                "CompanyName": "sample string 1",
                "InternalVendorId": "sample string 2",
                "Direction": "sample string 3",
                "DirectionCode": 1,
                "CostPerShipment": 4.0,
                "ServiceName": "sample string 5"
              }
            ]
          }
        ],
        "BaseRateBreakDown": {
          "FreightCharges": 1.1,
          "FuelCharges": 2.1,
          "OtherCharges": 3.1,
          "OtherChargesBreakDown": [
            {
              "Key": "sample string 1",
              "Value": 2.1
            },
            {
              "Key": "sample string 1",
              "Value": 2.1
            }
          ]
        }
      }
    ],
    "ErrorMessages": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Code": 100,
  "Message": "sample string 1"
}