POST api/shipping/rateshop
Requests rates for rate comparision between services and providers.
Request Information
URI Parameters
None.
Body Parameters
A structure describing the shipment to rate shop.
ShipmentRateShopRequestName | Description | Type | Additional information |
---|---|---|---|
ShippingMethod |
How is the shipment to be rate shopped. |
ShippingMethod |
Required Range: inclusive between 96 and 99 |
OverrideShippingProfileId |
Desired alternate shipping profile id. Null will use default profile. |
integer |
Minimum value: 1 |
CompanyId |
Represents the Id of the company the shipment is for. |
integer |
Required Minimum value: 1 |
PricingSheetId |
Represents the Id of the pricing sheet of the company the shipment is for. |
integer |
Minimum value: 1 |
ShopLocationId |
Represents the Id of the ABC Shop Location to ship from. The location must be an AbcShop, FM, or VFM. |
integer |
Minimum value: 1 |
ShipFromAddress |
The address from which to ship if the ShopLocationId is not specified |
Address |
None. |
ShipFromCompany |
The company from which to ship if the ShopLocationId is not specified |
string |
String length: inclusive between 0 and 100 |
ShipFromPhoneNumber |
The phone number of the company to ship from if the ShopLocationId is not specified |
string |
Must be an acceptably formed phone number String length: inclusive between 1 and 32 |
RateForReturnLabel |
Get rates as if for a return shipment from the ShipFromAddress to the ShipToAddress. |
boolean |
None. |
Packages |
Represents the packages belonging to this shipment. |
Collection of ShipmentRateShopPackage |
Minimum Count: 1 |
ShippingServiceCode |
Indicates the specific shipping service for the shipping method. |
string |
Required String length: inclusive between 1 and 50 |
ShipToCompany |
The company the shipment is being shipped to. |
string |
String length: inclusive between 0 and 100 |
ShipToAttention |
The person who the shipment is shipped to. |
string |
Required String length: inclusive between 1 and 100 |
ShipToAddress |
The address to ship to. This address will override ShipToLocationId and ShipToAddressBookEntryId. |
Address |
None. |
ShipToPhoneNumber |
The phone number of the recipient of the shipment. |
string |
Required String length: inclusive between 1 and 32 |
ShipToLocationId |
Indentifying Id for the customer's location to ship to. |
integer |
Minimum value: 1 |
ShipToAddressBookEntryId |
Indentifying Id for the customer's address book entry to ship to. This will override ShipToLocationId. |
integer |
Minimum value: 1 |
ShipToIsResidential |
Indicates of the shipment is going to a residential address. |
boolean |
None. |
SaturdayDelivery |
Is Saturday Delivery requested for the shipment. |
boolean |
Default value is False |
SignatureRequired |
Is a signature required for the shipment. |
boolean |
Default value is False |
Request Formats
application/json, text/json
{ "ShippingMethod": 1, "OverrideShippingProfileId": 1, "CompanyId": 1, "PricingSheetId": 1, "ShopLocationId": 1, "ShipFromAddress": { "Street1": "sample string 1", "Street2": "sample string 2", "City": "sample string 3", "Region": "sample string 4", "Postalcode": "sample string 5", "PostalZip4": "sample string 6", "CountryCode": "sample string 7" }, "ShipFromCompany": "sample string 2", "ShipFromPhoneNumber": "sample string 3", "RateForReturnLabel": true, "Packages": [ { "ReferenceId": 1, "PackageTypeCode": "sample string 1", "EstimatedWeightInPounds": 1.1, "EstimatedHeightInInches": 1.1, "EstimatedWidthInInches": 1.1, "EstimatedLengthInInches": 1.1, "EstimatedDeclaredValue": 1.0 }, { "ReferenceId": 1, "PackageTypeCode": "sample string 1", "EstimatedWeightInPounds": 1.1, "EstimatedHeightInInches": 1.1, "EstimatedWidthInInches": 1.1, "EstimatedLengthInInches": 1.1, "EstimatedDeclaredValue": 1.0 } ], "ShippingServiceCode": "sample string 5", "ShipToCompany": "sample string 6", "ShipToAttention": "sample string 7", "ShipToAddress": { "Street1": "sample string 1", "Street2": "sample string 2", "City": "sample string 3", "Region": "sample string 4", "Postalcode": "sample string 5", "PostalZip4": "sample string 6", "CountryCode": "sample string 7" }, "ShipToPhoneNumber": "sample string 8", "ShipToLocationId": 1, "ShipToAddressBookEntryId": 1, "ShipToIsResidential": true, "SaturdayDelivery": true, "SignatureRequired": true }
application/xml, text/xml
<ShipmentRateShopRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ShippingMethod>Ups</ShippingMethod> <ShippingServiceCode>sample string 5</ShippingServiceCode> <ShipToCompany>sample string 6</ShipToCompany> <ShipToAttention>sample string 7</ShipToAttention> <ShipToAddress> <Street1>sample string 1</Street1> <Street2>sample string 2</Street2> <City>sample string 3</City> <Region>sample string 4</Region> <Postalcode>sample string 5</Postalcode> <PostalZip4>sample string 6</PostalZip4> <CountryCode>sample string 7</CountryCode> </ShipToAddress> <ShipToPhoneNumber>sample string 8</ShipToPhoneNumber> <ShipToLocationId>1</ShipToLocationId> <ShipToAddressBookEntryId>1</ShipToAddressBookEntryId> <ShipToIsResidential>true</ShipToIsResidential> <SaturdayDelivery>true</SaturdayDelivery> <SignatureRequired>true</SignatureRequired> <Packages> <ShipmentRateShopPackage> <ReferenceId>1</ReferenceId> <PackageTypeCode>sample string 1</PackageTypeCode> <EstimatedWeightInPounds>1.1</EstimatedWeightInPounds> <EstimatedHeightInInches>1.1</EstimatedHeightInInches> <EstimatedWidthInInches>1.1</EstimatedWidthInInches> <EstimatedLengthInInches>1.1</EstimatedLengthInInches> <EstimatedDeclaredValue>1</EstimatedDeclaredValue> </ShipmentRateShopPackage> <ShipmentRateShopPackage> <ReferenceId>1</ReferenceId> <PackageTypeCode>sample string 1</PackageTypeCode> <EstimatedWeightInPounds>1.1</EstimatedWeightInPounds> <EstimatedHeightInInches>1.1</EstimatedHeightInInches> <EstimatedWidthInInches>1.1</EstimatedWidthInInches> <EstimatedLengthInInches>1.1</EstimatedLengthInInches> <EstimatedDeclaredValue>1</EstimatedDeclaredValue> </ShipmentRateShopPackage> </Packages> <OverrideShippingProfileId>1</OverrideShippingProfileId> <CompanyId>1</CompanyId> <PricingSheetId>1</PricingSheetId> <ShopLocationId>1</ShopLocationId> <ShipFromAddress> <Street1>sample string 1</Street1> <Street2>sample string 2</Street2> <City>sample string 3</City> <Region>sample string 4</Region> <Postalcode>sample string 5</Postalcode> <PostalZip4>sample string 6</PostalZip4> <CountryCode>sample string 7</CountryCode> </ShipFromAddress> <ShipFromCompany>sample string 2</ShipFromCompany> <ShipFromPhoneNumber>sample string 3</ShipFromPhoneNumber> <RateForReturnLabel>true</RateForReturnLabel> </ShipmentRateShopRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
A structure describing the different shipping options.
ShipmentRateShopResponseName | Description | Type | Additional information |
---|---|---|---|
RateShopData |
The specifics of the rate shopping. |
Collection of RateShopInfo |
None. |
Response Formats
application/json, text/json
{ "RateShopData": [ { "ShippingMethod": 1, "ShippingServiceDescription": "sample string 1", "ShippingServiceCode": "sample string 2", "ShippingServiceSupportsCustomData": true, "ShippingServiceSupportsCustomDataHeader": true, "EstimatedDeliveryTimeInDays": "sample string 5", "ShippingCostNatural": 6.0, "ShippingCostNaturalDisplay": "sample string 7", "Packages": [ { "ReferenceId": 1, "PackageTypeDescription": "sample string 2", "PackageTypeCode": "sample string 3", "HeightInInches": 4.0, "LengthInInches": 5.0, "WidthInInches": 6.0, "WeightInPounds": 7.0, "DeclaredValue": 1.0 }, { "ReferenceId": 1, "PackageTypeDescription": "sample string 2", "PackageTypeCode": "sample string 3", "HeightInInches": 4.0, "LengthInInches": 5.0, "WidthInInches": 6.0, "WeightInPounds": 7.0, "DeclaredValue": 1.0 } ] }, { "ShippingMethod": 1, "ShippingServiceDescription": "sample string 1", "ShippingServiceCode": "sample string 2", "ShippingServiceSupportsCustomData": true, "ShippingServiceSupportsCustomDataHeader": true, "EstimatedDeliveryTimeInDays": "sample string 5", "ShippingCostNatural": 6.0, "ShippingCostNaturalDisplay": "sample string 7", "Packages": [ { "ReferenceId": 1, "PackageTypeDescription": "sample string 2", "PackageTypeCode": "sample string 3", "HeightInInches": 4.0, "LengthInInches": 5.0, "WidthInInches": 6.0, "WeightInPounds": 7.0, "DeclaredValue": 1.0 }, { "ReferenceId": 1, "PackageTypeDescription": "sample string 2", "PackageTypeCode": "sample string 3", "HeightInInches": 4.0, "LengthInInches": 5.0, "WidthInInches": 6.0, "WeightInPounds": 7.0, "DeclaredValue": 1.0 } ] } ] }
application/xml, text/xml
<ShipmentRateShopResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <RateShopData> <RateShopInfo> <ShippingMethod>Ups</ShippingMethod> <ShippingServiceDescription>sample string 1</ShippingServiceDescription> <ShippingServiceCode>sample string 2</ShippingServiceCode> <ShippingServiceSupportsCustomData>true</ShippingServiceSupportsCustomData> <ShippingServiceSupportsCustomDataHeader>true</ShippingServiceSupportsCustomDataHeader> <EstimatedDeliveryTimeInDays>sample string 5</EstimatedDeliveryTimeInDays> <ShippingCostNatural>6</ShippingCostNatural> <ShippingCostNaturalDisplay>sample string 7</ShippingCostNaturalDisplay> <Packages> <RateShopPackageDetail> <ReferenceId>1</ReferenceId> <PackageTypeDescription>sample string 2</PackageTypeDescription> <PackageTypeCode>sample string 3</PackageTypeCode> <HeightInInches>4</HeightInInches> <LengthInInches>5</LengthInInches> <WidthInInches>6</WidthInInches> <WeightInPounds>7</WeightInPounds> <DeclaredValue>1</DeclaredValue> </RateShopPackageDetail> <RateShopPackageDetail> <ReferenceId>1</ReferenceId> <PackageTypeDescription>sample string 2</PackageTypeDescription> <PackageTypeCode>sample string 3</PackageTypeCode> <HeightInInches>4</HeightInInches> <LengthInInches>5</LengthInInches> <WidthInInches>6</WidthInInches> <WeightInPounds>7</WeightInPounds> <DeclaredValue>1</DeclaredValue> </RateShopPackageDetail> </Packages> </RateShopInfo> <RateShopInfo> <ShippingMethod>Ups</ShippingMethod> <ShippingServiceDescription>sample string 1</ShippingServiceDescription> <ShippingServiceCode>sample string 2</ShippingServiceCode> <ShippingServiceSupportsCustomData>true</ShippingServiceSupportsCustomData> <ShippingServiceSupportsCustomDataHeader>true</ShippingServiceSupportsCustomDataHeader> <EstimatedDeliveryTimeInDays>sample string 5</EstimatedDeliveryTimeInDays> <ShippingCostNatural>6</ShippingCostNatural> <ShippingCostNaturalDisplay>sample string 7</ShippingCostNaturalDisplay> <Packages> <RateShopPackageDetail> <ReferenceId>1</ReferenceId> <PackageTypeDescription>sample string 2</PackageTypeDescription> <PackageTypeCode>sample string 3</PackageTypeCode> <HeightInInches>4</HeightInInches> <LengthInInches>5</LengthInInches> <WidthInInches>6</WidthInInches> <WeightInPounds>7</WeightInPounds> <DeclaredValue>1</DeclaredValue> </RateShopPackageDetail> <RateShopPackageDetail> <ReferenceId>1</ReferenceId> <PackageTypeDescription>sample string 2</PackageTypeDescription> <PackageTypeCode>sample string 3</PackageTypeCode> <HeightInInches>4</HeightInInches> <LengthInInches>5</LengthInInches> <WidthInInches>6</WidthInInches> <WeightInPounds>7</WeightInPounds> <DeclaredValue>1</DeclaredValue> </RateShopPackageDetail> </Packages> </RateShopInfo> </RateShopData> </ShipmentRateShopResponse>