Returns a checkout rate delivery option for the specified configuration and option.

View-Specific Information

Select

The driver 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 driver.

• ConfigurationId and OptionId support the following operator: =.

Note: ConfigurationId and OptionId are required in order to query CheckoutRateOptions. For example, the following query is processed server side:

SELECT * FROM CheckoutRateOptions WHERE ConfigurationId = 'se-1234' AND OptionId = 1

Columns

Name	Type	References	Description
ConfigurationId	String		The unique identifier of the checkout rates configuration.
OptionId [KEY]	Integer		The unique identifier of the delivery option.
Name	String		The display name of the delivery option.
Type	String		The category of the delivery option.
Services	String		The carrier and service pairings rated by this option.
FeeMode	String		The direction in which the fee percentage is applied to the carrier rate, either adding to or subtracting from it.
FeePercentage	Double		The percentage of the carrier rate added or subtracted.
SortIndex	Integer		The relative position of the option among configuration options.
FallbackMode	String		The display behavior of the option when rates are unavailable.
FallbackRateAmount	Decimal		The fixed fallback price for flat rate mode.
FallbackRateCurrency	String		The currency code for the fallback amount.
FallbackPercentage	Double		The percentage of the cart total charged when using percentage mode.
Amount	Decimal		The fixed price for flat-rate options or the preparation fee for pickup options.
Currency	String		The currency code for the amount.
IsActive	Boolean		Indicates whether the option is active and shown at checkout.
CreatedAt	Datetime		The date and time the delivery option was created.