Package com.broadleafcommerce.shipping.service.integrations.shipengine.config

Class ShipEngineProperties

  • @ConfigurationProperties(prefix="broadleaf.shipping.service.shipengine")
public class ShipEngineProperties
extends Object

    • Constructor Detail

      • ShipEngineProperties

        public ShipEngineProperties()

    • Method Detail

      • isActive

        public boolean isActive()
        Enable this shipping integration.
        Returns:
        True if this integration should be enabled

      • getApiKey

        public String getApiKey()
        The ShipEngine API key.
        Returns:
        The ShipEngine API key.

      • getBaseUrl

        public String getBaseUrl()
        The fully-qualified domain name of the ShipEngine API.
        Returns:
        The fully-qualified domain name of the ShipEngine API.

      • isGetCarriersFromProperties

        public boolean isGetCarriersFromProperties()
        Get carrier ids from properties instead of an API call if true.
        Returns:
        Get carrier ids from properties instead of an API call if true.

      • getCarriers

        public List<String> getCarriers()
        The list of carrier ids to use for shipping rates. Only used if getCarriersFromProperties is true.
        Returns:
        The list of carrier ids to use for shipping rates. Only used if getCarriersFromProperties is true.

      • getDefaultFromAddress

        public ShipEngineProperties.DefaultFromAddress getDefaultFromAddress()
        The default FROM address to use for rates and labels.
        Returns:
        The default FROM address to use for rates and labels.

      • getAddressValidationMode

        public String getAddressValidationMode()
        The ShipEngine address validation mode to use for rates and labels.
        Returns:
        The ShipEngine address validation mode to use for rates and labels.

      • isTaxable

        public boolean isTaxable()
        Determines if Fulfillment Options created from ShipEngine Rates should be marked as taxable.
        Returns:
        Determines if Fulfillment Options created from ShipEngine Rates should be marked as taxable.

      • getTaxCode

        public String getTaxCode()
        The tax code for Fulfillment Options created from ShipEngine Rates.
        Returns:
        The tax code for Fulfillment Options created from ShipEngine Rates.

      • setActive

        public void setActive​(boolean active)
        Enable this shipping integration.
        Parameters:
        active - True if this integration should be enabled

      • setApiKey

        public void setApiKey​(String apiKey)
        The ShipEngine API key.
        Parameters:
        apiKey - The ShipEngine API key.

      • setBaseUrl

        public void setBaseUrl​(String baseUrl)
        The fully-qualified domain name of the ShipEngine API.
        Parameters:
        baseUrl - The fully-qualified domain name of the ShipEngine API.

      • setGetCarriersFromProperties

        public void setGetCarriersFromProperties​(boolean getCarriersFromProperties)
        Get carrier ids from properties instead of an API call if true.
        Parameters:
        getCarriersFromProperties - Get carrier ids from properties instead of an API call if true.

      • setCarriers

        public void setCarriers​(List<String> carriers)
        The list of carrier ids to use for shipping rates. Only used if getCarriersFromProperties is true.
        Parameters:
        carriers - The list of carrier ids to use for shipping rates. Only used if getCarriersFromProperties is true.

      • setDefaultFromAddress

        public void setDefaultFromAddress​(ShipEngineProperties.DefaultFromAddress defaultFromAddress)
        The default FROM address to use for rates and labels.
        Parameters:
        defaultFromAddress - The default FROM address to use for rates and labels.

      • setAddressValidationMode

        public void setAddressValidationMode​(String addressValidationMode)
        The ShipEngine address validation mode to use for rates and labels.
        Parameters:
        addressValidationMode - The ShipEngine address validation mode to use for rates and labels.

      • setTaxable

        public void setTaxable​(boolean taxable)
        Determines if Fulfillment Options created from ShipEngine Rates should be marked as taxable.
        Parameters:
        taxable - Determines if Fulfillment Options created from ShipEngine Rates should be marked as taxable.

      • setTaxCode

        public void setTaxCode​(String taxCode)
        The tax code for Fulfillment Options created from ShipEngine Rates.
        Parameters:
        taxCode - The tax code for Fulfillment Options created from ShipEngine Rates.