Skip to navigation

CheckoutAvailableShippingOption

OBJECT
Available shipping option.

Fields

entityIdStringRequired
Shipping option ID.
descriptionStringRequired
Shipping option description.
typeStringRequired
Shipping option type. Flat rate, UPS, etc.
costMoneyRequired
Shipping option cost.
costInDisplayCurrencyMoneyRequired
Shipping option cost in display currency.
isRecommendedBooleanRequired
Is this shipping method the recommended shipping option or not.
costAfterDiscountMoneyRequired
Shipping option cost after all discounts are applied.
costAfterDiscountInDisplayCurrencyMoneyRequired
Shipping option cost after all discounts are applied in display currency.
transitTimeStringOptional
An estimate of the arrival time.
imageImageOptional
Shipping option image.
imageUrlStringOptionalDeprecated

Shipping option image URL.

Deprecated: Use image field instead.