Return Authorization Module (RMA)

[DivaVocals]

correct

Awesome.. Nice code.. I will incorporate your code into the core.. I think it SHOULD be included.. and then I'll submit the whole bloody thing to the RIGHT place..

[rbarbour]

Works for me! Thank you.

[rbarbour]

Awesome.. Nice code.. I will incorporate your code into the core.. I think it SHOULD be included.. and then I'll submit the whole bloody thing to the RIGHT place..

So many changes - for the better, Yes?

1> I re-wrote the code to do-away with the random 3 digit numbers and added customer id in its place.

2> I added a hidden input field to the stores returns page for the RMA#

3> I added the RMA# to the email

4> I added a sql query to the success page to update the order status via admin (),
I am thinking this should have a ADMIN control where the status_id can be entered for all sites will differ depending on how many order statuses they currently have.

Here is the UPDATED and at the moment FINAL CODE

1.) lets create a button
1.A) /includes/languages/english/YOUR_TEMPLATE_NAME/button_names.php

ADD:

define('BUTTON_RMA_REQUEST', 'button_rma_request.png');
define('BUTTON_RMA_REQUEST_ALT', 'Request an RMA#'); 

1.b) upload your button
/includes/templates/YOUR_TEMPLATE_NAME/buttons/english

2. lets add the button to the My Account > History > Order Info page
2.A) /includes/templates/YOUR_TEMPLATE_NAME/templates/tpl_account_history_info_default.php

I added my button at the end of the file right after the <br class="clearBoth" /> and closing </div>

ADD:

<div class="rmaRequestButton"><?php echo '<a href="' . zen_href_link(FILENAME_RETURNS, (isset($_GET['page']) ? 'page=' . $_GET['page'] . '&' : '') . 'order_id=' . $_GET['order_id'], 'SSL') . '">' . zen_image_button(BUTTON_RMA_REQUEST) . '</a>'; ?></div>

3.) /includes/modules/pages/returns/header_php.php

find:

    $order_number = zen_db_prepare_input($_POST['order_number']); 

below that ADD:

    $rma_number = zen_db_prepare_input($_POST['rma_number']); 

then find:

"Order Number:" . "\t" . $order_number . "<br />" . 

below that ADD:

"RMA Number:" . "\t" . $rma_number . "<br />" . 

then find:
zen_redirect(zen_href_link(FILENAME_RETURNS, 'action=success'));

CHANGE TO:

      zen_redirect(zen_href_link(FILENAME_RETURNS, 'action=success' . '&order_id=' . $order_number)); 

then find:

  $city = $check_customer->fields['entry_city']; 

below that ADD:

$cID = $check_customer->fields['customers_id']; 

then find:

  $postcode = $check_customer->fields['entry_postcode'];
} 

below that ADD:

$customer_info_query = "SELECT customers_id
                        FROM   " . TABLE_ORDERS . "
                        WHERE  orders_id = :ordersID";

$customer_info_query = $db->bindVars($customer_info_query, ':ordersID', $_GET['order_id'], 'integer');
$customer_info = $db->Execute($customer_info_query);

$order_number = $_GET['order_id'];
$rma_request_date = date('mdY');
$rma_number = $order_number . TEXT_SUCCESS_DASH . $cID . TEXT_SUCCESS_DASH . $rma_request_date; 

Now in /includes/templates/YOUR_TEMPLATE_NAME/templates/tpl_returns_default.php
find:

<?php if (RETURN_STORE_NAME_ADDRESS == 'true') { ?>
<address><?php echo nl2br(STORE_NAME_ADDRESS); ?></address>
<?php } ?>

