Commit e85bad23 by Dave Chamberlain

Tied some orphan rst files into everything. Broke out some duplicate…

    Tied some orphan rst files into everything.  Broke out some duplicate descriptions into invidivual
    txt files (rst files should be included in a TOC, a txt file can contain rst code, but are intended
    to be included and not indexed).

    ECOM-7191
parent 16cc7961
Coupon Codes
============
A feature that adds the ability to create "Coupon Codes". Coupon Codes are a product that is treated just like
any other product in Otto.
---------------------
Coupon Code Creation
---------------------
Coupons can be created using the Coupon Administration tool:
the URL path to this tool is
http://localhost:8002/coupons/
The Coupon Administration Tool allows the creation of two flavors of codes:
1. Discount Code
Create one or many codes that offer a discount up to 99% of the cost of a given course.
2. Enrollment Code
Create one or many codes that offer a 100% discount on the cost of a given course
Both types of Coupons can have the following behavior:
- One time by one user
- Multiple times by multiple users
- One time by multiple users
The creation of a Coupon behind the scenes generates an order. Payment for these orders is handled by the new
Invoice Payment Processor module and assumes out of band payment for the codes.
The Invoice Payment Modules records the transaction in the Invoice table for later reconciliation.
----------------------
Coupon Code Redemption
----------------------
There are two endpoints for redemption.
- Offer landing page:
http://localhost:8002/coupons/offer/?code=
This page displays the offer to the learner and allows the leaner to apply the code supplied.
This landing page does not require registration / login and is there to provide
context as well as to confirm this will in fact enroll the learner in the course.
- Redeem endpoint
http://localhost:8002/coupons/redeem/?code=
This endpoint actually performs the code redemption by adding the associated course to
the learner's basket, applying the offer and completing the order. This endpoint requires registration / login
and the learner will be presented with the login / registration view if not already logged in.
Once the order is complete the learner is redirected to the LMS dashboard where they can
see the course they just enrolled in.
...@@ -4,20 +4,7 @@ ...@@ -4,20 +4,7 @@
Creating Products Overview Creating Products Overview
########################### ###########################
The edX platform offers several types of products. You create these products in .. include:: ../products_desc.txt
E-Commerce web pages.
* Course seats represent an enrollment track. Each course seat has an
associated set of attributes, such as price and certificate availability. The
edX code uses course seats to determine how a given enrollment should be
handled. For more information, see :ref:`enrollment
track<enrollment_track_g>` or :ref:`Create Course Seats`.
* Coupons allow users to offer learners a discount, either percentage or fixed
amount, off a course enrollment. For more information, see :ref:`Create and
Manage Coupons`.
* Enrollment codes allow users to purchase bulk enrollments for a course.
****************************** ******************************
Prepare to Create a Product Prepare to Create a Product
......
...@@ -13,7 +13,10 @@ use the E-Commerce service with the Open edX platform. ...@@ -13,7 +13,10 @@ use the E-Commerce service with the Open edX platform.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
about_ecommerce
flow
install_ecommerce install_ecommerce
theming
manage_assets manage_assets
create_products/index create_products/index
manage_orders manage_orders
...@@ -31,7 +34,6 @@ In addition to these required steps, you can add optional features to the ...@@ -31,7 +34,6 @@ In addition to these required steps, you can add optional features to the
E-Commerce service for your instance of the Open edX platform. For more E-Commerce service for your instance of the Open edX platform. For more
information, see :ref:`Additional Ecommerce Features`. information, see :ref:`Additional Ecommerce Features`.
.. include:: links/links.rst .. include:: links/links.rst
.. TODO .. TODO
......
...@@ -7,10 +7,6 @@ Install and Start the E-Commerce Service ...@@ -7,10 +7,6 @@ Install and Start the E-Commerce Service
To install and start the edX E-Commerce service, you must complete the To install and start the edX E-Commerce service, you must complete the
following steps. following steps.
.. contents::
:depth: 1
:local:
.. note:: .. note::
These steps assume that you are running Open edX `devstack`_. If you prefer to These steps assume that you are running Open edX `devstack`_. If you prefer to
run the E-Commerce service locally on your computer instead of on the virtual run the E-Commerce service locally on your computer instead of on the virtual
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment