Overview

WooCommerce - Estimated Dispatch Date
A Wordpress Plugin that allows you to estimated the dispatch date of a particular WooCommerce product or order.

The plugin allows you to attach to a product, the estimated number of days it would take to be dispatched. When viewing a product it can determine the number of days before it would be dispatched, as well as the total cart / order.

Version 2.0.0

Requirements:

PHP
PHP Version 5.3+
Wordpress
Wordpress Version 3.8+
WooCommerce
WooCommerce Version 2.5+

Installation

To install the plugin there are a number of ways available. Below are the two most common methods.

FTP

Using your preferred FTP client (Filezilla, WinSCP, etc) navigate to your Wordpress Plugin folder.
Transfer the extracted plugin folder here.

/wp-content/plugins/

Upload

In the Admin Dashboard navigate to Plugin upload page.
Upload the zipped packaged plugin here.

Plugins > Add New > Upload

Settings

The settings for the plugin can be accessed under the WooCommerce Settings Page, or via the settings tab in the plugin menu.

WooCoommerce > Settings > Estimated Dispatch Date

General

Display

Here you are able to define if the Estimated Dispatch Date should appear on the product / order pages. The Product Pages refer to the single-product template page. The Order Pages refer to the Cart, Checkout and Email Templates.

Product Display Type

These are the driver options for displaying the Estimated Dispatch Date. Each Option has more detailed settings under the Display Types Section.

Shop

Day Cut-off Time

Set the time for which orders placed after that time should be processed the next day.

Maximum Day Range

The maximum Day Range is the value at which the product / category slider can process.

Working Days

Set the days that your shop can process orders.

Holidays

It is possible to exclude a range of days when calculating the Estimated Dispatch Date. For your convenience we have included Kayaposoft/Enrico's API to retrieve a list of public holidays based off your country code. Importing the Country Holidays will only pull holidays for the current year.

Manually adding a holiday will bring up an input field with a date picker. The name of the holiday is only used as your reference. The Date format must explicity be Y-m-d.

All holiday fields need to be set and updated in order to be saved.

Display

Product Hook Title

Set the display title for when the Product hook is used.

Product Hook Placement

The placement of the product hook has a variety of hooks available in the single product page. Select the best one which suits your style and theme.

Order Title

Set the display title for when the Order hook is used.

Order Hook Placement

The placement of the order hook has a variety of hooks available in the Cart / Checkout pages. Select the best one which suits your style and theme.

Date Format

Set the Date Format you would like the Estimated Dispatch Date to use. The options show the current date in the format.

Display Types

Currently there are 3 Display Types, each type displays the Product, Order hooks and Shortcode.

Numerical

This product will be dispatched in 3 days.


The Numerical Display Type uses numeric values to display the Estimated Dispatch Date. It ignores holidays, workdays and cut-off times, as it is intended to be an average.

Numerical Text

This is the message that will get outputted on the Product Hook and Shortcode. This message has two delimiters which must be present in the message.

[number]

This delimiter will be replaced with the numerical Estimated Dispatch Date value.

[days]

This delimiter will be replaced with the Days Locale Translation. It will default to plural if the number value is greater than 1.

Day Locale

Enter your preferred translation for both the singular and plural (in that order) versions of "day/days", seperated by a comma.

day,days

Actual

This product will be dispatched on 01/01/2016.


The Actual Display Type uses an actual date values to display the Estimated Dispatch Date. It takes into consideration all the workdays, holidays and cut-off time to calculate the date. The Date Format is used to display the date.

Actual Text

This is the message that will get outputted on the Product Hook and Shortcode. This message has one delimiter which must be present in the message.

[date]

This delimiter will be replaced with the calculated Estimated Dispatch Date.

Range

This product will be dispatched in 2 - 3 days.


The Range Display Type uses an either a numerical or date range value to display the Estimated Dispatch Date. This display type mimics their main counter-parts, but uses a range of values.

Range Text

This is the message that will get outputted on the Product Hook and Shortcode. Customize the message to match the format you have chosen. This message has one delimiter which must be present in the message.

[range]

This delimiter will be replaced with the calculated Estimated Dispatch Date range.

Range Display Type

Select the display type for the Range Display Type.

Products

Estimated Dispatch Date supports every official WooCommerce product type. In the edit product page you will be able to set the Estimated Dispatch Date using a slider. The sliders range is set using the Maximum Day Range. There are three states the Estimated Dispatch Date can be in, Activated, Inherit & Disabled.

Activated

An Activated State refers to when the Estimated Dispatch Date has been set using the slider. To deactivate the Activated slider click the trash icon.

Inherit

When the Estimated Dispatch Date is not Activated or Disabled it stays in an Inherit state. This means that it honors Set Category Hierarchy.

Disabled

To Disable the Estimated Dispatch Date for a product click the disable button. It will highlight to blue to confirm it's state. When in the Disabled state, the Estimated Dispatch Date will not be calculated.

Simple

Under the Product Data Metabox, in the General tab. The Estimated Dispatch Date will be available for configuration here.

On the Single Product Page the Estimated Dispatch Date will automatically be visible if there is a value attached to the Product.

Variation

Under the Product Data Metabox, in the Variations tab. The Estimated Dispatch Date is configurable for each set variation.

On the Single Product Page the Estimated Dispatch Date will be hidden at first. Once a combination of the variation options matches a Product, and a value for that Product is set, it will display.

Grouped

Grouped Products are a collection of Simple Products, therefore are configured on the individual Simple Products.

On the Single Product Page the Estimated Dispatch Date will automatically be visible if there is a value attached to at least one Product in the group. The value displayed is the maximum within the grouping.

External

External Products work identically to Simple Products. However they cannot be added to the Cart, therefore can not be included in the Order Pages.

On the Single Product Page the Estimated Dispatch Date will automatically be visible if there is a value attached to the Product.

Category Hierarchy

WooCommerce Categories can have Estimated Dispatch Dates attached to them as well. This allows Products to Inherit their values.
This is a easy way to globally assign Estimated Dispatch Dates.

Category Hierarchy matches the first category by traversing up the Category Tree. A Product's set Estimated Dispatch Date takes priority.

Setting the Estimated Dispatch Date for a Category works the same way you would for Products.

Cart / Checkout

When viewing your cart or checkout page the Estimated Dispatch Date for the entire order can be shown if set using General Display Settings.
The title and position can be defined by the Display Order Settings.

The Estimated Dispatch Date is calculated by totalling the maximum date that each applicable product generates.
The Numerical and Actual Display types both format the output into a singular date in your defined format.
The Range Display Type will show the range of dates.

Orders

When orders are placed, the Estimated Dispatch Date is attached to the order.
If the General Display Settings are set to show on Order pages, the Estimated Dispatch Date will be visible in emails.

Order Meta

WooCommerce > Orders

The Estimated Dispatch Date can be viewed in the Order Summary Page. In the right hand side there is a Meta-Box with an editable input field with the current Estimated Dispatch Date.
The date format for this field is Y-m-d.
If you are using the Range Display Type, both dates will be visible.

Emails

If applicable the Estimated Dispatch is attached to all emails that include the order item details.

Support

Support will be maintained via email, till such time our support platform is online.
Users that have expired support licenses will have to wait until available resources can be assigned.
When emailing a support query it is important to be concise and provide all available information for assistance.
Any bug fixes will have top priority. Feature request will be evaluated and road-mapped for future feature releases.

Third Party Plugin Support

Please note that we do not support any third party plugins. Although there should not be any performance issues, we can not be responsible with incompatibilities. Support for these request will be taken case-by-case and evaluated.

Support
Feature Request