You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

customer.rst 1.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. ========
  2. Customer
  3. ========
  4. The customer app includes models to record product alerts and sent emails.
  5. It also contains the views that allow a customer to manage their data
  6. (profile information, shipping addresses, etc.)
  7. Abstract models
  8. ---------------
  9. .. automodule:: oscar.apps.customer.abstract_models
  10. :members:
  11. Forms
  12. -----
  13. .. automodule:: oscar.apps.customer.forms
  14. :members:
  15. Views
  16. -----
  17. .. automodule:: oscar.apps.customer.views
  18. :members:
  19. Alerts
  20. ------
  21. The alerts module provides functionality that allows customers to sign up for
  22. email alerts when out-of-stock products come back in stock. A form for signing
  23. up is displayed on product detail pages when a product is not in stock.
  24. If the ``OSCAR_EAGER_ALERTS`` setting is ``True``, then alerts are sent as soon
  25. as affected stock records are updated. Alternatively, the management command
  26. ``oscar_send_alerts`` can be used to send alerts periodically.
  27. The context for the alert email body contains a ``hurry`` variable that is set
  28. to ``True`` if the number of active alerts for a product is greater than the
  29. quantity of the product available in stock.
  30. CustomerDispatcher
  31. ------------------
  32. ``oscar.apps.customer.utils.CustomerDispatcher`` is used to send customer emails
  33. (e.g., registration, password reset, order confirmations).
  34. AlertsDispatcher
  35. ----------------
  36. ``oscar.apps.customer.alerts.utils.AlertsDispatcher`` is used to send product alerts.