RateShoppers
Returns the list of rate shoppers.
View-Specific Information
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.
- Id and Type support the following operator: =.
SELECT * FROM RateShoppers WHERE Id = 'se-23445'
SELECT * FROM RateShoppers WHERE Type = 'custom'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A string that uniquely identifies the rate shopper. | |
| Name | String | The name of the rate shopper. | |
| IsActive | Boolean | Indicates whether the rate shopper is active. | |
| CreatedAt | Datetime | The date and time the rate shopper was created. | |
| UpdatedAt | Datetime | The date and time the rate shopper was last updated. | |
| TransitTimeMaxDays | Integer | The maximum number of transit days for domestic shipments. | |
| TransitTimeMaxDaysInternational | Integer | The maximum number of transit days for international shipments. | |
| TransitTimeUseDeliverByDate | Boolean | Indicates whether the deliver-by date is used to determine transit time. | |
| ServicePreferenceServiceCode | String | The preferred carrier service code. | |
| ServicePreferenceCarrierId | String |
Carriers.Id | The preferred carrier Id. |
| ServicePreferencePriceToleranceAmount | Decimal | The maximum additional amount to pay over the cheapest rate. | |
| ServicePreferencePriceTolerancePercentage | Double | The maximum additional percentage to pay over the cheapest rate. | |
| Services | String | The list of carrier services included in this rate shopper. |
Pseudocolumns
Pseudocolumn 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 | |
| Type | String | The type used to filter rate shoppers. When set to custom, only seller-created rate shoppers are returned. |