Settings Guide

Shipping Configuration Settings

This section allows you to manage the shipping carrier service and fallback rates.

Note: To enable the Shipping Carrier Service API, you’ll need to use the Shopify plan with an annual payment or a higher plan. Alternatively, you can contact Shopify support to enable the Shipping Carrier Service API for your store, which may incur an additional $20 charge for using the Shipping Carrier Rate service.

FYI: To contact Shopify support, visit this link, select your organization, choose API Support, and then click Email Us.

Shipping Carrier Service Status
  1. Status: Displays whether the shipping carrier service is active or inactive. If the status is disabled, it means the app is not functioning on your site.
  2. Shopify Plan: Indicates the current Shopify plan.
  3. Button: Turn Off Shipping Carrier Service
    • Click this button to disable the shipping carrier service and the app on your site.
Enable Fallback Rate
  1. Checkbox: Enable Fallback Rate
    • Check this box to activate fallback rates if no shipping rate is returned.
  2. Fallback Rate Name
    • Enter a custom name for the fallback rate (e.g., “Default Shipping”).
  3. Shipping Cost
    • Specify the fallback shipping cost.
    • Type: Choose between a fixed amount or a percentage-based rate.

General

This section allows you to configure global settings for the shipping rates.

1. Currency Code

Displays the currency code (e.g., VND for Vietnamese Dong) used for shipping rates. This information is synced from Shopify. To change your store’s currency, navigate to Shopify Backend -> Settings -> General -> Store Defaults, and select Change Store Currency.

2. Timezone

Displays the timezone set for the store (e.g., America/New_York). This information is synced from Shopify. To update your timezone, go to Shopify Backend -> Settings -> General -> Store Defaults, and adjust the Time Zone setting.

3. Shipping Options at Checkout

This setting allows you to customize how shipping rates are displayed to customers at checkout. There are three options:

  1. All Matching Rates: Displays all shipping rates that match the conditions set for the order. This option provides customers with multiple choices to select their preferred shipping method.
  2. Highest Rate: Displays only the highest shipping rate from the matching options. Useful if you want to prioritize premium or expedited shipping.
  3. Lowest Rate: Displays only the lowest shipping rate from the matching options. Ideal for offering the most affordable shipping option to customers.

Measurement Formats

The Measurement Formats section allows you to configure the units used for calculating shipping rates. Here’s a breakdown of each setting:

1. Distance

This setting allows you to specify the unit of measurement for calculating shipping distances. The selected unit will be used to determine shipping costs based on distance traveled from the shipping origin to the destination.

Purpose:

  • Helps calculate distance-based shipping rates accurately.
  • Ensures compatibility with your shipping carrier’s requirements and regional preferences.

Options:

  • Kilometer
  • Mile
2. Weight

This setting allows you to define the unit of measurement for product weight. The selected unit will be used in shipping calculations.

Options:

  • Grams: Suitable for small, lightweight items.
  • Kilograms: Ideal for larger or heavier items.
  • Pounds: Commonly used in the imperial system.
  • Ounces: Best for smaller measurements in the imperial system.
3. Dimension Format

This setting allows you to specify the unit of measurement for product dimensions (Length, Width, Height). These values are critical for calculating volumetric weight.

Options:

  • Millimeters: Ideal for precise measurements of small items.
  • Centimeters: Commonly used for general products in the metric system.
  • Meters: Suitable for larger items or bulk measurements.
  • Feet: Preferred for products measured using the imperial system.
4. Volumetric Dimensional Factor

This setting is used to calculate the volumetric weight of a package, which is an essential metric for determining shipping costs when carriers charge based on the space a package occupies rather than its actual weight.

Purpose:

  • Determine accurate shipping rates: Many shipping carriers use volumetric weight to calculate costs for lightweight but bulky packages.
  • Optimize cost calculation: Ensures you’re charged fairly by aligning your rates with carrier standards.
  • Avoid undercharging: Helps prevent losses by accounting for large but lightweight items.

How It Works:

{Volumetric Weight} = {Length} * {Width} * {Height} / {Volumetric Dimensional Factor}

  • Length, Width, Height: Package dimensions in the selected unit (e.g., cm or inches).
  • Volumetric Dimensional Factor: A constant provided by shipping carriers to convert the volume into a weight equivalent.

Default Value:

  • 5000 (Metric: cm and kg)

