Sign Up
  1. Znode
  2. Solution home
  3. Commerce Portal
  4. Customizing Your Commerce Portal

Manage Order Statuses 

This feature was introduced in Znode 9.9


TABLE OF CONTENTS

Navigate to: Commerce Portal Settings > Manage Order Statuses

Introduction to Order Statuses

This allows admin users to create/edit order statuses, and define the status configurations directly from the admin console which will only impact the Commerce Portal. 

  • In “Commerce Portal Settings (under Dev Center)”  a new section named “Order Statuses” is defined where all the system-defined as well as manually created Order Statuses will be displayed. The following columns are shown:
    • Status Code
    • Status Name
    • Display Order
    • Show Customer
    • Editable
    • Send Email
    • Require Complete(ness)
    • Working/Not Shipped
    • System Defined
  • Status Name will be displayed with the selected background color and text (as defined while creating/editing the status).

     

Manage Order Statuses

  • Admin users can add new or edit/delete the previously created Order Statuses.  The add new/edit option will allow them to add/update the following information associated with an Order Status:
    • General Settings:
      • Status Code (Unique)
        • Status Code is a mandatory field.
      • Status Name
        • Status Name is used as the label for the Status
      • Display Order
        • Sets the Display Order of the Status when listed in the order status dropdown.
      • Background Color and Text
        • Sets the background and text colors for uniquely identifying the status in the grid view in the admin console as well as the commerce portal.
        • The administrator has a provision to see a preview while selecting the background color and text in the “Will Display As” section that will display the text from the name, the background color defined in the back color, and the text color defined in the text color. It will update the preview when either of the three fields reference changes.
      • Status Attributes (Yes/No): The following attributes will help in determining the configurations for the Status.
        • Show to the Customer (not considered in the v9.9 release)
          • If the value of the attribute is set to No, the customers can not see orders in this status in their Order History
          • If the value of the attribute is set to Yes, they can see orders in this status in their Order History.
        • Allow Editing
          • If the value of the attribute is set to No, commerce portal users will be able to view the Orders in this status in view mode only i.e. they will not be able to make any changes to the Order.
          • If the attribute's value is set to Yes, commerce portal users with the appropriate roles and permissions will be able to edit Orders in this status.
        • Send Email
          • If the value of the attribute Is set to No, order-related emails won't be sent to the Customers in this status.
          • If the attribute's value is set to Yes, emails will be sent to customers if the email templates are configured for that status in the admin console.
          • Status and Scenarios when the predefined email templates will be sent to the customers:
          • Order Placed Notification and Order Receipt
            • When the admin user updates the first Status with the "Require Completeness" (explained below) attribute set to Yes.
          • Shipping Receipt
            • When the admin user updates the first Status with the "Require Completeness" (explained below) attribute set to Yes.
          • Canceled Order Receipt
            • On Canceling the Order using system defined status "Canceled".
        • Require Completeness
          • If the attribute's value is set to No, order validation will not be triggered in this status.
          • If the attribute's value is set to Yes, order validations will be triggered before the order status is updated. If the order is validated successfully, the order status will be changed to this one. When the order validation is triggered, the following areas/sections will be validated:
            • User Information
              • If the user information has been removed while updating the order and an admin user attempts to change the status, validation will fail.
            • Flags associated with the Order
              • If any of the flag(s) have been in the open state then validation will fail.
            • Products
              • If no products have been added to the Order then validation will fail.
            • SKUs (NA/NA Combination)
              • If any of the products that are added to the Order have a configurable variant selected as NA then validation will fail.
            • Product Price
              • If the Price for any of the Products added to the Order is missing then validation will fail.
            • Product Status
              • If the Product Status for the product added to the Order Is set to NO then validation will fail.
            • IsObsolete
              • If the IsObsolete Status for the product added to the Order Is set to YES then validations will fail.
            • Inventory
              • If the product setting "Out-Of-Stock-Options" Is set to "Disable purchasing for out-of-stock products," inventory for that specific product must be checked, and if inventory = 0 then validation will fail.
              • Also if the product setting "Out-of-Stock Option" is set to "allow back ordering" then first the inventory of the product must be checked and if the inventory = 0 then back ordering will be checked and if the added quantity does not match the back ordering level then also the validation will fail.
            • Min and Max Quantity
              • If the quantity of the Product added to the Order does not match the Min and Max Quantity defined in the "PIM>>Product>>Product Settings," then validation will fail.
            • Product added in the Order is removed from the Catalog or Category
              • If the Product has been unassociated from the catalog/category or removed from the admin console then validation will fail.
            • Flags associated with the Line Item
              • If any of the flag(s) have been in the open state then validation will fail.
            • Ship To - Address
              • If Ship To - Address is missing then validation will fail.
            • Shipping Method
              • If the Shipping Method has not been selected then validation will fail.
            • Bill To - Address
              • If Bill To - Address is missing then validation will fail.
            • PO Number
              • If payment method is PO and the PO Number has not been added then validation will fail.
            • Vouchers
              • If the added Voucher has expired or the remaining voucher amount = 0 then validation will fail.
            • Coupons
              • If the added Coupon has expired or the available coupon quantity = 0  then validation will fail.
            • CSR Discount
              • If the added CSR discount exceeds Order's Sub Total then validation will fail.
        • Working/Not Shipped
          • This attribute is used to drive views (smart view) to display orders that have been in a working state or in fulfillment or recently fulfilled.
        • Trigger Finalized Date:
          • If this attribute Is set to "Yes", then the Finalized Timestamp will be set on the order when the order status is changed to this status.
        • Timeline Only if Active
          • This attribute will be used for the timeline display on an order (not implemented in the v9.9 release).
        • Set Order Lines
          • If this attribute Is set to "Yes" and if the Order status is changed to this status then the line items will also change to the same status.
    • Order Class:
      • This is used to determine which order classes this order status will be available for.
      • If no Order Classes have been associated with the Order Status, the message "No records found" will appear.
      • Admin users can associate new Order Classes as well as remove the already associated ones. 
      • To associate new Order Classes, the admin user can select “Add Order Class” button and select an order class to add.
      • All the associated Order Classes are displayed with the following column:
        • Order Class
        • Action
          • Delete
            • This will remove the Order Class associated with the Order Status.
    • Quick Status Buttons:
      • Admin users have the provision to define Quick Status Buttons to change the status of an Order with a single click from the commerce portal.
      • All the buttons that have been defined/created will be listed here with the following columns:
        • Button Text
        • Status
        • Display Order
        • Required Permission
      • If no buttons have been created for an Order Status, the message "No records found" will appear.
      • Admin users can create new buttons as well as edit/delete the existing ones.
      • To create/edit the buttons, the admin users have to add the following information:
        • Button Text
          • Button Text can also be termed as a Button Name that will be used in an Order Class.
        • Status
          • This is a dropdown field containing a list of all the statuses associated with the Order Class selected above (other than the one being edited).
        • Display Order
          • This input determines the Display Order of the Button.
          • Buttons with the lowest number will be displayed on the left, and those with the highest number will be displayed on the right, regardless of whether they are Class Buttons or Status Buttons.
        • Required Permission:
          • This dropdown field lists all commerce portal permissions. The admin user can decide which permission the user must have in order to see this button.

Important Points:

  • Status Attributes: Show to the Customer and Timeline Only if Active has not been considered in the v9.9 release.
  • In Order/Product Validations, Validation related to the IsObsolete flag is not implemented in the v9.9 release.
  • Admin Users will not be able to delete the Order Statues that are system-defined or have been used in Orders.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

Customizing Your Commerce Portal