{"id":464,"date":"2010-10-17T15:10:21","date_gmt":"2010-10-17T23:10:21","guid":{"rendered":"https:\/\/www.numinix.com\/blog\/?p=464"},"modified":"2019-05-30T10:59:40","modified_gmt":"2019-05-30T17:59:40","slug":"how-to-add-backorder-support-to-your-zen-cart-store","status":"publish","type":"post","link":"https:\/\/www.numinix.com\/blog\/how-to-add-backorder-support-to-your-zen-cart-store\/","title":{"rendered":"How to Add Backorder Support to Your Zen Cart Store"},"content":{"rendered":"

As your store grows and you have to manage a larger inventory, you’ll often find items are out of stock as you await new stock from your suppliers.\u00a0 You can either set Zen Cart to disallow checkout when items are out of stock and potentially lose a large number of orders, or you can display a message to customers that products will be backordered and shipped when they become available.\u00a0 However, in the default Zen Cart, there is no way to set individual products as backordered or shipped so out of the box, this isn’t really an option.<\/p>\n

This tutorial is going to show you how to add the ability to assign backordered or shipped status to individual products in an order and how to generally setup a usable backorder system in your Zen Cart store.<\/p>\n

So, let’s begin!<\/p>\n

Step 1<\/strong><\/p>\n

Begin by installing the Edit Order module.<\/p>\n

Step 2<\/strong><\/p>\n

Go to ADMIN->LOCALIZATION->ORDER STATUS and create two new statuses called ‘Backordered’ and ‘Shipped’.<\/p>\n

Step 3<\/strong><\/p>\n

Go to ADMIN->TOOLS->INSTALL SQL PATCHES and paste the following code into the textarea:<\/p>\n

ALTER TABLE orders_products ADD backorder tinyint(1) NOT NULL DEFAULT '0';\r\nALTER TABLE orders_products ADD shipped tinyint(1) NOT NULL DEFAULT '0';<\/pre>\n
Step 4<\/strong><\/p>\n
Open \/admin\/edit_orders.php and perform the following modifications:<\/p>\n
Add near the top of the file around line 80:<\/p>\n
\/\/ Backorder \/ Shipped Support Modification\r\n$dropdown_options = array(array(\"id\" => 0, \"text\" => \"no\"),\r\n array(\"id\" => 1, \"text\" => \"yes\"));<\/pre>\n
Find:<\/p>\n
$Query = \"update \" . TABLE_ORDERS_PRODUCTS . \" set<\/pre>\n
Add After:<\/p>\n
\u00a0shipped = '\" . $products_details[\"shipped\"] . \"',\r\n backorder = '\" . $products_details[\"backorder\"] . \"',<\/pre>\n
Find:<\/p>\n
<!-- Begin Products Listing Block -->\r\n <table border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"2\">\r\n <tr>\r\n <td colspan=\"2\"><?php echo TABLE_HEADING_PRODUCTS; ?><\/td><\/pre>\n
Add After:<\/p>\n
\u00a0<td><?php echo TABLE_HEADING_SHIPPED; ?><\/td>\r\n <td><?php echo TABLE_HEADING_BACKORDER; ?><\/td><\/pre>\n
Find:<\/p>\n
$order->products[$index] = array('qty' => $orders_products_query->fields['products_quantity'],\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 'name' => zen_html_quotes($orders_products_query->fields['products_name']),<\/pre>\n
Add After:<\/p>\n
\u00a0'shipped' => zen_html_quotes($orders_products_query->fields['shipped']),\r\n 'backorder' => zen_html_quotes($orders_products_query->fields['backorder']),<\/pre>\n
Find:<\/p>\n
echo '\u00a0\u00a0\u00a0\u00a0\u00a0 <\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0\u00a0\u00a0 <td valign=\"top\">' . \"<input name='update_products[$orders_products_id][model]' size='12' value='\" . $order->products[$i]['model'] . \"'>\" . '<\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0\u00a0\u00a0 <td align=\"center\" valign=\"top\">' . \"<input name='update_products[$orders_products_id][tax]' size='3' value='\" . zen_display_tax_value($order->products[$i]['tax']) . \"'>\" . '%<\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0\u00a0\u00a0 <td align=\"right\" valign=\"top\">' . \"<input name='update_products[$orders_products_id][final_price]' size='5' value='\" . number_format($order->products[$i]['final_price'], 2, '.', '') . \"'>\" . '<\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0\u00a0\u00a0 <td align=\"right\" valign=\"top\">' . $currencies->format($order->products[$i]['final_price'] * $order->products[$i]['qty'], true, $order->info['currency'], $order->info['currency_value']) . '<\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0 <\/tr>' . \"\\n\";<\/pre>\n
Replace With:<\/p>\n
echo '\u00a0\u00a0\u00a0\u00a0\u00a0 <\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0\u00a0\u00a0 <td valign=\"top\">' . zen_draw_pull_down_menu(\"update_products[$orders_products_id][shipped]\", $dropdown_options, $order->products[$i]['shipped']) . '<\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0\u00a0\u00a0 <td valign=\"top\">' . zen_draw_pull_down_menu(\"update_products[$orders_products_id][backorder]\", $dropdown_options, $order->products[$i]['backorder']) . '<\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0\u00a0\u00a0 <td valign=\"top\">' . \"<input name='update_products[$orders_products_id][model]' size='12' value='\" . $order->products[$i]['model'] . \"'>\" . '<\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0\u00a0\u00a0 <td align=\"center\" valign=\"top\">' . \"<input name='update_products[$orders_products_id][tax]' size='3' value='\" . zen_display_tax_value($order->products[$i]['tax']) . \"'>\" . '%<\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0\u00a0\u00a0 <td align=\"right\" valign=\"top\">' . \"<input name='update_products[$orders_products_id][final_price]' size='5' value='\" . number_format($order->products[$i]['final_price'], 2, '.', '') . \"'>\" . '<\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0\u00a0\u00a0 <td align=\"right\" valign=\"top\">' . $currencies->format($order->products[$i]['final_price'] * $order->products[$i]['qty'], true, $order->info['currency'], $order->info['currency_value']) . '<\/td>' . \"\\n\" .\r\n\u00a0\u00a0\u00a0\u00a0 '\u00a0\u00a0\u00a0 <\/tr>' . \"\\n\";<\/pre>\n
Step 5<\/strong><\/p>\n
Open \/admin\/includes\/languages\/english\/edit_orders.php and add the following definition somewhere in the file:<\/p>\n
define('TABLE_HEADING_BACKORDER', 'Backordered');\r\ndefine('TABLE_HEADING_SHIPPED', 'Shipped');<\/pre>\n
Step 6<\/strong><\/p>\n
Open \/admin\/includes\/classes\/order.php and find:<\/p>\n
$orders_products = $db->Execute(\"select orders_products_id, products_id, products_name, products_model, products_price, products_tax, products_quantity, final_price, onetime_charges, product_is_free\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 from \" . TABLE_ORDERS_PRODUCTS . \"\u00a0\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0\u00a0 where orders_id = '\" . (int)$order_id . \"'\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 order by orders_products_id\");<\/pre>\n
Replace With:<\/p>\n
$orders_products = $db->Execute(\"select orders_products_id, products_id, products_name, products_model, products_price, products_tax, products_quantity, final_price, onetime_charges, product_is_free, backorder, shipped\u00a0\u00a0\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0\u00a0 from \" . TABLE_ORDERS_PRODUCTS . \"\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 where orders_id = '\" . (int)$order_id . \"'\u00a0\u00a0\u00a0\u00a0\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 order by orders_products_id\");<\/pre>\n
Find:<\/p>\n
$this->products[$index] = array('qty' => $new_qty,\u00a0\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'id' => $orders_products->fields['products_id'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'name' => $orders_products->fields['products_name'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'model' => $orders_products->fields['products_model'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'tax' => $orders_products->fields['products_tax'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'price' => $orders_products->fields['products_price'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'onetime_charges' => $orders_products->fields['onetime_charges'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'final_price' => $orders_products->fields['final_price'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'product_is_free' => $orders_products->fields['product_is_free']);<\/pre>\n
Replace With:<\/p>\n
$this->products[$index] = array('qty' => $new_qty,\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'id' => $orders_products->fields['products_id'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'name' => $orders_products->fields['products_name'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'model' => $orders_products->fields['products_model'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'tax' => $orders_products->fields['products_tax'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'price' => $orders_products->fields['products_price'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'onetime_charges' => $orders_products->fields['onetime_charges'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'final_price' => $orders_products->fields['final_price'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'product_is_free' => $orders_products->fields['product_is_free'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'backorder' => $orders_products->fields['backorder'],\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 'shipped' => $orders_products->fields['shipped']);<\/pre>\n
Step 7<\/strong><\/p>\n
Open \/admin\/invoice.php and find:<\/p>\n
for ($i = 0, $n = sizeof($order->products); $i < $n; $i++) {<\/pre>\n
Add After (anywhere inside the for loop):<\/p>\n
\u00a0if ($order->products[$i]['backorder'] == 1) {\r\n\u00a0\u00a0 echo '<br \/><nobr><small><strong>* Backordered *<\/strong><\/small><\/nobr>';\r\n } elseif ($order->products[$i]['shipped'] == 1) {\r\n\u00a0\u00a0 echo '<br \/><nobr><small><strong>* Previously Shipped *<\/strong><\/small><\/nobr>';\r\n }<\/pre>\n
Step 8<\/strong><\/p>\n
Repeat step 7 inside \/admin\/packingslip.php<\/p>\n
Step 9<\/strong><\/p>\n
Open \/includes\/classes\/order.php and find:<\/p>\n
$this->notify('NOTIFY_ORDER_PROCESSING_STOCK_DECREMENT_END');<\/pre>\n
Add After:<\/p>\n
\/\/ begin back-order modification\r\n $backorder = 0;\r\n if ($stock_left < 0 || $attribute_stock_left < 0) { \/\/ less then 0 because this is the quantity remaining after this order\u00a0\r\n\u00a0\u00a0 $backorder = 1;\r\n }<\/pre>\n
Notice this edit also adds support for stock by attributes if you have that module installed.<\/p>\n
Find:<\/p>\n
zen_db_perform(TABLE_ORDERS_PRODUCTS, $sql_data_array);<\/pre>\n
Add Before:<\/p>\n
$sql_data_array['backorder'] = $backorder;<\/pre>\n
Step 10
\n<\/strong><\/p>\n
Go to ADMIN->CONFIGURATION->STOCK and set Allow Checkout to true.<\/p>\n
Finished!<\/p>\n
Now, when customers go to order a product that is out of stock, a message will display to the customer (you can change this message in your language definitions;\u00a0 search for the text in ADMIN->TOOLS->DEVELOPER’S TOOLKIT) and they will still be able to order the product.\u00a0 When your shipper goes to ship the order, they will already see the out of stock items have been marked as backordered (as per the edits to the order() class).\u00a0 They can then ship the order and set the status of the individual products that were shipped to “Shipped” and set the entire order to “Backordered”.\u00a0 When the items come into stock, the shipper can set the individual items that were previously backordered to “Shipped” and also set the entire order to “Shipped”.<\/p>\n
Numinix is currently working on shipping modules that will rely on this type of backorder system to be in place in order to better manage shipments.\u00a0 For example, our Endicia XML Exporter \/ Importer module is setup to only ship orders that do not have “Shipped” status and for orders that are “Backordered” it will skip any products that have been marked as “Shipped”.\u00a0 Furthermore, the module will import any completed shipments back into Zen Cart and set the overall status of the order to “Shipped” if all products in the order have been shipped.<\/p>\n
If I’ve missed any steps or made a mistake, please let me know right away and I’ll update this tutorial with the corrected information.\u00a0 Otherwise, I hope this will help managing backorders a lot easier for your store!<\/p>\n