CheckoutShippingAddressOptionsFilterExtension Reference

This page contains the reference documentation for the CheckoutShippingAddressOptionsFilterExtension class.

It is a base class for extension add-ons that filter the shipping address options available to the user during checkout. The available shipping options are first calculated by Sana Commerce Cloud and then passed to the extension add-on. The extension add-on can only hide pre-calculated options, but not make already hidden options available.

Methods

HideShippingAddressOptions

public abstract HiddenShippingAddressOptions HideShippingAddressOptions(ShippingAddressOptionsFilterContext context);

Returns the shipping address options that should be hidden from the user during checkout.

Parameters

• context: the context of the shipping address options filter extension. See ShippingAddressOptionsFilterContext for reference.

Returns

The shipping address options that should be hidden from the user during checkout. See HiddenShippingAddressOptions for reference.

Example Usage

public override HiddenShippingAddressOptions HideShippingAddressOptions(ShippingAddressOptionsFilterContext context)
{
    return new(ShippingAddressOptions.SelfPickup | ShippingAddressOptions.BillingAddress);
}