<?php
  if (isset($_GET['action']) && ($_GET['action'] == 'success')) {
?>

<br class="clearBoth" />
<div class="mainContent success"><?php echo TEXT_SUCCESS; ?></div>

<?php
  } else {
?>

CHANGE TO:

<?php if (RETURN_STORE_NAME_ADDRESS == 'true' && ($_GET['action'] == 'success')) { ?>
<?php
/**
show nothing
 */
} else if (RETURN_STORE_NAME_ADDRESS == 'true') { ?>
<address><?php echo nl2br(STORE_NAME_ADDRESS); ?></address>
<?php } ?>

<?php
  if (isset($_GET['action']) && ($_GET['action'] == 'success')) {
?>
<br class="clearBoth" />

<div class="mainContent success">
<?php echo '<div id="returnSuccess">' . TEXT_SUCCESS . '</div>' . '<div id="returnRequired">'. TEXT_SUCCESS_RMA_REQUIRED . '</div>' . '<div id="returnPolicy">'. TEXT_SUCCESS_RMA_POLICY_BOF . '<a href="' . zen_href_link(FILENAME_SHIPPING, '', 'SSL') . '">' . TEXT_SUCCESS_RMA_POLICY_LINK . '</a>' . TEXT_SUCCESS_RMA_POLICY_EOF . '</div>' . '<div id="returnAddressWrapper">' . '<div id="returnRMA">' . TEXT_SUCCESS_RMA_ID . $rma_number . '</div>' . '<div id="returnAddress">' . TEXT_SUCCESS_RMA_RETURN_ADDRESS . '</div>'; if (RETURN_STORE_NAME_ADDRESS == 'true') { echo '<address>' . nl2br(STORE_NAME_ADDRESS) . '</address>'; } echo '<div id="returnPhone">' . TEXT_SUCCESS_RMA_RETURN_PHONE . '</div>' . '</div>'; ?>

<?php
$orderID = $_GET['order_id'];
$db->Execute("update " . TABLE_ORDERS . " set orders_status = '5', last_modified = now() where orders_id = '" . (int)$orderID . "'");
?>
<?php
  } else {
?>

The Number 5 represents the order status ID in ADMIN > LOCALIZATION > ORDERS STATUS

ADD "Pending Return", look at your browser page link - you will see oID=#, that # needs to replace the above 5

then find:

<br class="clearBoth" />
<?php
  if (RETURN_ITEM_NAME == 'true') {
?>

ABOVE the <br class="clearBoth" />
ADD:

<?php  echo '<input type="hidden" name="rma_number" value="'.$rma_number.'">'; ?>

then open /includes/languages/english/YOUR_TEMPLATE_NAME/returns.php
DID NOT CHANGE FROM PREVIOUS POSTS

define('TEXT_SUCCESS', 'Your request has been successfully submitted.');
define('TEXT_SUCCESS_RMA_REQUIRED', 'The below RMA# is required for all Returns');
define('TEXT_SUCCESS_RMA_POLICY_BOF', 'You can view our ');
define('TEXT_SUCCESS_RMA_POLICY_LINK', 'Returns Policy');
define('TEXT_SUCCESS_RMA_POLICY_EOF', ' here.');
define('TEXT_SUCCESS_RMA_ID', 'Your RMA# is: ');
define('TEXT_SUCCESS_DASH', '-');
define('TEXT_SUCCESS_RMA_RETURN_ADDRESS', 'Please ship all returns to this address:');
define('TEXT_SUCCESS_RMA_RETURN_PHONE', 'Phone: 1.111.111.1111'); 

and the CSS rules can be added to /includes/templates/YOUR_TEMPLATE_NAME/css/returns.css
DID NOT CHANGE FROM PREVIOUS POSTS

div#returnAddressWrapper {border:1px solid #E9E9E9;background:#FFE573;text-align:center;} div#returnSuccess {font-size:1.2em;padding:5px;color:#606060;} div#returnAddressWrapper, div#returnRequired, div#returnPolicy, div#returnRMA, div#returnAddress, div#returnPhone {font-size:1.5em;font-weight:bold;padding:5px; } div#returnRequired, div#returnAddress {color:#FF0000;}

I hope this helps and I haven't completely confused everyone.

[DivaVocals]

Indeed.. regarding item #4.. I think that what would be better and keep folks out of the code is to add this to the admin menu where folks can select from existing statuses in their store. This would keep folks "out of the code" and make it easier to implement.. I know the change to make in the install SQL to add this option..

something like this should do the trick:

INSERT INTO configuration VALUES (NULL, 'Auto Status - RMA', 'AUTO_STATUS_RMA', '2', 'Number of the order status assigned when an RMA is submitted.', @t4, 5, now(), now(), 'zen_get_order_status_name', 'zen_cfg_pull_down_order_statuses(');

Not so sure what the code below have to look like to use the selected status.. HELP!!

So many changes - for the better, Yes?

1> I re-wrote the code to do-away with the random 3 digit numbers and added customer id in its place.

2> I added a hidden input field to the stores returns page for the RMA#

3> I added the RMA# to the email

4> I added a sql query to the success page to update the order status via admin (),
I am thinking this should have a ADMIN control where the status_id can be entered for all sites will differ depending on how many order statuses they currently have.

Here is the UPDATED and at the moment FINAL CODE

1.) lets create a button
1.A) /includes/languages/english/YOUR_TEMPLATE_NAME/button_names.php

ADD:

define('BUTTON_RMA_REQUEST', 'button_rma_request.png');
define('BUTTON_RMA_REQUEST_ALT', 'Request an RMA#'); 

1.b) upload your button
/includes/templates/YOUR_TEMPLATE_NAME/buttons/english

