POST api/client/ShippingRates
Retrieves client specific shipping rates from ISC. Can include custom origin addresses.
Request Information
URI Parameters
None.
Body Parameters
ShippingRate_Request| Name | Description | Type | Additional information |
|---|---|---|---|
| Rate | Rate |
Required |
Request Formats
application/json, text/json
Sample:
{
"Rate": {
"origin": {
"country": "sample string 1",
"postal_code": "sample string 3",
"province": "sample string 4",
"city": "sample string 5",
"name": "sample string 6",
"address1": "sample string 7",
"address2": "sample string 8",
"address3": "sample string 9",
"phone": "sample string 10",
"fax": "sample string 11",
"email": "sample string 12",
"address_type": "sample string 13",
"company_name": "sample string 14"
},
"destination": {
"country": "sample string 1",
"postal_code": "sample string 3",
"province": "sample string 4",
"city": "sample string 5",
"name": "sample string 6",
"address1": "sample string 7",
"address2": "sample string 8",
"address3": "sample string 9",
"phone": "sample string 10",
"fax": "sample string 11",
"email": "sample string 12",
"address_type": "sample string 13",
"company_name": "sample string 14"
},
"packages": [
{
"package_id": "sample string 1",
"lbs": 2.0,
"length": 3.0,
"width": 4.0,
"height": 5.0,
"freight_class_id": 6,
"nmfc": "sample string 7",
"pieces": 8,
"packaging_type_id": 9,
"description": "sample string 10",
"handling_quantity": 11,
"is_hazmat": true,
"hazmat_un_number": "sample string 13",
"hazmat_packing_group": "sample string 14",
"hazmat_hazard_classes": [
"sample string 1",
"sample string 2"
]
},
{
"package_id": "sample string 1",
"lbs": 2.0,
"length": 3.0,
"width": 4.0,
"height": 5.0,
"freight_class_id": 6,
"nmfc": "sample string 7",
"pieces": 8,
"packaging_type_id": 9,
"description": "sample string 10",
"handling_quantity": 11,
"is_hazmat": true,
"hazmat_un_number": "sample string 13",
"hazmat_packing_group": "sample string 14",
"hazmat_hazard_classes": [
"sample string 1",
"sample string 2"
]
}
],
"items": [
{
"name": "sample string 1",
"sku": "sample string 2",
"quantity": 3,
"lbs": 1.0,
"grams": 1,
"price_usd": 1.1,
"price": 1,
"vendor": "sample string 4",
"requires_shipping": true,
"taxable": true,
"fulfillment_service": "sample string 7",
"properties": {},
"product_id": "sample string 9",
"variant_id": "sample string 10",
"hazmat": true
},
{
"name": "sample string 1",
"sku": "sample string 2",
"quantity": 3,
"lbs": 1.0,
"grams": 1,
"price_usd": 1.1,
"price": 1,
"vendor": "sample string 4",
"requires_shipping": true,
"taxable": true,
"fulfillment_service": "sample string 7",
"properties": {},
"product_id": "sample string 9",
"variant_id": "sample string 10",
"hazmat": true
}
],
"currency": "sample string 1",
"locale": "sample string 2",
"insurance_amount": 1.1,
"ShippingOptions": {
"ParcelOptions": {
"OverrideValidation": true,
"DutyTerm": "sample string 2",
"Signature": "sample string 3"
},
"LTLOptions": {
"OriginAccessorials": [
1,
2
],
"DestinationAccessorials": [
1,
2
],
"UnitStackable": true,
"OriginFacilityType": 4,
"DestinationFacilityType": 5,
"OriginSpecialInstructions": "sample string 6",
"DestinationSpecialInstructions": "sample string 7",
"ReadyTime": "2026-02-03T13:51:32.2678234+00:00",
"CloseTime": "2026-02-03T13:51:32.2678234+00:00",
"DestinationReadyTime": "2026-02-03T13:51:32.2678234+00:00",
"DestinationCloseTime": "2026-02-03T13:51:32.2678234+00:00"
},
"IncludeParcelRates": true,
"IncludeFreightRates": true,
"FromBatchPrint": true
},
"OrderId": 3,
"CreateQuoteId": true,
"IsReturnLabel": true
}
}
application/xml, text/xml
Sample:
<ShippingRate_Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCAPI2.Models">
<Rate>
<CreateQuoteId>true</CreateQuoteId>
<IsReturnLabel>true</IsReturnLabel>
<OrderId>3</OrderId>
<ShippingOptions xmlns:d3p1="http://schemas.datacontract.org/2004/07/ISCAPI2.Controllers">
<d3p1:FromBatchPrint>true</d3p1:FromBatchPrint>
<d3p1:IncludeFreightRates>true</d3p1:IncludeFreightRates>
<d3p1:IncludeParcelRates>true</d3p1:IncludeParcelRates>
<d3p1:LTLOptions>
<d3p1:AutoCalculatedClass>sample string 13</d3p1:AutoCalculatedClass>
<d3p1:AutoCalculatedHeight>14</d3p1:AutoCalculatedHeight>
<d3p1:AutoCalculatedWeight>15</d3p1:AutoCalculatedWeight>
<d3p1:AutoHandlingQuantity>17</d3p1:AutoHandlingQuantity>
<d3p1:AutoNMFC>sample string 12</d3p1:AutoNMFC>
<d3p1:AutoPalletLength>10</d3p1:AutoPalletLength>
<d3p1:AutoPalletWeight>9</d3p1:AutoPalletWeight>
<d3p1:AutoPalletWidth>11</d3p1:AutoPalletWidth>
<d3p1:AutoPieces>16</d3p1:AutoPieces>
<d3p1:AutoStack>true</d3p1:AutoStack>
<d3p1:CarrierSCAC>sample string 1</d3p1:CarrierSCAC>
<d3p1:CloseTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-02-03T13:51:32.2678234Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</d3p1:CloseTime>
<d3p1:DestinationAccessorials xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>1</d5p1:int>
<d5p1:int>2</d5p1:int>
</d3p1:DestinationAccessorials>
<d3p1:DestinationCloseTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-02-03T13:51:32.2678234Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</d3p1:DestinationCloseTime>
<d3p1:DestinationFacilityType>5</d3p1:DestinationFacilityType>
<d3p1:DestinationReadyTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-02-03T13:51:32.2678234Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</d3p1:DestinationReadyTime>
<d3p1:DestinationSpecialInstructions>sample string 7</d3p1:DestinationSpecialInstructions>
<d3p1:OriginAccessorials xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>1</d5p1:int>
<d5p1:int>2</d5p1:int>
</d3p1:OriginAccessorials>
<d3p1:OriginFacilityType>4</d3p1:OriginFacilityType>
<d3p1:OriginSpecialInstructions>sample string 6</d3p1:OriginSpecialInstructions>
<d3p1:QuoteId>sample string 18</d3p1:QuoteId>
<d3p1:RateQuoteAmount>3</d3p1:RateQuoteAmount>
<d3p1:ReadyTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2026-02-03T13:51:32.2678234Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</d3p1:ReadyTime>
<d3p1:UnitStackable>true</d3p1:UnitStackable>
</d3p1:LTLOptions>
<d3p1:ParcelOptions>
<d3p1:DutyTerm>sample string 2</d3p1:DutyTerm>
<d3p1:OverrideValidation>true</d3p1:OverrideValidation>
<d3p1:Signature>sample string 3</d3p1:Signature>
</d3p1:ParcelOptions>
<d3p1:ShippingQuoteId>3</d3p1:ShippingQuoteId>
</ShippingOptions>
<currency>sample string 1</currency>
<destination>
<address1>sample string 7</address1>
<address2>sample string 8</address2>
<address3>sample string 9</address3>
<address_type>sample string 13</address_type>
<city>sample string 5</city>
<company_name>sample string 14</company_name>
<country>sample string 1</country>
<country3>sample string 2</country3>
<email>sample string 12</email>
<fax>sample string 11</fax>
<name>sample string 6</name>
<phone>sample string 10</phone>
<postal_code>sample string 3</postal_code>
<province>sample string 4</province>
</destination>
<insurance_amount>1.1</insurance_amount>
<items>
<ShippingRate_Item>
<fulfillment_service>sample string 7</fulfillment_service>
<grams>1</grams>
<hazmat>true</hazmat>
<lbs>1</lbs>
<name>sample string 1</name>
<price>1</price>
<price_usd>1.1</price_usd>
<product_id>sample string 9</product_id>
<properties />
<quantity>3</quantity>
<requires_shipping>true</requires_shipping>
<sku>sample string 2</sku>
<taxable>true</taxable>
<variant_id>sample string 10</variant_id>
<vendor>sample string 4</vendor>
</ShippingRate_Item>
<ShippingRate_Item>
<fulfillment_service>sample string 7</fulfillment_service>
<grams>1</grams>
<hazmat>true</hazmat>
<lbs>1</lbs>
<name>sample string 1</name>
<price>1</price>
<price_usd>1.1</price_usd>
<product_id>sample string 9</product_id>
<properties />
<quantity>3</quantity>
<requires_shipping>true</requires_shipping>
<sku>sample string 2</sku>
<taxable>true</taxable>
<variant_id>sample string 10</variant_id>
<vendor>sample string 4</vendor>
</ShippingRate_Item>
</items>
<locale>sample string 2</locale>
<origin>
<address1>sample string 7</address1>
<address2>sample string 8</address2>
<address3>sample string 9</address3>
<address_type>sample string 13</address_type>
<city>sample string 5</city>
<company_name>sample string 14</company_name>
<country>sample string 1</country>
<country3>sample string 2</country3>
<email>sample string 12</email>
<fax>sample string 11</fax>
<name>sample string 6</name>
<phone>sample string 10</phone>
<postal_code>sample string 3</postal_code>
<province>sample string 4</province>
</origin>
<packages>
<ShippingRate_Package>
<description>sample string 10</description>
<freight_class_id>6</freight_class_id>
<handling_quantity>11</handling_quantity>
<hazmat_hazard_classes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</hazmat_hazard_classes>
<hazmat_packing_group>sample string 14</hazmat_packing_group>
<hazmat_un_number>sample string 13</hazmat_un_number>
<height>5</height>
<is_hazmat>true</is_hazmat>
<lbs>2</lbs>
<length>3</length>
<nmfc>sample string 7</nmfc>
<package_id>sample string 1</package_id>
<packaging_type_id>9</packaging_type_id>
<pieces>8</pieces>
<width>4</width>
</ShippingRate_Package>
<ShippingRate_Package>
<description>sample string 10</description>
<freight_class_id>6</freight_class_id>
<handling_quantity>11</handling_quantity>
<hazmat_hazard_classes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</hazmat_hazard_classes>
<hazmat_packing_group>sample string 14</hazmat_packing_group>
<hazmat_un_number>sample string 13</hazmat_un_number>
<height>5</height>
<is_hazmat>true</is_hazmat>
<lbs>2</lbs>
<length>3</length>
<nmfc>sample string 7</nmfc>
<package_id>sample string 1</package_id>
<packaging_type_id>9</packaging_type_id>
<pieces>8</pieces>
<width>4</width>
</ShippingRate_Package>
</packages>
</Rate>
</ShippingRate_Request>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ShippingRate_Response| Name | Description | Type | Additional information |
|---|---|---|---|
| rates | Collection of Rates |
None. |
|
| carrierErrors | Collection of CarrierError |
None. |
|
| orderShippingMethodId | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"rates": [
{
"service_code": "sample string 20",
"service_name": "sample string 21",
"description": "sample string 22",
"currency": "sample string 23",
"total_price_usd": 24.0,
"total_price": 25,
"phone_required": true,
"min_delivery_date": "2026-02-03T13:51:32.2990751+00:00",
"max_delivery_date": "2026-02-03T13:51:32.2990751+00:00",
"quote_id": 29,
"quote_expiration_date": "2026-02-03T13:51:32.2990751+00:00"
},
{
"service_code": "sample string 20",
"service_name": "sample string 21",
"description": "sample string 22",
"currency": "sample string 23",
"total_price_usd": 24.0,
"total_price": 25,
"phone_required": true,
"min_delivery_date": "2026-02-03T13:51:32.2990751+00:00",
"max_delivery_date": "2026-02-03T13:51:32.2990751+00:00",
"quote_id": 29,
"quote_expiration_date": "2026-02-03T13:51:32.2990751+00:00"
}
],
"carrierErrors": [
{
"CarrierCode": "sample string 2",
"Error": "sample string 3"
},
{
"CarrierCode": "sample string 2",
"Error": "sample string 3"
}
],
"orderShippingMethodId": 1
}
application/xml, text/xml
Sample:
<ShippingRate_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCAPI2.Models">
<carrierErrors>
<CarrierError>
<CarrierCode>sample string 2</CarrierCode>
<CarrierId>1</CarrierId>
<Error>sample string 3</Error>
</CarrierError>
<CarrierError>
<CarrierCode>sample string 2</CarrierCode>
<CarrierId>1</CarrierId>
<Error>sample string 3</Error>
</CarrierError>
</carrierErrors>
<orderShippingMethodId>1</orderShippingMethodId>
<rates>
<Rates>
<BillableWeights>
<BillableWeight>
<Height>1</Height>
<Length>1</Length>
<RateAmount>3</RateAmount>
<ShippingLabelId>sample string 1</ShippingLabelId>
<Weight>2</Weight>
<Width>1</Width>
</BillableWeight>
<BillableWeight>
<Height>1</Height>
<Length>1</Length>
<RateAmount>3</RateAmount>
<ShippingLabelId>sample string 1</ShippingLabelId>
<Weight>2</Weight>
<Width>1</Width>
</BillableWeight>
</BillableWeights>
<CarrierCode>sample string 6</CarrierCode>
<CarrierId>5</CarrierId>
<CarrierServiceCode>sample string 7</CarrierServiceCode>
<CarrierShippingMethodId>4</CarrierShippingMethodId>
<DeliveryDate>sample string 18</DeliveryDate>
<LTLVendorId>1</LTLVendorId>
<PackageAccessorials>
<Accessorial>
<Code>sample string 1</Code>
<CurrencyCode>sample string 4</CurrencyCode>
<MonetaryValue>sample string 5</MonetaryValue>
<SubType>sample string 3</SubType>
<Type>sample string 2</Type>
</Accessorial>
<Accessorial>
<Code>sample string 1</Code>
<CurrencyCode>sample string 4</CurrencyCode>
<MonetaryValue>sample string 5</MonetaryValue>
<SubType>sample string 3</SubType>
<Type>sample string 2</Type>
</Accessorial>
</PackageAccessorials>
<RateAmount>12</RateAmount>
<RateAmount_Client>15</RateAmount_Client>
<RateAmount_Fuel>17</RateAmount_Fuel>
<RateAmount_House>13</RateAmount_House>
<RateAmount_Published>16</RateAmount_Published>
<RateAmount_Team>14</RateAmount_Team>
<RateName>sample string 19</RateName>
<ShipmentAccessorials>
<Accessorial>
<Code>sample string 1</Code>
<CurrencyCode>sample string 4</CurrencyCode>
<MonetaryValue>sample string 5</MonetaryValue>
<SubType>sample string 3</SubType>
<Type>sample string 2</Type>
</Accessorial>
<Accessorial>
<Code>sample string 1</Code>
<CurrencyCode>sample string 4</CurrencyCode>
<MonetaryValue>sample string 5</MonetaryValue>
<SubType>sample string 3</SubType>
<Type>sample string 2</Type>
</Accessorial>
</ShipmentAccessorials>
<ShippingMethodCoreId>2</ShippingMethodCoreId>
<ShippingMethodId>1</ShippingMethodId>
<ShippingMethodName>sample string 3</ShippingMethodName>
<Signature>sample string 11</Signature>
<UnitofMeasure>sample string 10</UnitofMeasure>
<Weight>9</Weight>
<Zone>sample string 8</Zone>
<currency>sample string 23</currency>
<description>sample string 22</description>
<external_id>sample string 32</external_id>
<external_quote_id>sample string 31</external_quote_id>
<max_delivery_date>2026-02-03T13:51:32.2990751+00:00</max_delivery_date>
<min_delivery_date>2026-02-03T13:51:32.2990751+00:00</min_delivery_date>
<phone_required>true</phone_required>
<quote_expiration_date>2026-02-03T13:51:32.2990751+00:00</quote_expiration_date>
<quote_id>29</quote_id>
<service_code>sample string 20</service_code>
<service_name>sample string 21</service_name>
<total_price>25</total_price>
<total_price_usd>24</total_price_usd>
</Rates>
<Rates>
<BillableWeights>
<BillableWeight>
<Height>1</Height>
<Length>1</Length>
<RateAmount>3</RateAmount>
<ShippingLabelId>sample string 1</ShippingLabelId>
<Weight>2</Weight>
<Width>1</Width>
</BillableWeight>
<BillableWeight>
<Height>1</Height>
<Length>1</Length>
<RateAmount>3</RateAmount>
<ShippingLabelId>sample string 1</ShippingLabelId>
<Weight>2</Weight>
<Width>1</Width>
</BillableWeight>
</BillableWeights>
<CarrierCode>sample string 6</CarrierCode>
<CarrierId>5</CarrierId>
<CarrierServiceCode>sample string 7</CarrierServiceCode>
<CarrierShippingMethodId>4</CarrierShippingMethodId>
<DeliveryDate>sample string 18</DeliveryDate>
<LTLVendorId>1</LTLVendorId>
<PackageAccessorials>
<Accessorial>
<Code>sample string 1</Code>
<CurrencyCode>sample string 4</CurrencyCode>
<MonetaryValue>sample string 5</MonetaryValue>
<SubType>sample string 3</SubType>
<Type>sample string 2</Type>
</Accessorial>
<Accessorial>
<Code>sample string 1</Code>
<CurrencyCode>sample string 4</CurrencyCode>
<MonetaryValue>sample string 5</MonetaryValue>
<SubType>sample string 3</SubType>
<Type>sample string 2</Type>
</Accessorial>
</PackageAccessorials>
<RateAmount>12</RateAmount>
<RateAmount_Client>15</RateAmount_Client>
<RateAmount_Fuel>17</RateAmount_Fuel>
<RateAmount_House>13</RateAmount_House>
<RateAmount_Published>16</RateAmount_Published>
<RateAmount_Team>14</RateAmount_Team>
<RateName>sample string 19</RateName>
<ShipmentAccessorials>
<Accessorial>
<Code>sample string 1</Code>
<CurrencyCode>sample string 4</CurrencyCode>
<MonetaryValue>sample string 5</MonetaryValue>
<SubType>sample string 3</SubType>
<Type>sample string 2</Type>
</Accessorial>
<Accessorial>
<Code>sample string 1</Code>
<CurrencyCode>sample string 4</CurrencyCode>
<MonetaryValue>sample string 5</MonetaryValue>
<SubType>sample string 3</SubType>
<Type>sample string 2</Type>
</Accessorial>
</ShipmentAccessorials>
<ShippingMethodCoreId>2</ShippingMethodCoreId>
<ShippingMethodId>1</ShippingMethodId>
<ShippingMethodName>sample string 3</ShippingMethodName>
<Signature>sample string 11</Signature>
<UnitofMeasure>sample string 10</UnitofMeasure>
<Weight>9</Weight>
<Zone>sample string 8</Zone>
<currency>sample string 23</currency>
<description>sample string 22</description>
<external_id>sample string 32</external_id>
<external_quote_id>sample string 31</external_quote_id>
<max_delivery_date>2026-02-03T13:51:32.2990751+00:00</max_delivery_date>
<min_delivery_date>2026-02-03T13:51:32.2990751+00:00</min_delivery_date>
<phone_required>true</phone_required>
<quote_expiration_date>2026-02-03T13:51:32.2990751+00:00</quote_expiration_date>
<quote_id>29</quote_id>
<service_code>sample string 20</service_code>
<service_name>sample string 21</service_name>
<total_price>25</total_price>
<total_price_usd>24</total_price_usd>
</Rates>
</rates>
</ShippingRate_Response>