Shipping and Tax Related Object Types

Shipping Region

A Shipping Region is a geographical location that your storefront ships to.

Sample XML:

<shipping_regions>
<shipping_region name="Canada" guid="1">
    <region country_code="CA">
        <sub_region>AB</sub_region>
        <sub_region>BC</sub_region>
        <sub_region>MB</sub_region>
        <sub_region>NB</sub_region>
        <sub_region>NL</sub_region>
        <sub_region>NT</sub_region>
        <sub_region>NS</sub_region>
        <sub_region>NU</sub_region>
        <sub_region>ON</sub_region>
        <sub_region>PE</sub_region>
        <sub_region>QC</sub_region>
        <sub_region>SK</sub_region>
        <sub_region>YT</sub_region>
    </region>
</shipping_region>
...
</shipping_regions>

Shipping Service Level

A shipping service level is the delivery service available to a Shipping Region.

Sample XML:

<shipping_service_levels>
<shipping_service_level guid="service_level127672548310427">
    <shipping_region>USA</shipping_region>
    <shipping_cost_calculation_method type="fixedPriceMethod">
        <displayText>FixedPriceMethod_method_text</displayText>
        <shipping_cost_calculation_params>
            <shipping_cost_calculation_param>
                <param_key>CalculationParameter_FixedPrice</param_key>
                <value>25.0</value>
                <display_text>25.0</display_text>
                <currency>USD</currency>
            </shipping_cost_calculation_param>
        </shipping_cost_calculation_params>
    </shipping_cost_calculation_method>
    <storecode>SLRWORLD</storecode>
    <carrier>USPS</carrier>
    <localized_names>
        <value language="en">USPS Global Airmail Parcel Post</value>
    </localized_names>
    <code>SLRWORLD_USPSGlobalAirmailParcelPost</code>
    <active>true</active>
</shipping_service_level>
...
</shipping_service_levels>

Tax Code

Tax code identifies the type of tax applicable to a product.

Sample XML:

<tax_codes>
<code code="GOODS" guid="502"/>

<code code="NONE" guid="501"/>

<code code="SHIPPING" guid="500"/>
</tax_codes>

Tax Jurisdiction

A tax jurisdiction is a region with tax. The tax jurisdiction XML file includes tax values for the specific regions and sub-regions of the tax jurisdiction.

Sample XML:

<tax_jurisdictions>
<jurisdiction guid="90A40DA5-CB0F-8470-B044-CA06D53F44F6">
    <region_code>CA</region_code>
    <priceCalculationMethod>false</priceCalculationMethod>
    <tax_categories>
        <tax_category guid="2BC591C4-0759-760E-96DA-DF2719DE58B8">
            <name>GST</name>
            <fieldMatch>FIELD_MATCH_COUNTRY</fieldMatch>
            <localized_properties/>
            <regions>
                <region region_name="CA">
                    <values>
                        <value percent="5.0000" code="GOODS"/>
                        <value percent="5.0000" code="SHIPPING"/>
                    </values>
                </region>
            </regions>
        </tax_category>
        <tax_category guid="B85640AA-986B-B07A-FFC3-5A74534BD9F4">
            <name>PST</name>
            <fieldMatch>FIELD_MATCH_SUBCOUNTRY</fieldMatch>
            <localized_properties/>
            <regions>
                <region region_name="ON">
                    <values>
                        <value percent="8.0000" code="GOODS"/>
                        <value percent="8.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="NL">
                    <values>
                        <value percent="8.0000" code="GOODS"/>
                        <value percent="8.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="YT">
                    <values>
                        <value percent="0.0000" code="GOODS"/>
                        <value percent="0.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="MB">
                    <values>
                        <value percent="7.0000" code="GOODS"/>
                        <value percent="7.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="NU">
                    <values>
                        <value percent="8.0000" code="GOODS"/>
                        <value percent="8.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="NT">
                    <values>
                        <value percent="0.0000" code="GOODS"/>
                        <value percent="0.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="BC">
                    <values>
                        <value percent="7.0000" code="GOODS"/>
                        <value percent="7.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="QC">
                    <values>
                        <value percent="7.5000" code="GOODS"/>
                        <value percent="7.5000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="NS">
                    <values>
                        <value percent="0.0000" code="GOODS"/>
                        <value percent="0.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="PE">
                    <values>
                        <value percent="1.0000" code="GOODS"/>
                        <value percent="1.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="SK">
                    <values>
                        <value percent="7.0000" code="GOODS"/>
                        <value percent="7.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="NB">
                    <values>
                        <value percent="8.0000" code="GOODS"/>
                        <value percent="8.0000" code="SHIPPING"/>
                    </values>
                </region>
                <region region_name="AB">
                    <values>
                        <value percent="0.0000" code="GOODS"/>
                        <value percent="0.0000" code="SHIPPING"/>
                    </values>
                </region>
            </regions>
        </tax_category>
    </tax_categories>
</jurisdiction>