2. lets add the button to the My Account > History > Order Info page
2.A) /includes/templates/YOUR_TEMPLATE_NAME/templates/tpl_account_history_info_default.php

I added my button at the end of the file right after the <br class="clearBoth" /> and closing </div>

ADD:

<div class="rmaRequestButton"><?php echo '<a href="' . zen_href_link(FILENAME_RETURNS, (isset($_GET['page']) ? 'page=' . $_GET['page'] . '&' : '') . 'order_id=' . $_GET['order_id'], 'SSL') . '">' . zen_image_button(BUTTON_RMA_REQUEST) . '</a>'; ?></div>

3.) /includes/modules/pages/returns/header_php.php

find:

    $order_number = zen_db_prepare_input($_POST['order_number']); 

below that ADD:

    $rma_number = zen_db_prepare_input($_POST['rma_number']); 

then find:

"Order Number:" . "\t" . $order_number . "<br />" . 

below that ADD:

"RMA Number:" . "\t" . $rma_number . "<br />" . 

then find:
zen_redirect(zen_href_link(FILENAME_RETURNS, 'action=success'));

CHANGE TO:

      zen_redirect(zen_href_link(FILENAME_RETURNS, 'action=success' . '&order_id=' . $order_number)); 

then find:

  $city = $check_customer->fields['entry_city']; 

below that ADD:

$cID = $check_customer->fields['customers_id']; 

then find:

  $postcode = $check_customer->fields['entry_postcode'];
} 

below that ADD:

$customer_info_query = "SELECT customers_id
                        FROM   " . TABLE_ORDERS . "
                        WHERE  orders_id = :ordersID";

$customer_info_query = $db->bindVars($customer_info_query, ':ordersID', $_GET['order_id'], 'integer');
$customer_info = $db->Execute($customer_info_query);

$order_number = $_GET['order_id'];
$rma_request_date = date('mdY');
$rma_number = $order_number . TEXT_SUCCESS_DASH . $cID . TEXT_SUCCESS_DASH . $rma_request_date; 

Now in /includes/templates/YOUR_TEMPLATE_NAME/templates/tpl_returns_default.php
find:

<?php if (RETURN_STORE_NAME_ADDRESS == 'true') { ?>
<address><?php echo nl2br(STORE_NAME_ADDRESS); ?></address>
<?php } ?>

