You are here

README.txt in Commerce Stock 7.2

Same filename and directory in other branches
  1. 7 README.txt
Commerce Stock Module 7.x-2.0
==============================
This module provides stock management for Drupal Commerce stores.

This module includes three modules:
- Commerce Stock API: A common API for managing stock using sub modules.
  Implements validation events and actions.
- Commerce Simple Stock: A basic stock sub-module providing a stock field.
- Commerce Simple Stock Rules: A set of rules to control stock (it can be
  configured by modifying the rules or creating new ones). Varlidation rules
  created:
  - Disabling add to cart
  - Validate add to cart
  - Validate checkout


To install and get working
============================
1. Download commerce_stock.
2. Enable the Commerce Stock API, Commerce Simple Stock, and Commerce Simple
   Stock Rules modules.
3. Go to people > permissions and make sure that you and other relevant
   roles have the "Administer commerce stock settings".
4. Go to Home > Administration > Store > Configuration > Stock management.
5. Select the "simple stock management" tab.
6. Check the product types you want simple stock to manage and hit submit.


Important:
  You may need to clear caches after installing and enabling stock for your
  products. Rules will show errors for the stock rules until you enable stock on
  at least one product.

If you want to be able to disable stock checking for individual products check
the "Allow stock override for Product <product>".

To Uninstall
=============
1. Go to Home > Administration > Store > Configuration > Stock management.
2. Select the "simple stock management" tab.
3. Un-Check all product types hit submit and confirm the "I understand that all
   stock data will be permanently removed".
4. go to the modules page & disable all stock modules.
5. Go to the uninstall tab and uninstall all stock modules.

Notes on Uninstall:
* If you are planing on using a different version of stock or replace the stock
  module with another / a custom system, you can keep the stock field and skip
  steps 1 to 3. the stock field will be preserved and you will be able to use it
  as any other drupal field.
* If you forgot to follow steps 1 to 3 before uninstalling you can visit each of
  the product bundles and delete the stock field from each of those.


rules configuration
===================
If you need to make changes to rules you also need the permission
"Make rule based changes to commerce stock".
to view and edit the rules see:
admin/commerce/config/stock/validation
and
admin/commerce/config/stock/control

Increase stock level when canceling an order
============================================
If you want stock to be automatically returned when an order is canceled you can
enable the "Stock: Increase when canceling the order process" rule on the "stock
control" configuration page.
This will handle orders with a state change
from: Pending, Processing or Completed
to: Canceled
you can easily update this to include other states that are relevant to your
site.

Decimal Stock
=============
The editing of stock levels support decimal quantities, to enable this feature
edit a product type (admin/commerce/products/types) and check the box
"Allow decimal quantities for stock administration"
to support decimal quantities on the add to basket use the module
https://drupal.org/project/commerce_decimal_quantities

File

README.txt
View source
  1. Commerce Stock Module 7.x-2.0
  2. ==============================
  3. This module provides stock management for Drupal Commerce stores.
  4. This module includes three modules:
  5. - Commerce Stock API: A common API for managing stock using sub modules.
  6. Implements validation events and actions.
  7. - Commerce Simple Stock: A basic stock sub-module providing a stock field.
  8. - Commerce Simple Stock Rules: A set of rules to control stock (it can be
  9. configured by modifying the rules or creating new ones). Varlidation rules
  10. created:
  11. - Disabling add to cart
  12. - Validate add to cart
  13. - Validate checkout
  14. To install and get working
  15. ============================
  16. 1. Download commerce_stock.
  17. 2. Enable the Commerce Stock API, Commerce Simple Stock, and Commerce Simple
  18. Stock Rules modules.
  19. 3. Go to people > permissions and make sure that you and other relevant
  20. roles have the "Administer commerce stock settings".
  21. 4. Go to Home > Administration > Store > Configuration > Stock management.
  22. 5. Select the "simple stock management" tab.
  23. 6. Check the product types you want simple stock to manage and hit submit.
  24. Important:
  25. You may need to clear caches after installing and enabling stock for your
  26. products. Rules will show errors for the stock rules until you enable stock on
  27. at least one product.
  28. If you want to be able to disable stock checking for individual products check
  29. the "Allow stock override for Product ".
  30. To Uninstall
  31. =============
  32. 1. Go to Home > Administration > Store > Configuration > Stock management.
  33. 2. Select the "simple stock management" tab.
  34. 3. Un-Check all product types hit submit and confirm the "I understand that all
  35. stock data will be permanently removed".
  36. 4. go to the modules page & disable all stock modules.
  37. 5. Go to the uninstall tab and uninstall all stock modules.
  38. Notes on Uninstall:
  39. * If you are planing on using a different version of stock or replace the stock
  40. module with another / a custom system, you can keep the stock field and skip
  41. steps 1 to 3. the stock field will be preserved and you will be able to use it
  42. as any other drupal field.
  43. * If you forgot to follow steps 1 to 3 before uninstalling you can visit each of
  44. the product bundles and delete the stock field from each of those.
  45. rules configuration
  46. ===================
  47. If you need to make changes to rules you also need the permission
  48. "Make rule based changes to commerce stock".
  49. to view and edit the rules see:
  50. admin/commerce/config/stock/validation
  51. and
  52. admin/commerce/config/stock/control
  53. Increase stock level when canceling an order
  54. ============================================
  55. If you want stock to be automatically returned when an order is canceled you can
  56. enable the "Stock: Increase when canceling the order process" rule on the "stock
  57. control" configuration page.
  58. This will handle orders with a state change
  59. from: Pending, Processing or Completed
  60. to: Canceled
  61. you can easily update this to include other states that are relevant to your
  62. site.
  63. Decimal Stock
  64. =============
  65. The editing of stock levels support decimal quantities, to enable this feature
  66. edit a product type (admin/commerce/products/types) and check the box
  67. "Allow decimal quantities for stock administration"
  68. to support decimal quantities on the add to basket use the module
  69. https://drupal.org/project/commerce_decimal_quantities