General Use of Estimated Delivery Date for Magento
How does Estimated Delivery Date for Magento work?
The Estimated Delivery Date extension offers you multi-level lead times management. It allows you to establish and personalize lead times for each one of the products available in your Magento website and on several levels.
Estimated Delivery Date is entirely customizable. You have the possibility to display and completely personalize delivery messages.
What are lead times?
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.
Estimated Delivery Date in 3 steps
To configure Estimated Delivery Date go to:
SysteMConfigurationWyomind Estimated Delivery Date
Before anything, you need to define a certain number of parameters.
STEP 1: Configure the extension in a general way
First of all, be sure that the current configuration scope is Default Config.
Then, you can start to configure Estimated Delivery Date in a general way.
Global Settings
- Debug enabled
You can also enable the debug mode. Debug traces are visible only if your IP has been added to the Developer Client Restrictions from:
System configuration developer - Store opening days
Note that when the store is closed orders are handled the day after. - Store days off
When the store is closed orders are handled the day after. - Date format
For example, for 01/01/2019, write:
d/m/Y - Time format
For example, for 6:00PM, write:
h:iA
Estimated Delivery Date Message
Estimated Delivery Date allows you to define a global message to display in several places:
- at the top of the cart and in the checkout
- in the transaction email
Your transaction emails must be updated with:
{{block type='core/template' template='estimateddeliverydate/email/message.phtml' order=$order}}
- in the customer account
In that message, you can use many placeholders:
{{cutoff}}, {{from_x_day}}, {{to_x_day}}, {{from_date}}, {{to_date}}, {{from_x_week}}, {{to_x_week}}
Default settings for in stock products
- Default lead time
Define the general lead time in days. If you want to use ranges such as "from 2 days to 4 days", please write:
2-4 - Last shipping time of the day
Choose the last shipping time of the day. After that hour, orders are handled the day after. - Shipping days
Choose the days when the orders will be delivered. Carriers work on these days. - Shipping days off
Estimated Delivery Date allows you to set days off for shipping. Carriers don't work on these days. Each date must be written in a new line as:
YYYY-MM-DD - Display a message on the product pages
Let your customers know when the product can be delivered. - Message on the product pages
You can use the following placeholders:
{{cutoff}}, {{from_x_day}}, {{to_x_day}}, {{from_date}}, {{to_date}}, {{from_x_week}}, {{to_x_week}}, {{countdown}} - Display a message for each item in cart, in transactional email, in customer account
You have the possibility to display a message in the cart, in transactional email and in the customer account dinstinctly. - Message for each item in cart, transactional email and customer account
You can use the following placeholders:
{{cutoff}}, {{from_x_day}}, {{to_x_day}}, {{from_date}}, {{to_date}}, {{from_x_week}}, {{to_x_week}}
Default settings for out of stock products
Lead time based on attributes
You can also define additional lead times depending on attributes and define the scope of the additional lead time:
- Orders and Backorders
- Orders only
- Backorders only
When you have saved the configuration, you should see a message displayed in the admin.
Lead time based on custom options
Estimated Delivery Date also allows you to define how you want to calculate the lead times of all selected custom options:
- Sum of all custom option lead times
T-Shirt S : 5 daysT-Shirt Orange : 2 days
When a customer orders an orange T-shirt in size S, it will require 7 days to be shipped. - Highest custom option lead time
T-Shirt S : 5 daysT-Shirt Orange : 2 daysWhen a customer orders an orange T-shirt in size S, it will require 5 days to be shipped.
Countdown format
- Countdown format
Choose the format of the countdown displayed in the product pages. - Countdown in real time
Automatically update the countdown in real-time. - Countdown display type
You can choose the textual or graphic display type as below.
- Add jQuery v1.12.0 library
jQuery is required for the graphic countdown. Do not add jQuery if it's already added through the theme or a third party module.
Lead time by shipping method and shipping rate codes
- Shipping method code
You can use regular expressions. For example, for all methods starting with ups_, write:
ups_.* - Lead time
You can use lead time range separated by hyphen. For example, from 1 to 2 shipping days:
1-2 - Message
You can use the following placeholders:
{{cutoff}}, {{title}}, {{from_x_day}}, {{to_x_day}}, {{from_date}}, {{to_date}}, {{from_x_week}}, {{to_x_week}}
For example, if you're using Pickup@Store with Estimated Delivery Date, you'll be able to define additional lead time for each pickup method. Below is an example of the frontend when using store pickup.
STEP 2: Personalize the messages and the date and time format
Estimated Delivery Date allows you to customize the messages and date display according to your needs.
Messages display
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
Placeholders
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, the availability date, and the time left before the order is received.
You can use several placeholders:
- {{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). - {{title}}
Title of the shipping method.
Only for the Message for each Shipping method. - {{cutoff}}
Last shipping time of the day. - {{countdown}}
Number of hours, minutes, and seconds before the last shipping of the day.
Only for the Message on the product pages.
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}}.
PHP scripts
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}}"; } 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}}.
Date and time display
Estimated Delivery Date also allows you to display the format of the date and time as you want.
Date format
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.
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
Time format
Also, the time format can change from a country to another. You can refer to the below table to create your own format.
- for 6:00PM, write:
h:iA - for 6h00, write:
g\hi
STEP 3: Manage lead times
There are different ways to manage lead times.
You can define different lead times according to:
- the store view
- the product attribute
- the product
By store view
Estimated Delivery Date allows you to configure lead times according to the store view. Have a look at the Current configuration scope at the top of the admin from the general configuration in:
SystemConfigurationWyomind 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 England, you can define it in the Default lead time field for the English store view.
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:
SystemConfigurationWyomind Estimated Delivery Date
Then go to:
CatalogAttributesManage Leadtime/Attribute
There, you will be able to assign additional lead times for each one of the values of these attributes. As on the example below, where we added 4 lead-time days for products available in silver color.
Save all your modifications by clicking on Save all changes.
For each product
With Estimated Delivery Date, you can manage lead times at the product level.
Go to:
CatalogManage Products
Choose a product and click on Edit. Go to the Estimated Delivery Date tab.
You have the possibility to define a restocking date in the Stock expected for field for backorder products. Then, the default lead time for orders will be added to the restocking date.
In the Estimated delivery date for orders and Estimated delivery date for backorders tabs, you'll be able to modify the default lead times as well as the message to display in the product page, the shipping days and last shipping time for this product in particular.
For each custom option
You can also define lead times for each custom option of your products in the Custom Options tab.
Then, you can go in the Lead time based on custom options tab to choose how you want to calculate the lead time, from:
SystemConfigurationWyomind Estimated Delivery DatE