Change Log

  • 30-Sep-2020 | 5.5.0 | All new article

Contributors:

Adam Wilson - Logo Pogo

Shipping Provider Fields

This component provides a placeholder for populating additional Shipping Provider options to the user.

When used in the Shopping Cart and when integrated shipping provider/s are in use, it will also be responsible for rendering any additional options related to the integrated shipping provider services.
One such field includes the customers zip/post code, which will be required and carry through to the Checkout page where it will be locked in the Checkout form (much like the delivery Country is if selected from the Checkout page).

{% component type: "shippingProviderFields" %}

Parameters and Options

Parameter
Values
Required
Description
type
shippingProviderFields

This is the name of the entity that needs to be used for the component retrieving function.

layout
<path/to/layout>

Path to file that will contain the Liquid layout content to be parsed.

If an empty string, nothing will be rendered.
If paramater is not included, the default virtual layout will be rendered (see below).

collectionVariable
<yourLiquidVariableName>

Assigns the data to a Liquid collection enabling further access to the data on the Page or Template using Liquid.

Your collectionVariable value must only contain English letters, numbers or underscores. Spaces or special characters are not supported.

Liquid Output

This component does not provide any Liquid context and simply provides a placeholder for the eCommerce Javascript to use for populating additional Shipping Provider options to the user.

Virtual Layout

If not using any custom layout or collection, the default virtual layout will output as a DIV placeholder:

<div data-cms_cart_shipping_provider_fields_holder></div>