POST api/logistics/GetFreightCarrierRates

Get freight carrier rates

Request Information

URI Parameters

None.

Body Parameters

FreightRatingRequest
Name Type Description Additional information
consigneeZip string

equipmentType string

shipmentMode string

shipperZip string

miles string

shipperCountry string

consigneeCountry string

accessorials Collection of string

items Collection of RatingItem

Request Formats

application/json, text/json

Sample: 
{
  "consigneeZip": "sample string 1",
  "equipmentType": "sample string 2",
  "shipmentMode": "sample string 3",
  "shipperZip": "sample string 4",
  "miles": "sample string 5",
  "shipperCountry": "sample string 6",
  "consigneeCountry": "sample string 7",
  "accessorials": [
    "sample string 1",
    "sample string 2"
  ],
  "items": [
    {
      "class": "sample string 1",
      "isHazardous": true,
      "pieces": 3,
      "weight": 4.1,
      "packaging": "sample string 5",
      "nmfc": 6,
      "productDescription": "sample string 7",
      "density": "sample string 8",
      "length": 9.1,
      "height": 10.1,
      "width": 11.1,
      "billed": 12.1,
      "cost": 13.1,
      "unitsWeight": "sample string 14",
      "unitsDensity": "sample string 15",
      "unitsDimension": "sample string 16"
    },
    {
      "class": "sample string 1",
      "isHazardous": true,
      "pieces": 3,
      "weight": 4.1,
      "packaging": "sample string 5",
      "nmfc": 6,
      "productDescription": "sample string 7",
      "density": "sample string 8",
      "length": 9.1,
      "height": 10.1,
      "width": 11.1,
      "billed": 12.1,
      "cost": 13.1,
      "unitsWeight": "sample string 14",
      "unitsDensity": "sample string 15",
      "unitsDimension": "sample string 16"
    }
  ]
}

application/xml, text/xml

Sample: 
<FreightRatingRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <consigneeZip>sample string 1</consigneeZip>
  <equipmentType>sample string 2</equipmentType>
  <shipmentMode>sample string 3</shipmentMode>
  <shipperZip>sample string 4</shipperZip>
  <miles>sample string 5</miles>
  <shipperCountry>sample string 6</shipperCountry>
  <consigneeCountry>sample string 7</consigneeCountry>
  <accessorials>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </accessorials>
  <items>
    <RatingItem>
      <class>sample string 1</class>
      <isHazardous>true</isHazardous>
      <pieces>3</pieces>
      <weight>4.1</weight>
      <packaging>sample string 5</packaging>
      <nmfc>6</nmfc>
      <productDescription>sample string 7</productDescription>
      <density>sample string 8</density>
      <length>9.1</length>
      <height>10.1</height>
      <width>11.1</width>
      <billed>12.1</billed>
      <cost>13.1</cost>
      <unitsWeight>sample string 14</unitsWeight>
      <unitsDensity>sample string 15</unitsDensity>
      <unitsDimension>sample string 16</unitsDimension>
    </RatingItem>
    <RatingItem>
      <class>sample string 1</class>
      <isHazardous>true</isHazardous>
      <pieces>3</pieces>
      <weight>4.1</weight>
      <packaging>sample string 5</packaging>
      <nmfc>6</nmfc>
      <productDescription>sample string 7</productDescription>
      <density>sample string 8</density>
      <length>9.1</length>
      <height>10.1</height>
      <width>11.1</width>
      <billed>12.1</billed>
      <cost>13.1</cost>
      <unitsWeight>sample string 14</unitsWeight>
      <unitsDensity>sample string 15</unitsDensity>
      <unitsDimension>sample string 16</unitsDimension>
    </RatingItem>
  </items>
</FreightRatingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of FreightRatingResponse
Name Type Description Additional information
name string

scac string

billed decimal number

transitTime string

Response Formats

application/json, text/json

Sample: 
[
  {
    "name": "sample string 1",
    "scac": "sample string 2",
    "billed": 3.1,
    "transitTime": "sample string 4"
  },
  {
    "name": "sample string 1",
    "scac": "sample string 2",
    "billed": 3.1,
    "transitTime": "sample string 4"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfFreightRatingResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FreightRatingResponse>
    <name>sample string 1</name>
    <scac>sample string 2</scac>
    <billed>3.1</billed>
    <transitTime>sample string 4</transitTime>
  </FreightRatingResponse>
  <FreightRatingResponse>
    <name>sample string 1</name>
    <scac>sample string 2</scac>
    <billed>3.1</billed>
    <transitTime>sample string 4</transitTime>
  </FreightRatingResponse>
</ArrayOfFreightRatingResponse>