ESTIMATED DELIVERY DATEUser Guide

The Estimated Delivery Date extension offers you a multi-level lead times management. It allows you to establish and personalize lead timesfor each one of the products available in your Magento 2 website and on several levels.

Estimated Delivery Date is entirely customizable. You have the possibility to display and completely personalize delivery messages.

Lead time is the latency between the initiation and the execution of a process. It is the time you need to ship the products.

With the Estimated Delivery Date extension, lead times are defined in days. You can specify lead times on different levels (store, product, attribute,configurable product, custom option...). All lead times will then be added together.

Below is an example that sums up the main configuration possibilities with Estimated Delivery Date.

General Use of Estimated Delivery Date for Magento® 2

How does Estimated Delivery Date for Magento® 2 work?

What are lead times?

To configure Estimated Delivery Date go to: STORES CONFIGURATION WYOMIND ESTIMATED DELIVERY DATE

First of all, be sure that the current configuration scope is Default Config.

You can first enable the module.

Debug enabledWhen the debug option is set on Yes, the module add debug traces to the Estimated Delivery Date output.

You should never use this option in production modeDebug traces are visible only if your IP belongs to the group of IPs defined in the developer Client Restrictions or if no IPs have beendefined. In order to add your own IP go to: STORES CONFIGURATION ADVANCED DEVELOPER DEVELOPER CLIENT RESTRICTIONS

Store opening daysWhen selecting opening days the estimated delivery date is calculated from the next opening day.For example, if one order is placed Saturday, it will be shipped only Monday (supposing that Saturday and Sunday are days off).

Configure Estimated Delivery Date in 4 steps

STEP 1: Configure Estimated Delivery Date in a general way

Global settings

Store days offWhen orders are placed while the day is off, then the estimated delivery date is calculated from the next working day.You can add an unlimited number of day off using the below format:

yyyy-mm-dd

The days must be ordered from the oldest to newest one.

Date formatThe date format uses the same parameters as the Php function date().The date appears in the estimated delivery messages depending on that setting.

Estimated Delivery Date allows you to display messages in cart, in transaction emails and/or in customer account.

You also have the possibility to display a message at the top of the cart and in the checkout.

You can use several placeholders:

{{from_x_day}}, {{to_x_day}}, {{from_date}}, {{to_date}}, {{from_x_week}}, {{to_x_week}}

The estimated delivery date (delays and messages) may differ for in stock products and out of stock products (backorders allowed). That's why theEstimated Delivery Date extension offers the ability to adjust your settings depending on the product availability. Default lead time

The lead time is the time needed to prepare, ship and deliver the order to the customer.This value is a number of days or it can be a range ofdays (2 numbers separated by a hyphen).Example of a single value:

Estimated Delivery Date Message

Default settings for in stock products

Example of a time range value:

Last Shipping time of the dayWhen an order is placed after the last shipping time of the day, then the estimated delivery date is calculated from the next working day.

Shipping daysThe shipping days let you define which days your carriers works and allow to adjust the estimated delivery date consequently.

Shipping days offThe shipping days off let you define which days your carriers doesn't works and allow to adjust the estimated delivery date consequently.Thedates must be ordered from the former to the more recent and must be formatted as follows:

yyyy-mm-dd

Display a message on the product pagesThe estimated delivery date will appear on all product pages if that option is enabled.You can use several placeholders:

{{from_x_day}}, {{to_x_day}}, {{from_date}}, {{to_date}}, {{from_x_week}}, {{to_x_week}}, {{countdown}}

Display a message for each item in cartThe estimated delivery date will appear for each item in the cart if that option is enabled.You can use several placeholders:

{{from_x_day}}, {{to_x_day}}, {{from_date}}, {{to_date}}, {{from_x_week}}, {{to_x_week}}

Display a message for each item in transaction emailThe estimated delivery date will appear for each item in the transaction email if that option is enabled.You can use several placeholders:

{{from_x_day}}, {{to_x_day}}, {{from_date}}, {{to_date}}, {{from_x_week}}, {{to_x_week}}

Estimated Delivery Date allows to define different settings for out of stock products:

1. Case 1 - Product is out of stock and no backorder is allowedThen no estimated delivery date messages show, only the default "Out of stock" message show.

2. Case 2 - Product is out of stock and backorders are allowedThen the estimated delivery date messages will show depending on the out of stock settings (see below).

3. Case 3 - Product is out of stock, the backorders are allowed and the product has a re-stocking date) Then the estimated delivery date messages will be calculated from the re-stocking date with the in stock settings.

The below options must be used exactly the same way as the settings for in stock products and applies to the out of stock products with backordersallowed only.

Default lead time

Last Shipping time of the day

Shipping days

Shipping days off

Display a message on the product pages

Display a message for each item in cart

Display a message for each item in transaction email

You can also define additional lead times depending on attributes and define the scope of the additional lead time:

In stock and out of stock products

In stock products

Out of stock products

Default settings for out of stock products

Lead time based on attributes

A message will confirm that the attribute values are ready to be mapped.

Note that the attributes must be dropdown attributes so that you can manage additional lead time.

Estimated Delivery Date also allows you to define how you want to calculate the lead times of all selected custom options:

the lead time can be the sum of all custom options

T-Shirt S : 5 days

T-Shirt Orange : 2 days

When a customer orders an orange T-shirt in size S, it will require 7 days to be shipped.

the lead time can be the highest value of all custom options

T-Shirt S : 5 days

T-Shirt Orange : 2 days

When a customer orders an orange T-shirt in size S, it will require 5 days to be shipped.

The countdown format can be displayed as textual or graphic.

You can define your own settings for:

Lead time based on custom options

Countdown

Countdown format:

days

days, hours

days, hours, minute

days, hours, minute, seconds

Countdown in real time:yes/no

Countdown display time:You can choose between textual or graphic as the example below.

Note that the {{coundown}} variable is only available for the messages in the product pages.

You can also define lead times for each shipping method and rate. For that, select the method or the rate and click on .

There you can choose to add lead times and display a message for specific shipping methods and rates.

Shipping method codeyou can use regular expressions. For example, for all methods starting with ups_, write:

ups_.*

Lead timeFor the lead times, you can use lead time range separated by hyphen. For example, from 1 to 2 shipping days:

1-2

MessageYou can use the following placeholders:

{{title}}, {{from_x_day}}, {{to_x_day}}, {{from_date}}, {{to_date}}, {{from_x_week}}, {{to_x_week}}

The estimated delivery date will then be calculated accordingly.

Estimated Delivery Date allows you to customize the messages and date display according to your needs.

Leadtime by shipping method and shipping rate codes

STEP 2: Personalize the messages and the date format

Messages can be displayed in different places:

on the product pages (in stock/out of stock products)

in the cart and the checkout

in the transaction email

in the customer account

for each shipping method/rate

You have the possibility to personalize each one of these messages including some specific syntax just as below in order to display the lead times, theavailability date and the time left before the order is received.

You can use several placeholders according to the type of message.

{{from_x_day}}Number of minimum lead times (+ days off).

{{to_x_day}}Number of maximum lead times (+ days off).

{{from_date}} = d-day + minimum lead times (+ days off).

{{to_date}}D-day + maximum lead times (+ days off).

{{from_x_week}}Minimum number of weeks from which the order will be delivered (+ days off).

{{to_x_week}}Maximum number of weeks from which the order will be delivered (+ days off).

{{countdown}} Number of hours, minutes and seconds before the last shipping of the day. Only for the Message on the product pages.

{{title}}Title of the shipping method.Only for the Message for each shipping method.

Below are a few examples of messages including placeholders:

{{title}} - Your order will be delivered in {{to_x_week}} weeks.

This item will be ready to ship on {{from_date}}.

For quick delivery, order this item in the next {{countdown}}.

You can also add PHP directly in your messages:

<php if({{leadtime_from}}>1){return "Whatever you want with any placeholder you want";}else{return "something else";}?>

