POST Quote
Submit a quote request
Request Information
URI Parameters
None.
Body Parameters
QuoteRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PickupDate |
Date the shipment will be picked up. If not provided, defaults to the current date. |
date |
None. |
| Orig |
Origin zone id, usually the zip or postal code (see Service/ServicePoint) |
string |
Required Matching regular expression pattern: (?i)^(\d{5}.*)|[A-Z]\d[A-Z]\s?\d[A-Z]\d |
| Dest |
Destination zone id, usually the zip or postal code (see Service/ServicePoint) |
string |
Required Matching regular expression pattern: (?i)^(\d{5}.*)|[A-Z]\d[A-Z]\s?\d[A-Z]\d |
| Details |
Freight characteristics |
Collection of QuoteRequestDetail |
Required |
| Accessorials |
Accessorial services and fees |
Collection of QuoteRequestAccessorial |
None. |
Request Formats
application/json, text/json
Sample:
{
"PickupDate": "2024-11-20T21:12:25.9804035-06:00",
"Orig": "sample string 2",
"Dest": "sample string 3",
"Details": [
{
"Units": 1,
"PackageType": "sample string 2",
"Weight": 3.1,
"Class": 4.1,
"Contents": [
{
"Class": 1.1,
"Weight": 2.1
},
{
"Class": 1.1,
"Weight": 2.1
}
],
"Length": 5.1,
"Width": 6.1,
"Height": 7.1
},
{
"Units": 1,
"PackageType": "sample string 2",
"Weight": 3.1,
"Class": 4.1,
"Contents": [
{
"Class": 1.1,
"Weight": 2.1
},
{
"Class": 1.1,
"Weight": 2.1
}
],
"Length": 5.1,
"Width": 6.1,
"Height": 7.1
}
],
"Accessorials": [
{
"Code": "sample string 1",
"Factor": 2.1
},
{
"Code": "sample string 1",
"Factor": 2.1
}
]
}
application/xml, text/xml
Sample:
<QuoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<PickupDate>2024-11-20T21:12:25.9804035-06:00</PickupDate>
<Orig>sample string 2</Orig>
<Dest>sample string 3</Dest>
<Details>
<QuoteRequestDetail>
<Units>1</Units>
<PackageType>sample string 2</PackageType>
<Weight>3.1</Weight>
<Class>4.1</Class>
<Contents>
<QuoteRequestDetailContent>
<Class>1.1</Class>
<Weight>2.1</Weight>
</QuoteRequestDetailContent>
<QuoteRequestDetailContent>
<Class>1.1</Class>
<Weight>2.1</Weight>
</QuoteRequestDetailContent>
</Contents>
<Length>5.1</Length>
<Width>6.1</Width>
<Height>7.1</Height>
</QuoteRequestDetail>
<QuoteRequestDetail>
<Units>1</Units>
<PackageType>sample string 2</PackageType>
<Weight>3.1</Weight>
<Class>4.1</Class>
<Contents>
<QuoteRequestDetailContent>
<Class>1.1</Class>
<Weight>2.1</Weight>
</QuoteRequestDetailContent>
<QuoteRequestDetailContent>
<Class>1.1</Class>
<Weight>2.1</Weight>
</QuoteRequestDetailContent>
</Contents>
<Length>5.1</Length>
<Width>6.1</Width>
<Height>7.1</Height>
</QuoteRequestDetail>
</Details>
<Accessorials>
<QuoteRequestAccessorial>
<Code>sample string 1</Code>
<Factor>2.1</Factor>
</QuoteRequestAccessorial>
<QuoteRequestAccessorial>
<Code>sample string 1</Code>
<Factor>2.1</Factor>
</QuoteRequestAccessorial>
</Accessorials>
</QuoteRequest>
Response Information
Resource Description
Quote| Name | Description | Type | Additional information |
|---|---|---|---|
| QuoteNum |
Quote number |
string |
None. |
| QuoteDate |
The date the quote was given |
date |
None. |
| QuoteExpiryDate |
The quote will expire after this date |
date |
None. |
| PickupDate |
Date the shipment will be picked up |
date |
None. |
| EarliestDeliveryDate |
Earliest possible delivery date (estimated) |
date |
None. |
| Orig |
Origin zone id |
string |
None. |
| OrigServicePoint |
Origin service point |
ServicePoint |
None. |
| Dest |
Destination zone id |
string |
None. |
| DestServicePoint |
Destination service point |
ServicePoint |
None. |
| Details |
Freight characteristics |
Collection of QuoteDetail |
None. |
| SubCharge |
Total BaseCharge of all detail lines |
decimal number |
None. |
| MinCharge |
Highest MinCharge of all detail lines |
decimal number |
None. |
| MaxCharge |
Lowest MaxCharge of all detail lines |
decimal number |
None. |
| BaseCharge |
Base charges (MinCharge < BaseCharge < MaxCharge) |
decimal number |
None. |
| FuelInfo |
Fuel surcharge details |
FuelInfo |
None. |
| FuelRate |
Fuel surcharge percentage |
decimal number |
None. |
| FuelCharge |
Fuel surcharge (BaseCharge * FuelRate) |
decimal number |
None. |
| HighCostCharge |
High cost surcharge |
decimal number |
None. |
| Accessorials |
Accessorial services and fees |
Collection of QuoteAccessorial |
None. |
| AccessorialCharge |
Total of Charge of all accessorials |
decimal number |
None. |
| TotalCharge |
Total charge (BaseCharge + FuelCharge + HiCostCharge + AccessorialCharge) |
decimal number |
None. |
| Message |
Informational message |
string |
None. |
| Disclaimer |
Disclaimer |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"QuoteNum": "sample string 1",
"QuoteDate": "0001-01-01T00:00:00",
"QuoteExpiryDate": "0001-01-31T00:00:00",
"PickupDate": "2024-11-20T21:12:25.9924055-06:00",
"EarliestDeliveryDate": "2024-11-20T21:12:25.9924055-06:00",
"Orig": "sample string 6",
"OrigServicePoint": {
"ZoneId": "sample string 1",
"City": "sample string 2",
"State": "sample string 3",
"Zip": "sample string 4",
"BaseZip": "sample string 5",
"Country": "sample string 6",
"Terminal": "sample string 7",
"ServiceType": "sample string 9",
"ServiceDays": "sample string 10",
"CutoffTime": "sample string 11",
"ServiceTime": "sample string 12",
"HighCostCharge": 14.1,
"HighCostMinimum": 15.1,
"HighCostPerLb": 16.1
},
"Dest": "sample string 7",
"DestServicePoint": {
"ZoneId": "sample string 1",
"City": "sample string 2",
"State": "sample string 3",
"Zip": "sample string 4",
"BaseZip": "sample string 5",
"Country": "sample string 6",
"Terminal": "sample string 7",
"ServiceType": "sample string 9",
"ServiceDays": "sample string 10",
"CutoffTime": "sample string 11",
"ServiceTime": "sample string 12",
"HighCostCharge": 14.1,
"HighCostMinimum": 15.1,
"HighCostPerLb": 16.1
},
"Details": [
{
"Units": 1,
"PackageType": "sample string 2",
"Weight": 3.1,
"Class": 4.1,
"Contents": [
{
"Class": 1.1,
"Weight": 2.1
},
{
"Class": 1.1,
"Weight": 2.1
}
],
"Length": 5.1,
"Width": 6.1,
"Height": 7.1,
"Area": 8.1,
"Cube": 9.1,
"Density": 10.1,
"TariffId": "sample string 11",
"TariffName": "sample string 12",
"Factor": 13.1,
"Rate": 14.1,
"Deficit": true,
"DeficitRate": 16.1,
"DeficitCharge": 210.91000000000003,
"SubCharge": 184.70999999999998,
"DiscountRate": 19.1,
"DiscountCharge": 3527.961,
"BaseCharge": -3343.2509999999997,
"SubMinCharges": [
1.1,
2.1
],
"AbsMinCharges": [
1.1,
2.1
],
"MinCharge": 2.1
},
{
"Units": 1,
"PackageType": "sample string 2",
"Weight": 3.1,
"Class": 4.1,
"Contents": [
{
"Class": 1.1,
"Weight": 2.1
},
{
"Class": 1.1,
"Weight": 2.1
}
],
"Length": 5.1,
"Width": 6.1,
"Height": 7.1,
"Area": 8.1,
"Cube": 9.1,
"Density": 10.1,
"TariffId": "sample string 11",
"TariffName": "sample string 12",
"Factor": 13.1,
"Rate": 14.1,
"Deficit": true,
"DeficitRate": 16.1,
"DeficitCharge": 210.91000000000003,
"SubCharge": 184.70999999999998,
"DiscountRate": 19.1,
"DiscountCharge": 3527.961,
"BaseCharge": -3343.2509999999997,
"SubMinCharges": [
1.1,
2.1
],
"AbsMinCharges": [
1.1,
2.1
],
"MinCharge": 2.1
}
],
"SubCharge": -6686.5,
"MinCharge": 2.1,
"MaxCharge": 0.0,
"BaseCharge": 2.1,
"FuelInfo": {
"Code": "sample string 1",
"Effective": "2024-11-20T21:12:25.9924055-06:00",
"Index": "sample string 3",
"Price": 4.1,
"Rate": 5.1
},
"FuelRate": 5.1,
"FuelCharge": 10.71,
"HighCostCharge": 28.2,
"Accessorials": [
{
"Code": "sample string 1",
"Factor": 2.1,
"Accessorial": {
"Code": "sample string 1",
"CodeName": "sample string 2",
"Description": "sample string 3",
"Calculation": "sample string 4",
"CustomRates": true
},
"SubTotal": 14.91,
"Charge": 9.1
},
{
"Code": "sample string 1",
"Factor": 2.1,
"Accessorial": {
"Code": "sample string 1",
"CodeName": "sample string 2",
"Description": "sample string 3",
"Calculation": "sample string 4",
"CustomRates": true
},
"SubTotal": 14.91,
"Charge": 9.1
}
],
"AccessorialCharge": 18.2,
"TotalCharge": 59.21,
"Message": "sample string 17",
"Disclaimer": "sample string 18"
}
application/xml, text/xml
Sample:
<Quote xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<QuoteNum>sample string 1</QuoteNum>
<QuoteDate>0001-01-01T00:00:00</QuoteDate>
<QuoteExpiryDate>0001-01-31T00:00:00</QuoteExpiryDate>
<PickupDate>2024-11-20T21:12:25.9924055-06:00</PickupDate>
<EarliestDeliveryDate>2024-11-20T21:12:25.9924055-06:00</EarliestDeliveryDate>
<Orig>sample string 6</Orig>
<OrigServicePoint>
<ZoneId>sample string 1</ZoneId>
<City>sample string 2</City>
<State>sample string 3</State>
<Zip>sample string 4</Zip>
<BaseZip>sample string 5</BaseZip>
<Country>sample string 6</Country>
<Terminal>sample string 7</Terminal>
<ServiceType>sample string 9</ServiceType>
<ServiceDays>sample string 10</ServiceDays>
<CutoffTime>sample string 11</CutoffTime>
<ServiceTime>sample string 12</ServiceTime>
<HighCostCharge>14.1</HighCostCharge>
<HighCostMinimum>15.1</HighCostMinimum>
<HighCostPerLb>16.1</HighCostPerLb>
</OrigServicePoint>
<Dest>sample string 7</Dest>
<DestServicePoint>
<ZoneId>sample string 1</ZoneId>
<City>sample string 2</City>
<State>sample string 3</State>
<Zip>sample string 4</Zip>
<BaseZip>sample string 5</BaseZip>
<Country>sample string 6</Country>
<Terminal>sample string 7</Terminal>
<ServiceType>sample string 9</ServiceType>
<ServiceDays>sample string 10</ServiceDays>
<CutoffTime>sample string 11</CutoffTime>
<ServiceTime>sample string 12</ServiceTime>
<HighCostCharge>14.1</HighCostCharge>
<HighCostMinimum>15.1</HighCostMinimum>
<HighCostPerLb>16.1</HighCostPerLb>
</DestServicePoint>
<Details>
<QuoteDetail>
<Units>1</Units>
<PackageType>sample string 2</PackageType>
<Weight>3.1</Weight>
<Class>4.1</Class>
<Contents>
<QuoteDetailContent>
<Class>1.1</Class>
<Weight>2.1</Weight>
</QuoteDetailContent>
<QuoteDetailContent>
<Class>1.1</Class>
<Weight>2.1</Weight>
</QuoteDetailContent>
</Contents>
<Length>5.1</Length>
<Width>6.1</Width>
<Height>7.1</Height>
<Area>8.1</Area>
<Cube>9.1</Cube>
<Density>10.1</Density>
<TariffId>sample string 11</TariffId>
<TariffName>sample string 12</TariffName>
<Factor>13.1</Factor>
<Rate>14.1</Rate>
<Deficit>true</Deficit>
<DeficitRate>16.1</DeficitRate>
<DeficitCharge>210.91000000000003</DeficitCharge>
<SubCharge>184.70999999999998</SubCharge>
<DiscountRate>19.1</DiscountRate>
<DiscountCharge>3527.961</DiscountCharge>
<BaseCharge>-3343.2509999999997</BaseCharge>
<SubMinCharges xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:double>1.1</d4p1:double>
<d4p1:double>2.1</d4p1:double>
</SubMinCharges>
<AbsMinCharges xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:double>1.1</d4p1:double>
<d4p1:double>2.1</d4p1:double>
</AbsMinCharges>
<MinCharge>2.1</MinCharge>
</QuoteDetail>
<QuoteDetail>
<Units>1</Units>
<PackageType>sample string 2</PackageType>
<Weight>3.1</Weight>
<Class>4.1</Class>
<Contents>
<QuoteDetailContent>
<Class>1.1</Class>
<Weight>2.1</Weight>
</QuoteDetailContent>
<QuoteDetailContent>
<Class>1.1</Class>
<Weight>2.1</Weight>
</QuoteDetailContent>
</Contents>
<Length>5.1</Length>
<Width>6.1</Width>
<Height>7.1</Height>
<Area>8.1</Area>
<Cube>9.1</Cube>
<Density>10.1</Density>
<TariffId>sample string 11</TariffId>
<TariffName>sample string 12</TariffName>
<Factor>13.1</Factor>
<Rate>14.1</Rate>
<Deficit>true</Deficit>
<DeficitRate>16.1</DeficitRate>
<DeficitCharge>210.91000000000003</DeficitCharge>
<SubCharge>184.70999999999998</SubCharge>
<DiscountRate>19.1</DiscountRate>
<DiscountCharge>3527.961</DiscountCharge>
<BaseCharge>-3343.2509999999997</BaseCharge>
<SubMinCharges xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:double>1.1</d4p1:double>
<d4p1:double>2.1</d4p1:double>
</SubMinCharges>
<AbsMinCharges xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:double>1.1</d4p1:double>
<d4p1:double>2.1</d4p1:double>
</AbsMinCharges>
<MinCharge>2.1</MinCharge>
</QuoteDetail>
</Details>
<SubCharge>-6686.5</SubCharge>
<MinCharge>2.1</MinCharge>
<MaxCharge>0</MaxCharge>
<BaseCharge>2.1</BaseCharge>
<FuelInfo>
<Code>sample string 1</Code>
<Effective>2024-11-20T21:12:25.9924055-06:00</Effective>
<Index>sample string 3</Index>
<Price>4.1</Price>
<Rate>5.1</Rate>
</FuelInfo>
<FuelRate>5.1</FuelRate>
<FuelCharge>10.71</FuelCharge>
<HighCostCharge>28.2</HighCostCharge>
<Accessorials>
<QuoteAccessorial>
<Code>sample string 1</Code>
<Factor>2.1</Factor>
<Accessorial>
<Code>sample string 1</Code>
<CodeName>sample string 2</CodeName>
<Description>sample string 3</Description>
<Calculation>sample string 4</Calculation>
<CustomRates>true</CustomRates>
</Accessorial>
<SubTotal>14.91</SubTotal>
<Charge>9.1</Charge>
</QuoteAccessorial>
<QuoteAccessorial>
<Code>sample string 1</Code>
<Factor>2.1</Factor>
<Accessorial>
<Code>sample string 1</Code>
<CodeName>sample string 2</CodeName>
<Description>sample string 3</Description>
<Calculation>sample string 4</Calculation>
<CustomRates>true</CustomRates>
</Accessorial>
<SubTotal>14.91</SubTotal>
<Charge>9.1</Charge>
</QuoteAccessorial>
</Accessorials>
<AccessorialCharge>18.2</AccessorialCharge>
<TotalCharge>59.21</TotalCharge>
<Message>sample string 17</Message>
<Disclaimer>sample string 18</Disclaimer>
</Quote>