POST api/Rate/Estimate

Rate estimate

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth		string	None.
AccountNumber		string	None.
ServiceID		integer	None.
OrderDateTime	The order date and time (yyyy-MM-dd HH:mm)	string	None.
Pieces		integer	None.
Weight		decimal number	None.
DimWeight		decimal number	None.
WeightUOM		string	None.
DeclaredValue		decimal number	None.
TotalDistance		integer	None.
TotalDistanceUOM		string	None.
PuAddressCode		string	None.
PuCountryID		string	None.
PuCityName		string	None.
PuStateProvID		string	None.
PuPostalCode		string	None.
PuDateTime	Pickup date and time (yyyy-MM-dd HH:mm)	string	None.
PuDistance		integer	None.
PuDistanceUOM		string	None.
PuAirportID		string	None.
PuWaitingTime		integer	None.
PuAttemptCount		integer	None.
DelAddressCode		string	None.
DelCountryID		string	None.
DelCityName		string	None.
DelStateProvID		string	None.
DelPostalCode		string	None.
DelDateTime	Delivery date and time (yyyy-MM-dd HH:mm)	string	None.
DelDistance		integer	None.
DelDistanceUOM		string	None.
DelAirportID		string	None.
DelWaitingTime		integer	None.
DelAttemptCount		integer	None.
attributeList		string	None.
GelPackCount		integer	None.
DryIceWeightKG		decimal number	None.
CarrierToProvideDryIce		boolean	None.
CarrierToProvideGelPack		boolean	None.
IsDangerousGoods		boolean	None.
pickupHoldOvernight		boolean	None.
deliveryHoldOvernight		boolean	None.
deliveryHoldForPickup		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountNumber": "sample string 2",
  "CarrierToProvideDryIce": true,
  "CarrierToProvideGelPack": true,
  "DeclaredValue": 1,
  "DelAddressCode": "sample string 18",
  "DelAirportID": "sample string 26",
  "DelAttemptCount": 1,
  "DelCityName": "sample string 20",
  "DelCountryID": "sample string 19",
  "DelDateTime": "sample string 23",
  "DelDistance": 24,
  "DelDistanceUOM": "sample string 25",
  "DelPostalCode": "sample string 22",
  "DelStateProvID": "sample string 21",
  "DelWaitingTime": 1,
  "DimWeight": 1,
  "DryIceWeightKG": 1,
  "GelPackCount": 1,
  "IsDangerousGoods": true,
  "OrderDateTime": "sample string 4",
  "Pieces": 1,
  "PuAddressCode": "sample string 9",
  "PuAirportID": "sample string 17",
  "PuAttemptCount": 1,
  "PuCityName": "sample string 11",
  "PuCountryID": "sample string 10",
  "PuDateTime": "sample string 14",
  "PuDistance": 15,
  "PuDistanceUOM": "sample string 16",
  "PuPostalCode": "sample string 13",
  "PuStateProvID": "sample string 12",
  "PuWaitingTime": 1,
  "ServiceID": 3,
  "TotalDistance": 7,
  "TotalDistanceUOM": "sample string 8",
  "Weight": 5,
  "WeightUOM": "sample string 6",
  "attributeList": "sample string 27",
  "auth": "sample string 1",
  "deliveryHoldForPickup": true,
  "deliveryHoldOvernight": true,
  "pickupHoldOvernight": true
}

application/xml, text/xml

Sample:

<RateEstimateParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <AccountNumber>sample string 2</AccountNumber>
  <CarrierToProvideDryIce>true</CarrierToProvideDryIce>
  <CarrierToProvideGelPack>true</CarrierToProvideGelPack>
  <DeclaredValue>1</DeclaredValue>
  <DelAddressCode>sample string 18</DelAddressCode>
  <DelAirportID>sample string 26</DelAirportID>
  <DelAttemptCount>1</DelAttemptCount>
  <DelCityName>sample string 20</DelCityName>
  <DelCountryID>sample string 19</DelCountryID>
  <DelDateTime>sample string 23</DelDateTime>
  <DelDistance>24</DelDistance>
  <DelDistanceUOM>sample string 25</DelDistanceUOM>
  <DelPostalCode>sample string 22</DelPostalCode>
  <DelStateProvID>sample string 21</DelStateProvID>
  <DelWaitingTime>1</DelWaitingTime>
  <DimWeight>1</DimWeight>
  <DryIceWeightKG>1</DryIceWeightKG>
  <GelPackCount>1</GelPackCount>
  <IsDangerousGoods>true</IsDangerousGoods>
  <OrderDateTime>sample string 4</OrderDateTime>
  <Pieces>1</Pieces>
  <PuAddressCode>sample string 9</PuAddressCode>
  <PuAirportID>sample string 17</PuAirportID>
  <PuAttemptCount>1</PuAttemptCount>
  <PuCityName>sample string 11</PuCityName>
  <PuCountryID>sample string 10</PuCountryID>
  <PuDateTime>sample string 14</PuDateTime>
  <PuDistance>15</PuDistance>
  <PuDistanceUOM>sample string 16</PuDistanceUOM>
  <PuPostalCode>sample string 13</PuPostalCode>
  <PuStateProvID>sample string 12</PuStateProvID>
  <PuWaitingTime>1</PuWaitingTime>
  <ServiceID>3</ServiceID>
  <TotalDistance>7</TotalDistance>
  <TotalDistanceUOM>sample string 8</TotalDistanceUOM>
  <Weight>5</Weight>
  <WeightUOM>sample string 6</WeightUOM>
  <attributeList>sample string 27</attributeList>
  <auth>sample string 1</auth>
  <deliveryHoldForPickup>true</deliveryHoldForPickup>
  <deliveryHoldOvernight>true</deliveryHoldOvernight>
  <pickupHoldOvernight>true</pickupHoldOvernight>
</RateEstimateParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RateEstimateResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
Charges	Estimated charge detail	Collection of RatedCharge	None.

Response Formats

application/json, text/json

Sample:

{
  "Charges": [
    {
      "Amount": 5,
      "ChargeCode": "sample string 2",
      "ChargeTypeID": 1,
      "CurrencyApply": true,
      "CurrencyID": "sample string 17",
      "Description": "sample string 4",
      "Discountable": true,
      "FuelApply": true,
      "GLAcctNum": "sample string 9",
      "Name": "sample string 3",
      "NetAmount": 7,
      "RateID": 11,
      "SecurityApply": true,
      "SortOrder": 10,
      "TaxAmount": 6,
      "TaxCode": "sample string 8",
      "Taxable": true
    },
    {
      "Amount": 5,
      "ChargeCode": "sample string 2",
      "ChargeTypeID": 1,
      "CurrencyApply": true,
      "CurrencyID": "sample string 17",
      "Description": "sample string 4",
      "Discountable": true,
      "FuelApply": true,
      "GLAcctNum": "sample string 9",
      "Name": "sample string 3",
      "NetAmount": 7,
      "RateID": 11,
      "SecurityApply": true,
      "SortOrder": 10,
      "TaxAmount": 6,
      "TaxCode": "sample string 8",
      "Taxable": true
    }
  ],
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true
}

application/xml, text/xml

Sample:

<RateEstimateResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <Charges>
    <RatedCharge>
      <Amount>5</Amount>
      <ChargeCode>sample string 2</ChargeCode>
      <ChargeTypeID>1</ChargeTypeID>
      <CurrencyApply>true</CurrencyApply>
      <CurrencyID>sample string 17</CurrencyID>
      <Description>sample string 4</Description>
      <Discountable>true</Discountable>
      <FuelApply>true</FuelApply>
      <GLAcctNum>sample string 9</GLAcctNum>
      <Name>sample string 3</Name>
      <NetAmount>7</NetAmount>
      <RateID>11</RateID>
      <SecurityApply>true</SecurityApply>
      <SortOrder>10</SortOrder>
      <TaxAmount>6</TaxAmount>
      <TaxCode>sample string 8</TaxCode>
      <Taxable>true</Taxable>
    </RatedCharge>
    <RatedCharge>
      <Amount>5</Amount>
      <ChargeCode>sample string 2</ChargeCode>
      <ChargeTypeID>1</ChargeTypeID>
      <CurrencyApply>true</CurrencyApply>
      <CurrencyID>sample string 17</CurrencyID>
      <Description>sample string 4</Description>
      <Discountable>true</Discountable>
      <FuelApply>true</FuelApply>
      <GLAcctNum>sample string 9</GLAcctNum>
      <Name>sample string 3</Name>
      <NetAmount>7</NetAmount>
      <RateID>11</RateID>
      <SecurityApply>true</SecurityApply>
      <SortOrder>10</SortOrder>
      <TaxAmount>6</TaxAmount>
      <TaxCode>sample string 8</TaxCode>
      <Taxable>true</Taxable>
    </RatedCharge>
  </Charges>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</RateEstimateResp>