ShipmentRates
Returns the list of available rates for the specified shipment.
View-Specific Information
Select
The provider 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 provider.
- ShipmentId supports the following operator: =.
- CreatedAt supports the following operators: >,>=.
SELECT * FROM ShipmentRates WHERE ShipmentId = 'se-1234'
SELECT * FROM ShipmentRates WHERE CreatedAt >= '2024-11-13T23:47:25.293-05:00'
Columns
| Name | Type | References | Description |
| RateId [KEY] | String | A string that uniquely identifies the rate. | |
| ShipmentId | String |
Shipments.Id | The Id of the shipment associated with this rate. |
| RateType | String | The type of rate estimate. | |
| CarrierId | String |
Carriers.Id | A string that uniquely identifies the carrier. |
| CarrierCode | String | A shipping carrier, such as fedex, dhl_express, stamps_com, etc. | |
| CarrierNickname | String | The nickname for the carrier account. | |
| CarrierFriendlyName | String | The friendly name of the carrier. | |
| ServiceCode | String | A carrier service, such as usps_first_class_mail, fedex_ground, etc. | |
| ServiceType | String | The service type for the rate. | |
| PackageType | String | The package type for the rate. | |
| Zone | Integer | The shipping zone for the rate. | |
| DeliveryDays | Integer | The estimated number of days to delivery. | |
| CarrierDeliveryDays | Integer | The carrier's delivery days estimate. | |
| GuaranteedService | Boolean | Indicates whether the delivery date is guaranteed. | |
| EstimatedDeliveryDate | Datetime | The estimated delivery date. | |
| ShipDate | Datetime | The ship date for the rate estimate. | |
| NegotiatedRate | Boolean | Indicates whether the rate is a negotiated rate. | |
| Trackable | Boolean | Indicates whether the shipment is trackable at this service level. | |
| ValidationStatus | String | The validation status of the rate. | |
| ShippingAmountCurrency | String | The currency of the shipping cost. | |
| ShippingAmount | Decimal | The shipping cost amount. | |
| InsuranceAmountCurrency | String | The currency of the insurance cost. | |
| InsuranceAmount | Decimal | The insurance cost amount. | |
| ConfirmationAmountCurrency | String | The currency of the confirmation cost. | |
| ConfirmationAmount | Decimal | The confirmation cost amount. | |
| OtherAmountCurrency | String | The currency of the other fees. | |
| OtherAmount | Decimal | The other fees amount. | |
| RequestedComparisonAmountCurrency | String | The currency of the requested comparison amount. | |
| RequestedComparisonAmount | Decimal | The requested comparison amount. | |
| TaxAmountCurrency | String | The currency of the tax amount. | |
| TaxAmount | Decimal | The tax amount. | |
| WarningMessages | String | Warning messages returned with the rate. | |
| ErrorMessages | String | Error messages returned with the rate. | |
| RateDetails | String | A breakdown of individual charges that make up this rate. | |
| CreatedAt | Datetime | The date and time the rate request was created. | |
| RateRequestId | String | A string that uniquely identifies the rate request. | |
| Status | String | The current status of the rate response. |