POST api/Rate/RateTest
Request Information
URI Parameters
None.
Body Parameters
RateTestParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| AccountNumber | string |
None. |
|
| ServiceID | integer |
None. |
|
| OrderDateTime | date |
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 | date |
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 | date |
None. |
|
| DelDistance | integer |
None. |
|
| DelDistanceUOM | string |
None. |
|
| DelAirportID | string |
None. |
|
| DelWaitingTime | integer |
None. |
|
| DelAttemptCount | integer |
None. |
|
| attributeList | string |
None. |
|
| ManifestCount | integer |
None. |
|
| PuBonded | boolean |
None. |
|
| DelBonded | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"AccountNumber": "sample string 2",
"ServiceID": 3,
"OrderDateTime": "2025-12-03T12:34:16.1178988+00:00",
"Pieces": 1,
"Weight": 5.0,
"DimWeight": 1.0,
"WeightUOM": "sample string 6",
"DeclaredValue": 1.0,
"TotalDistance": 7,
"TotalDistanceUOM": "sample string 8",
"PuAddressCode": "sample string 9",
"PuCountryID": "sample string 10",
"PuCityName": "sample string 11",
"PuStateProvID": "sample string 12",
"PuPostalCode": "sample string 13",
"PuDateTime": "2025-12-03T12:34:16.1178988+00:00",
"PuDistance": 15,
"PuDistanceUOM": "sample string 16",
"PuAirportID": "sample string 17",
"PuWaitingTime": 1,
"PuAttemptCount": 1,
"DelAddressCode": "sample string 18",
"DelCountryID": "sample string 19",
"DelCityName": "sample string 20",
"DelStateProvID": "sample string 21",
"DelPostalCode": "sample string 22",
"DelDateTime": "2025-12-03T12:34:16.1178988+00:00",
"DelDistance": 24,
"DelDistanceUOM": "sample string 25",
"DelAirportID": "sample string 26",
"DelWaitingTime": 1,
"DelAttemptCount": 1,
"attributeList": "sample string 27",
"ManifestCount": 1,
"PuBonded": true,
"DelBonded": true
}
application/xml, text/xml
Sample:
<RateTestParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <AccountNumber>sample string 2</AccountNumber> <DeclaredValue>1</DeclaredValue> <DelAddressCode>sample string 18</DelAddressCode> <DelAirportID>sample string 26</DelAirportID> <DelAttemptCount>1</DelAttemptCount> <DelBonded>true</DelBonded> <DelCityName>sample string 20</DelCityName> <DelCountryID>sample string 19</DelCountryID> <DelDateTime>2025-12-03T12:34:16.1178988+00:00</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> <ManifestCount>1</ManifestCount> <OrderDateTime>2025-12-03T12:34:16.1178988+00:00</OrderDateTime> <Pieces>1</Pieces> <PuAddressCode>sample string 9</PuAddressCode> <PuAirportID>sample string 17</PuAirportID> <PuAttemptCount>1</PuAttemptCount> <PuBonded>true</PuBonded> <PuCityName>sample string 11</PuCityName> <PuCountryID>sample string 10</PuCountryID> <PuDateTime>2025-12-03T12:34:16.1178988+00:00</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> </RateTestParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RateTestResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| Charges | Collection of Charge |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"Charges": null
}
application/xml, text/xml
Sample:
<RateTestResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <Charges i:nil="true" /> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </RateTestResp>