Adding E-Commerce to the Open edX Platform

EdX uses a Django application called ecommerce to provide the platform with ecommerce functionality. This E-Commerce service extends Oscar, an open source Django ecommerce framework, to manage the edX product catalog and handle orders for those products. The following sections describe how to install and use the E-Commerce service with the Open edX platform.

• Install and Start the E-Commerce Service
  • Set Up a Virtual Environment
  • Run Migrations
  • Configure OAuth
  • Configure a Site, Partner, and Site Configuration
  • Start the Server
  • Switch from ShoppingCart to E-Commerce
  • Development Outside Devstack
• Comprehensive Theming
  • Theme Structure
  • Templates
  • Static Assets
  • Sass
  • Enabling a Theme
  • Disabling a Theme
  • Creating or Updating Site and SiteTheme
  • Compiling Theme Sass
  • Troubleshooting
• Manage Static Assets
  • Compile and Move Static Assets
• Create E-Commerce Products
  • Creating Products Overview
  • Create Course Seats
  • Create and Manage Coupons
  • Enable and Create Enrollment Codes
• Manage Orders
  • Place an Order
  • Fulfill Orders
  • About Fulfillment Modules
  • Recover from a Fulfillment Error
• Test Features
  • Tests for the Open edX Platform
• Test Your E-Commerce Application
  • Tests for E-Commerce
• Additional E-Commerce Features
  • Sending Notifications
  • Payment Processors
  • Tracking Data
  • Gating E-Commerce Service Features
  • Maintaining the E-Commerce Service
• Architectural Decision Records
  • 1. 1. Record Architecture Decisions
  • 2. Status
  • 3. Context
  • 4. Decision
  • 5. Consequences
  • 6. References
  • 7. 2. No synchronous server-to-server calls within transactions
  • 8. Status
  • 9. Context
  • 10. Decision
  • 11. Consequences
  • 12. References
  • 13. 3. Enterprise Coupons
  • 14. Status
  • 15. Context
  • 16. Decision
  • 17. Consequences
  • 18. References
  • 19. 4. Unique Identifiers for Users
  • 20. Status
  • 21. Context
  • 22. Decision
  • 23. Consequences
  • 24. References
  • 25. 5. Payment Microfrontend (MFE) Support and Backend-for-Frontend (BFF) APIs
  • 26. Status
  • 27. Context
  • 28. Decision
  • 29. Consequences
  • 30. References
  • 31. 6. Use Custom Applicator Throughout Ecommerce
  • 32. Status
  • 33. Context
  • 34. Decision
  • 35. Consequences
  • 36. 6. Add fallback for ecommerce sdn check
  • 37. Status
  • 38. Context
  • 39. Decision
  • 40. Consequences
  • 41. 8. Master branch split from 2u/main
  • 42. Status
  • 43. Context
  • 44. Decision
  • 45. Consequences
  • 46. Rejected Alternatives

To complete the procedures that this section describes, you use both the Django administration site and the Course Administration Tool (CAT). The CAT is a web app that is included with the E-Commerce service. The CAT enables you to configure and manage products that are associated with the courses on your instance of the Open edX learning management system (LMS).

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 information, see Additional E-Commerce Features.