Below are some examples of what you could do with PHP:

For the message in the product page: <?php if ("{{from_x_day}}" <=2) {return "For quick delivery, order this item in the next {{countdown}}";

Messages display

PlaceholdersPlaceh

PHP scripts

} else {return "For delivery on {{from_date}}, order this item in the next {{countdown}}";}?>

For the message in the checkout:Your order will be shipped <?php if ("{{from_x_day}}" == 2 || "{{from_x_day}}" == 1) {return "quickly";} else {return "in {{from_x_day}} days";}?>. Estimated delivery date: {{from_date}}.

For the shipping methods/rates messages: Note that you can define a message for each shipping/method/rates. For example :

Flat Rate message:

With the Flat Rate, your order will be shipped <?php if ("{{from_x_day}}" <= 1) {return "today.";} else { return "in {{from_x_day}} days.";}?> Estimated delivery date: {{from_date}}.

Free Shipping message:

Benefit from the Free Shipping, your order will be shipped <?php if ("{{from_x_day}}" <= 1) {return "tomorrow.";} else return "in {{from_x_day}} days.";}?> Estimated delivery date: {{from_date}}.

Estimated Delivery Date also allows you to display the format of the date as you want.

Indeed, as the date format is often different from a country to another, you can refer to the following table in order to create your own date format.

Date display

Date format

Below are some examples:

for Sunday 5st of July 2014, write:

l jS \of F Y

You can also define some date formats for each store view:

for the English Store view, l jS \of F Y will give:

Tuesday 26th of August 2014

for the French Store view, l j F Y will give:

Mardi 26 Août 2014

There are different ways to manage lead times.

You can define different lead times for each:

store view

product

product attribute

custom option

Estimated Delivery Date allows you to configure lead times according to the store view. Have a look at the Store view configuration at the top of theadmin from: STORES SETTINGS CONFIGURATION WYOMIND ESTIMATED DELIVERY DATE

When choosing a configuration scope, you have the possibility to use default data or to change the settings as you want.

For example, if you need 3 additional days to send in stock goods to a specific store view, you can define it in the Default lead time field for thatspecific store view.

STEP 3: Manage lead times

By store view

Instead of using the global settings for all products you can use specific values for some products.

Go to: PRODUCTS INVENTORY CATALOG

Choose a product and click on . Go to the Estimated Delivery Date tab.

And then apply the settings that will override the global settings.

For out of stock products you have the possibility to define the re-stocking date, then the estimated delivery date will be calculated from that date andwill use the settings of the in stock products.

All settings can be configured at the website, store and store-view level.

Note that backorders must be allowed (either as global settings or at the product level) otherwise the product will be considered as out of stock and nomessage will display.

By product

By product attribute

First of all, you need to choose the attributes to which you want to add additional lead times as well as the scope of these lead times in: STORES SETTINGS CONFIGURATION WYOMIND ESTIMATED DELIVERY DATE LEAD TIME BASED ON ATTRIBUTES

A message will confirm that the attribute values are ready to be mapped.

Note that the attributes must be dropdown attributes so that you can manage additional lead time.

Then go to: STORES ATTRIBUTES ESTIMATED DELIVERY DATE

There, you will be able to assign additional lead times for each one of the value of these attributes. As on the example below, where we added 4 leadtime days for products available in silver color.

Save all your modifications by clicking on .

If you want to increase the lead times for a specific custom option of a given products you can map the custom option with an additional lead timeunder the Customizable Options tab, from: PRODUCTS INVENTORY CATALOG

By custom option

Only the custom options from the drop down type can be used for additional lead times.

Estimated Delivery Date includes a previewing tool that help you to check if your settings are correct and if they give the expected results.

Go to: STORES SETTINGS CONFIGURATION WYOMIND ESTIMATED DELIVERY DATE ESTIMATED DELIVERY DATE PREVIEW

Enter the SKU of the product to check and click the Go button. The preview of the messages will display.

STEP 4: Check your settings

Estimated Delivery Date Preview