Lists shipping rate estimates.

Select

The add-in will use the ShipStation API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the add-in.

• CarrierCode supports the following operator: =. Required.
• FromPostalCode supports the following operator: =. Required.
• ToCountry supports the following operator: =. Required.
• ToPostalCode supports the following operator: =. Required.
• WeightValue supports the following operator: =. Required.
• ServiceCodeFilter supports the following operator: =.
• PackageCode supports the following operator: =.
• ToState supports the following operator: =.
• ToCity supports the following operator: =.
• WeightUnits supports the following operator: =.
• DimensionUnits supports the following operator: =.
• DimensionLength supports the following operator: =.
• DimensionWidth supports the following operator: =.
• DimensionHeight supports the following operator: =.
• Confirmation supports the following operator: =.
• Residential supports the following operator: =.

For example, the following query is processed server side:

SELECT * FROM Rates WHERE CarrierCode = 'fedex' AND FromPostalCode = '78703' AND ToCountry = 'US' AND ToPostalCode = '20500' AND WeightValue = 3

Columns

Name	Type	References	Description
ServiceCode	String		Unique code for the shipping service.
ServiceName	String		Display name of the shipping service.
ShipmentCost	Double		Base shipping cost for the rate.
OtherCost	Double		Additional charges for the selected rate.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
CarrierCode	String		The carrier code for the rate request.
ServiceCodeFilter	String		The service code for the rate request.
PackageCode	String		The package code for the rate request.
FromPostalCode	String		Originating postal code.
ToState	String		Destination state/province.
ToCountry	String		Destination country code.
ToPostalCode	String		Destination postal code.
ToCity	String		Destination city name.
WeightValue	Double		Weight value of the package.
WeightUnits	String		Weight units (pounds or ounces).
DimensionUnits	String		Dimension units (inches or centimeters).
DimensionLength	Double		Length of the package.
DimensionWidth	Double		Width of the package.
DimensionHeight	Double		Height of the package.
Confirmation	String		The type of delivery confirmation (none, delivery, signature, adult_signature, direct_signature).
Residential	Boolean		Indicates if the destination is residential.