Guides and Examples
...
Orders
Orders Overview
20 min
in the nue self service api, orders represent purchase transactions between customers and your business orders are the foundation for creating subscriptions, managing product deliveries, and generating invoices throughout the customer lifecycle core order concepts orders in nue handle the complete purchase process, from initial quoting through fulfillment and billing draft orders preview orders that show pricing and details without financial impact activated orders finalized orders that create subscriptions, assets, and invoices change orders modifications to existing subscriptions (quantity changes, upgrades, renewals) order products individual line items within an order representing specific products and quantities order lifecycle stages understanding the order lifecycle helps you implement the right workflows for your customers 1\ order creation and preview create draft orders to show customers pricing and configuration include preview invoices to display future billing details support complex product bundles with configurable add ons generate pdf quotes for sharing and approval workflows 2\ order activation transform draft orders into active transactions create subscriptions, entitlements, and assets automatically generate and optionally activate invoices integrate with external payment system (stripe) 3\ order management retrieve order history for customers track order status and details access related subscriptions, assets, entitlements, and invoices generate change orders for modifications order types and use cases new orders new orders create fresh customer relationships and subscriptions initial purchases first time customer orders expansion orders additional products for existing customers change orders change orders modify existing subscriptions without creating new ones quantity updates increase or decrease user counts product upgrades/downgrades move between service tiers term changes modify subscription length renewals extend subscription terms cancellations end subscriptions on specific dates key order components order products and bundles simple products individual items with straightforward pricing bundle products parent products with configurable add ons product options components within bundles (required, optional, recommended) nested bundles up to 3 levels of bundle hierarchy for complex offerings pricing and discounts price book entries define product pricing and billing terms volume discounts automatic pricing tiers based on quantity price tags manual discount codes and promotional pricing tax calculation support for location based tax rates based on the shipping address billing integration preview invoices show customers future billing before activation invoice generation create billing documents upon order activation payment processing integrate with stripe and other payment systems billing periods support monthly, quarterly, annual, and custom billing cycles order data architecture core relationships orders connect to several key objects in the nue platform customers who is making the purchase products what is being purchased subscriptions ongoing service agreements created from orders assets physical or virtual items delivered invoices billing documents for payment collection external system integration orders can synchronize with external platforms crm systems salesforce account integration payment processors stripe customer and payment method linking order status management orders progress through several status states draft preview mode, no financial impact activated finalized and creating downstream objects canceled terminated before activation change orders follow a similar pattern but modify existing subscriptions rather than creating new ones example order management workflow here's one common order lifecycle pattern create draft order → 2 activate order → 3 retrieve orders → 4 create change order → 5 generate quote link → 6 activate changes → 7 sync to salesforce flexible workflow options you can use any combination of these capabilities based on your business needs simple purchase flow create draft → activate → done approval based flow create draft → generate quote link → review → activate self service changes retrieve orders → create change order → activate changes quote heavy process create draft → generate quote link → modify → generate new quote → activate key requirements draft first all orders must start as drafts for preview and validation changes after activation only activated orders can be modified with change orders salesforce sync happens automatically throughout the process create draft order preview pricing and configuration without financial impact activate order finalize the purchase and create subscriptions retrieve orders view order history and current subscriptions create change order modify existing subscriptions (quantity, upgrades, renewals) generate quote link create shareable magic links that allow customers to view and download order quotes via secure urls (no authentication required) activate changes implement subscription modifications sync to salesforce automatic synchronization of all order data to salesforce throughout the process note the "quote link" generates a magic link (secure url) that customers can use to view their draft order details and download formatted quotes this isn't a direct pdf file but rather a link to a web page that can display or generate pdfs getting started with orders to begin working with orders in the nue self service api create customers establish customer records before creating orders understand products familiarize yourself with your product catalog and pricing follow the complete workflow start with the getting started guide for the end to end process test in sandbox practice the full lifecycle in a test environment implement advanced scenarios add complex bundles and approval workflows next steps explore the order management guides in sequence getting started with order management learn the complete order lifecycle with practical examples advanced order workflows implement complex scenarios like enterprise bundles and approval workflows order data reference complete field documentation and validation rules each guide builds upon the previous one, providing a comprehensive foundation for implementing orders in your application