POST api/RateRequest

Use this function to price a shipment. Submit your HttpRequestMessage in either XML or JSON format with content mapped as per the _RequestSubmitted/RateRequest structure defined in the Response Information documentation.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

RateResults

RateResults
NameDescriptionTypeAdditional information
_RequestSubmitted

The HttpRequestMessage submitted with your API call will also be returned in this field. It must be submitted in either XML or JSON format in accordance with the [RateRequest] schema (drill-down for details):

RateRequest

None.
ErrorInfo

This field will be empty (blank) if the API Request was processed with no errors. A non-blank response will describe the issue(s) encountered in processing the request.

string

None.
TariffCode

Documents the tariff code (1-8 alphanumeric characters) by which the shipment was rated.

string

None.
TariffVersion

Documents the numeric version of the tariff used to rate the shipment

integer

None.
FromCity

Shows the shipment's originating city, as supplied in the original request.

string

None.
FromState

Shows the shipment's originating state, as supplied in the original request.

string

None.
FromZip

Shows the shipment's originating zip code, as supplied in the original request.

string

None.
ToCity

Shows the shipment's terminating city, as supplied in the original request.

string

None.
ToState

Shows the shipment's terminating state, as supplied in the original request.

string

None.
ToZip

Shows the shipment's terminating zip code, as supplied in the original request.

string

None.
PalletCount

Shows the total pallet count for the freight supplied in the original request.

integer

None.
PieceCount

Shows the total piece count (PCS, BOXES, TOTES, etc..) for the freight supplied in the original request.

integer

None.
WeightTotal

Shows the total weight of the shipment, in LBS, for the freight supplied in the original request.

integer

None.
Total

Shows the Rated Total amount for the shipment; drill-down on RateDetails for a breakdown of charges.

decimal number

None.
RateDetails

Shows the priced line item details for the shipment in support of the total charge provided.

Collection of LineItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "_RequestSubmitted": {
    "Logon": "sample string 1",
    "Pass": "sample string 2",
    "ShipFromCity": "sample string 3",
    "ShipFromState": "sample string 4",
    "ShipFromZip": "sample string 5",
    "ShipToCity": "sample string 6",
    "ShipToState": "sample string 7",
    "ShipToZip": "sample string 8",
    "PPDorCOL": "sample string 9",
    "Inbound": "sample string 10",
    "FreightList": [
      {
        "FreightClass": "sample string 1",
        "Weight": 2,
        "PalletCount": 3,
        "PieceCount": 4,
        "Length": 5,
        "Height": 6,
        "Width": 7
      },
      {
        "FreightClass": "sample string 1",
        "Weight": 2,
        "PalletCount": 3,
        "PieceCount": 4,
        "Length": 5,
        "Height": 6,
        "Width": 7
      }
    ],
    "AccessorialList": [
      {
        "AccessorialCode": "sample string 1"
      },
      {
        "AccessorialCode": "sample string 1"
      }
    ],
    "CODAmountInCents": 11
  },
  "ErrorInfo": "sample string 1",
  "TariffCode": "sample string 2",
  "TariffVersion": 3,
  "FromCity": "sample string 4",
  "FromState": "sample string 5",
  "FromZip": "sample string 6",
  "ToCity": "sample string 7",
  "ToState": "sample string 8",
  "ToZip": "sample string 9",
  "PalletCount": 10,
  "PieceCount": 11,
  "WeightTotal": 12,
  "Total": 13.0,
  "RateDetails": [
    {
      "Description": "sample string 1",
      "Amount": 2.0
    },
    {
      "Description": "sample string 1",
      "Amount": 2.0
    }
  ]
}

application/xml, text/xml

Sample: 
<RateResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUBLAPI">
  <ErrorInfo>sample string 1</ErrorInfo>
  <FromCity>sample string 4</FromCity>
  <FromState>sample string 5</FromState>
  <FromZip>sample string 6</FromZip>
  <PalletCount>10</PalletCount>
  <PieceCount>11</PieceCount>
  <RateDetails>
    <LineItem>
      <Amount>2</Amount>
      <Description>sample string 1</Description>
    </LineItem>
    <LineItem>
      <Amount>2</Amount>
      <Description>sample string 1</Description>
    </LineItem>
  </RateDetails>
  <TariffCode>sample string 2</TariffCode>
  <TariffVersion>3</TariffVersion>
  <ToCity>sample string 7</ToCity>
  <ToState>sample string 8</ToState>
  <ToZip>sample string 9</ToZip>
  <Total>13</Total>
  <WeightTotal>12</WeightTotal>
  <_RequestSubmitted>
    <AccessorialList>
      <Accessorial>
        <AccessorialCode>sample string 1</AccessorialCode>
      </Accessorial>
      <Accessorial>
        <AccessorialCode>sample string 1</AccessorialCode>
      </Accessorial>
    </AccessorialList>
    <CODAmountInCents>11</CODAmountInCents>
    <FreightList>
      <FreightItem>
        <FreightClass>sample string 1</FreightClass>
        <Height>6</Height>
        <Length>5</Length>
        <PalletCount>3</PalletCount>
        <PieceCount>4</PieceCount>
        <Weight>2</Weight>
        <Width>7</Width>
      </FreightItem>
      <FreightItem>
        <FreightClass>sample string 1</FreightClass>
        <Height>6</Height>
        <Length>5</Length>
        <PalletCount>3</PalletCount>
        <PieceCount>4</PieceCount>
        <Weight>2</Weight>
        <Width>7</Width>
      </FreightItem>
    </FreightList>
    <Inbound>sample string 10</Inbound>
    <Logon>sample string 1</Logon>
    <PPDorCOL>sample string 9</PPDorCOL>
    <Pass>sample string 2</Pass>
    <ShipFromCity>sample string 3</ShipFromCity>
    <ShipFromState>sample string 4</ShipFromState>
    <ShipFromZip>sample string 5</ShipFromZip>
    <ShipToCity>sample string 6</ShipToCity>
    <ShipToState>sample string 7</ShipToState>
    <ShipToZip>sample string 8</ShipToZip>
  </_RequestSubmitted>
</RateResults>