Adjust this value based on your shipping provider’s recommendations.

Note:

  • These settings will impact how shipping rates are calculated and displayed to customers.
  • Ensure that the selected units align with your store’s requirements and the shipping carriers you use.

Sync Settings

The Sync Settings section allows you to manage and update product, shipping zone, and store information to ensure the app reflects the latest data from your Shopify store.

1. Sync All Data
  • Sync Data button:
    • Click this button to sync all data, including Products, Shipping Zones, Shipping Profiles, and Store Information.

2. Products
  • Last Synced: Displays the last date and time when product data was synced.
  • Sync Products Button:
    • Click this button to manually sync all product-related information, such as names, SKUs, and tags.
    • Use this feature to update the app with any recent changes made to your products in Shopify.
  • Sync Dimensions Values from Product/Variant Metafields

    • This option allows you to automatically retrieve product dimension values (Width, Height, Length) from metafields in your Shopify store.

    • How to Set Up Metafield Mapping for Dimensions

      1. Navigate to Shopify Metafields Settings:

      • Go to Shopify AdminSettingsCustom Data.

      • Choose Products or Variants based on where your dimension data is stored.

      2. Find the Metafield Definitions:

      • Click Open Metafield Definitions to see the available metafields.

      • Identify the correct Namespace and Key values for Width, Height, and Length.

      3. Enter Metafield Keys in the App Configuration:

      • Use the exact Namespace and Key values from Shopify.

      • Example: If your metafield is custom.width, custom.height, custom.length, enter these in the respective fields.

3. Shipping Zone
  • Last Synced: Displays the last date and time when shipping zone data was synced.
  • Sync Shipping Zone Button:
    • Click this button to manually sync the latest shipping zones and shipping profiles configured in your Shopify store.
    • Ensures that the app uses the correct shipping zones for rate calculations.
4. Store Information
  • Last Synced: Displays the last date and time when store information was synced.
  • Sync Store Information Button:
    • Click this button to manually update store-level information, including currency, timezone, store name, store owner details, and other settings.
    • Helps align the app with your store’s most recent configurations.
Best Practices
  • Sync Regularly: Although the app may sync data automatically, it’s a good idea to use the manual sync options after making significant changes to products, shipping zones, or store information in Shopify.
  • Verify Data: After syncing, check the app to ensure the updated information has been applied correctly.

Appearance Settings

This section allows you to customize date formats and exclude specific days from date calculations.

1. Date Format

This setting allows you to choose how dates are displayed in shipping estimate calculations for shipping methods on the checkout page. This helps improve readability and ensures alignment with regional date formats.

 

Available Options

  • MM/DD/YYYY (Default): Month/Day/Year
  • DD/MM/YYYY: Day/Month/Year
  • YYYY/MM/DD: Year/Month/Day
  • YYYY/DD/MM: Year/Day/Month
  • MM-DD-YYYY: Month-Day-Year
  • DD-MM-YYYY: Day-Month-Year
  • YYYY-MM-DD: Year-Month-Day
  • YYYY-DD-MM: Year-Day-Month
  • Custom: Allows you to define a custom date format based on your preferences.

Custom Format

  • When selecting Custom, you can specify your own date format. The format should follow the guidelines outlined in the Moment.js documentation.

Examples of acceptable formats:

  • D MMM YYYY (e.g., 2 Dec 2024)
  • dddd, MMMM Do YYYY (e.g., Monday, December 2nd 2024)
  • YYYY.MM.DD (e.g., 2024.12.02)
2. Exclude Days

Purpose: Exclude specific days (e.g., weekends or holidays) from date calculations, such as delivery lead times or shipping estimates.

  • How to Set:
  1. Click inside the exclusion box.
  2. Select days you want to exclude (e.g., Saturday, Sunday).
  3. To remove a day, click the X next to the selected day.

Google API Settings

This section configures Google API for distance-based calculations, enabling accurate shipping estimates based on travel distances.

1. Google API Key
  • Purpose: Integrates your Google API key to allow the app to access Google Maps data for calculating distances.
  • How to Set:
  1. Obtain an API key from the Google Cloud Console.
  2. Enter your API key in the Google API Key field.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.
2. Distance Travel Mode

Purpose: Select the mode of transportation to calculate shipping distances.

Options:

  • Driving
  • Walking
  • Bicycling
  • Transit

Once you’ve configured the information, click Save to apply the changes.