<?php
  if (isset($_GET['action']) && ($_GET['action'] == 'success')) {
?>

<br class="clearBoth" />
<div class="mainContent success"><?php echo TEXT_SUCCESS; ?></div>

<?php
  } else {
?>

CHANGE TO:

<?php if (RETURN_STORE_NAME_ADDRESS == 'true' && ($_GET['action'] == 'success')) { ?>
<?php
/**
show nothing
 */
} else if (RETURN_STORE_NAME_ADDRESS == 'true') { ?>
<address><?php echo nl2br(STORE_NAME_ADDRESS); ?></address>
<?php } ?>

<?php
  if (isset($_GET['action']) && ($_GET['action'] == 'success')) {
?>
<br class="clearBoth" />

<div class="mainContent success">
<?php echo '<div id="returnSuccess">' . TEXT_SUCCESS . '</div>' . '<div id="returnRequired">'. TEXT_SUCCESS_RMA_REQUIRED . '</div>' . '<div id="returnPolicy">'. TEXT_SUCCESS_RMA_POLICY_BOF . '<a href="' . zen_href_link(FILENAME_SHIPPING, '', 'SSL') . '">' . TEXT_SUCCESS_RMA_POLICY_LINK . '</a>' . TEXT_SUCCESS_RMA_POLICY_EOF . '</div>' . '<div id="returnAddressWrapper">' . '<div id="returnRMA">' . TEXT_SUCCESS_RMA_ID . $rma_number . '</div>' . '<div id="returnAddress">' . TEXT_SUCCESS_RMA_RETURN_ADDRESS . '</div>'; if (RETURN_STORE_NAME_ADDRESS == 'true') { echo '<address>' . nl2br(STORE_NAME_ADDRESS) . '</address>'; } echo '<div id="returnPhone">' . TEXT_SUCCESS_RMA_RETURN_PHONE . '</div>' . '</div>'; ?>

<?php
$orderID = $_GET['order_id'];
$db->Execute("update " . TABLE_ORDERS . " set orders_status = '5', last_modified = now() where orders_id = '" . (int)$orderID . "'");
?>
<?php
  } else {
?>

The Number 5 represents the order status ID in ADMIN > LOCALIZATION > ORDERS STATUS

ADD "Pending Return", look at your browser page link - you will see oID=#, that # needs to replace the above 5

then find:

<br class="clearBoth" />
<?php
  if (RETURN_ITEM_NAME == 'true') {
?>

ABOVE the <br class="clearBoth" />
ADD:

<?php  echo '<input type="hidden" name="rma_number" value="'.$rma_number.'">'; ?>

then open /includes/languages/english/YOUR_TEMPLATE_NAME/returns.php
DID NOT CHANGE FROM PREVIOUS POSTS

define('TEXT_SUCCESS', 'Your request has been successfully submitted.');
define('TEXT_SUCCESS_RMA_REQUIRED', 'The below RMA# is required for all Returns');
define('TEXT_SUCCESS_RMA_POLICY_BOF', 'You can view our ');
define('TEXT_SUCCESS_RMA_POLICY_LINK', 'Returns Policy');
define('TEXT_SUCCESS_RMA_POLICY_EOF', ' here.');
define('TEXT_SUCCESS_RMA_ID', 'Your RMA# is: ');
define('TEXT_SUCCESS_DASH', '-');
define('TEXT_SUCCESS_RMA_RETURN_ADDRESS', 'Please ship all returns to this address:');
define('TEXT_SUCCESS_RMA_RETURN_PHONE', 'Phone: 1.111.111.1111'); 

and the CSS rules can be added to /includes/templates/YOUR_TEMPLATE_NAME/css/returns.css
DID NOT CHANGE FROM PREVIOUS POSTS

div#returnAddressWrapper {border:1px solid #E9E9E9;background:#FFE573;text-align:center;} div#returnSuccess {font-size:1.2em;padding:5px;color:#606060;} div#returnAddressWrapper, div#returnRequired, div#returnPolicy, div#returnRMA, div#returnAddress, div#returnPhone {font-size:1.5em;font-weight:bold;padding:5px; } div#returnRequired, div#returnAddress {color:#FF0000;}

I hope this helps and I haven't completely confused everyone.

[rbarbour]

<?php
$autoRMA = AUTO_STATUS_RMA;
$orderID = $_GET['order_id'];
$db->Execute("update " . TABLE_ORDERS . " set orders_status = $autoRMA, last_modified = now() where orders_id = '" . (int)$orderID . "'");
?>

[DivaVocals]

<?php
$autoRMA = AUTO_STATUS_RMA;
$orderID = $_GET['order_id'];
$db->Execute("update " . TABLE_ORDERS . " set orders_status = $autoRMA, last_modified = now() where orders_id = '" . (int)$orderID . "'");
?>

Now we're cookin' with Crisco!!! I'll bundle this up and submit.. BTW.. If I haven't said it... you're awesome. Been stalking..err.. I mean watching all the helpful stuff you've been posting.. good stuff..

[rbarbour]

Believe it or not, I do allot if searching and reading to "mainly" find easy and simple solution to incorporate into client websites to efficiently create the functions they require to successfully operate their e-commerce website.

Along the way, I add my two cents and if I think an idea or suggestion will enhance zen cart functionality for the vast majority, I will take the time to help make it work (where I can). Their are far more knowledgeable on this forum than I.

And thank you, it is good to hear a fellow contributor appreciate another.

Now stop stalking me, I mean watching. JUST KIDDING

[DivaVocals]

And thank you, it is good to hear a fellow contributor appreciate another.

Now stop stalking me, I mean watching. JUST KIDDING

I will not I will not I will not!!!

[rbarbour]

Now we're cookin' with Crisco!!! I'll bundle this up and submit.. BTW.. If I haven't said it... you're awesome. Been stalking..err.. I mean watching all the helpful stuff you've been posting.. good stuff..

Was this ever packaged and submitted?

[DivaVocals]

Was this ever packaged and submitted?

It's on my plan for this Friday when I am working from home.. I actually have three add-ons to update and upload..