This page provides Business administrators a user guide for the Order microservice for the Infosys Equinox platform.
Getting Started
Overview
The Order microservice (“Order”) allows:
- Order Managers to review customer orders made on the Business’ storefront.
- Customer Service Representatives (CSR) to manage customer orders on their request.
As with all microservices in the Infosys Equinox Commerce solution, Order is associated with a store managed through the Store microservice.
For a detailed overview of the Order microservice, see Order Microservice.
Service Glossary
- Business – the parent of a store or set of stores. The basic use of a business is to manage common sets of users, catalogs, and other services for the stores associated with the business.
- Business Admin – a role that manages business settings, creates and manages stores, and enables microservice(s) for a business.
- Collections – configure the behavior of the microservices by providing a set of properties that control the behavior of the microservice when launched.
- Customer – a consumer or buyer on the Business’ storefront or retail website.
- Fulfillment – the process of picking items from the warehouse, packing, and shipping (distributing) to consumers.
- Late Return Fee – This fee is charged to the customers based on the return window. Based on the return window duration, a late return fee (a percentage based fee or fixed fee) is calculated and deducted partially or fully or no deduction if the item is returned within the window. The return window is configurable in the collection properties of Cart service. This charge is not applicable to the newly added items to the cart.
- Omni-channel – a multichannel approach to sales that seeks to provide consumers with a seamless shopping experience, whether shopping online (on a desktop or on a mobile or tablet device), by telephone, or in person at a physical store (https://searchcio.techtarget.com/definition/omnichannel).
- Product – a good/service/idea that has a combination of tangible and intangible attributes and can have multiple variants which are referred to as stock-keeping units (SKUs). In Infosys Equinox Commerce, the consumer/buyer evaluates a product (e.g. a men’s dress shoe available in black and brown and in sizes from 10 to 15), but actually purchases a SKU associated with the product (e.g. a black colored version of the dress shoe in size 12) rather than the product itself.
- Purchase Order – The purchase order is a payment method that a buyer chooses to make a payment against the order placed in a B2B scenario. In the CSR flow, where a CSR tries to place an order on behalf of the buyer user, the CSR can choose the “PO” as a payment method and provide a PO number to complete the payment.
- Restocking Fees – This fee is charged to the customer for restocking the items back to the inventory.
- Store – represents a specific physical location or online store of a business.
- Stock Keeping Unit (SKU) – a particular variant of a product that is available for purchase by a consumer or buyer.
- Storefront – consumer-facing website that presents products, content, and promotions across multiple channels (i.e. desktop, tablet, and mobile).
Accessing the Order Console by an Admin User
To access the Order Admin console,
- Log in to the Foundation service for your business (URL provided by Infosys Equinox):
- Click the Orders option from the StoreOps menu:
You will see the Total Orders page showing all the orders of the store.
Order Functionality Overview
Getting Started | Total, In Progress, Failed, Back Orders
In the Orders Admin console, an order admin or CSR admin can perform the following functionalities:
- generate product sales reports, orders fulfilled reports, and sales product reports
- export the order reports in a .csv format file
- view orders of all the customers irrespective of the order status
- view the orders that are in progress and not yet fulfilled
- view failed orders, back orders, canceled orders, replaced, exchanged, and reconciled orders
- navigate to a particular to view the order, shipping, payment, and product details
- import all the orders from your local computer
- track an item of an order
- update the status of an order
- return, replace, exchange, reconcile item(s) on behalf of a customer
- add notes to the order
Orders Tab
Order Functionality Overview | Returned Orders
In the Orders tab, you can:
- view the total orders of the store irrespective of the status
- view the in progress orders that are not yet fulfilled
- view the failed orders
- view back orders
The order categorization tabs such as Total Orders, In Progress Orders, Failed Orders, and Back Orders are configurable via the collection property “orderCategorizationTabs”. For more information, see Collection Properties – Order.
Order Statistics
The Order Statistics page allows an order admin/business admin to generate various reports such as product sales reports, orders fulfilled reports, and sales product reports and export them in a .csv format file.
Prerequisites: The Order Statistics tab appears only if the Order Statistics value is defined in the collection property ‘orderCategorizationTabs‘. Refer to Collection Properties – Order – Infosys Equinox Developer Portal.
With Order Statistics, you can
- generate various reports for a specific period and time frame.
- add additional fields to the reports.
- add rule-based conditions to generate the reports.
- compare the data with a specific duration.
- export the reports in a CSV format file.
- view the graphical chart of the generated reports.
- generate graph based on Average Order Price, Orders, Discounts, Gross Sale, Net Sale, Return, Shipping, Tax, Total Sales, and Additional Fees
- download the graphical report in a PDF or PNG format file.
Generating the Order Statistics Reports
You can generate multiple reports in the order statistics.
To generate reports,
- In the Orders Admin console, click the ORDER STATISTICS tab.
The Order statistics page appears: - Click on the required fields and generate the reports.
The following table describes the fields in the Order Statistics page:
Field Description Select the required data filter. The filter varies based on the selected report types. Once you select these filters, in the Order Statistics graphical section, the graph is displayed accordingly.
Note: To generate order reports based on specific values such as PV, CV, SB, Customer Type etc. to appear as custom fields, you should configure those values in the collection property “orderCategorizationTabs”. Refer to Collection Properties – Order – Infosys Equinox Developer Portal.
For example, for the Sales Over Time report the filter values are:
Lists these report types. Sales Over Time – This report generates the total number of orders, the total gross and net sales that the business achieved for the selected period of time, the total discounts issued, etc. You can breakdown the reports by hourly, daily, weekly, monthly, by hour of day, or by day of week. If you DO NOT select any time frame, then the hourly time frame is set by default. You can also compare the generated data with a different date range. If required, you can filter data based on order details, customer details, sales channel, and/or shipping location.
FulFilment Report – This report provides the overall data of orders based on the order status such as Submitted to fulfilment, Shipped, and canceled. You can breakdown the reports by hourly, daily, weekly, monthly, by hour of day, or by day of week. If you DO NOT select any time frame, then the hourly time frame is set by default. You can also compare the generated data with a different date range. You can filter the data for all channels or filter by channel like Storefront, Online Store, Facebook, Instagram or any channels other than the listed channels.
Sales by Product – This report generates summary of net quantity that the business achieved for the selected period of time. It also displays the breakdown of products, the total gross and net sales that the business achieved for the selected period of time, the total discounts issued, etc. If required you can breakdown the report further by selecting Hour, Day, Week, or Month. You can also filter data based on product details.
Basic Order Report – This report lists orders that are submitted for fulfilment.
Select the required data range for which you can view the report. By default, two weeks are selected. You can update the required date and click on apply.
Note: You can also compare the report with the defined date range. Refer toIndicates the customized timeframe. The time frame option is applicable only for the Sales Over Time and Fulfillment reports. You can view the reports on various time frames:
You can generate the Fulfilment report based on the various channels. Allows you to compare the report with the defined date range. The Comparison Date option appears only when you click the icon and select Comparison Date. You can select the preferred data range and compare the report with the previous date range.
For example, the compared data appears as below:
You can click the Filters button to generate and filter order data in the report. You can configure conditions using the order and custom fields, rules, and logical operators. For information, refer to Configuring Conditions.
You can select the required custom fields for the graphical view of the reports. The selected filter appears above the graph. For example, for Sales Over Time report, the custom fields appear by default are Average Order Price, Orders, Discounts, Gross Sales, Net Sales, Returns, Shipping, Tax, and Total Sales.
Note: The color and the chart view vary based on the selected custom fields and the timeframe.
Displays the graphical chart view of the generated report.
For example, report type Sales Over Time with hourly timeframe:
These are the custom fields that appear based on the fields that you select in the filter section. You can also click to sort the data in the ascending or descending order.
Note: These custom fields vary based on the report type you select.
The table grid displays the corresponding report data that you see in the graph. Note: When there are no data for specific fields, the table grid display “0” records.
You can click on these icons to export the chart report in the PNG or PDF file.
Exporting the Order Statistics Reports
You can export the order statistics reports in the .CSV format file. To export the order statistics report,
- In the Orders Admin console, click the ORDER STATISTICS tab.
- In the Order statistics page, click the Export.
- In the Export your report pop-up page, click the Include Comparison Data option to compare the reports. This is optional.
- Click Export. The report data is exported to your local computer.
Configuring Conditions
Overview
You can add one or more rules or group of rules and manage filters to generate order reports. You can create a maximum of three levels of groups for each order report. By default, a row will be shown to add a rule. You can choose to add multiple rules. After setting the conditions, you may choose to click on Generate Filters to check if the set condition is appropriate for your use case.
Options for Configuring Rules or Group of Rules
The following table describes various options available in configuring conditions:
Option Available in a Condition | Description |
Set logical operators such as NOT and OR in a rule. These operators apply the rules that are a direct descendant in the condition builder. The logical operators display the list of parameters associated with the report types that you specify in the Report field. For example, for the Fulfilment Report, the parameters relevant to Status such as Submitted to Fulfilment, Shipped, cancelled are displayed. Example: To create a condition where you need to generate report for the orders that are in Submitted to Fulfilment status for a specific Collection ID, you can set the following condition: Note: To manage filters for orders based on Fulfilment, ensure that you select Fulfilment Report in the Report field. |
|
Add one or more rules in the condition. For example, to create a condition where you need to generate report for the orders that are in Submitted to Fulfilment status for a specific Collection ID and Store ID, you need to add rules by clicking the Add rule button: |
|
Add a collection of rules within the group in the condition. For example, to create a condition where you need to generate report for the orders that are in Submitted to Fulfilment status for a specific Collection ID or for a specific Store ID, you need to add rules and group as shown below: |
|
Operand/Operators/Values |
Select the operands and operators for the condition. You can create different conditions by changing the combination of operands and operators. You can enter the required value for the selected item. |
Delete a rule or a rule group of conditions. |
|
Generate Filter and validate against your appropriate use case, after creating conditions using the condition builders. Click this button to view the generated filter. For example, |
Total Orders
After navigating to the Order console, navigate to the Total Orders page where you can view all the orders irrespective of the status. By default, it displays the total number of orders for 6 months period till the current date. However, you can use a filter to specify your own date range.
As an order admin or CSR admin, you can filter and navigate to a particular order to view the order details, notify the customer via email about the details of the order with note information, or send an order confirmation email to the customer.
Viewing All Orders
To view the total orders, click Orders in the left navigation panel, and then click the Total Orders tab. Here, you can click on a particular order to view the order details.
Note:
- To filter and view the required orders, click , select the required search criteria, and then click the Go button. The list of orders matching the search criteria is displayed.
- If the store type is B2B or B2B2C, the Account ID dropdown list appears additionally in the search filter.
Canceling an Order
A CSR can cancel the order on behalf of the customer if the order status is Ready_To_Edit.
To cancel an order,
- In the Orders Admin console, click the Total Orders tab.
- Navigate to the required order.
- If the order status is Ready_To_Edit, then in the Action dropdown list, click the Cancel option to cancel the order.
Updating the Status of a Product
A CSR can update the item with the next available status or status that comes later in the workflow. If the status is Submitted_to_Fulfilment, the Update Status option appears in the Action dropdown list at the item level.
To update the status of an item,
- In the Orders Admin console, click the Total Orders tab.
- Navigate to the required order.
If the item’s status is Submitted To Fulfilment, the Action dropdown list appears. - Click the Action and select Update Status.
- In the Update Status pop-up, select Shipped or Unable to Ship.
- Enter the shipment ID and tracking URL.
- Select the required quality that you want to update the status.
- Select the shipment date to deliver the item(s) on this specified date.
- Click the Update button.
Returning Product(s)
A CSR can return item(s) on behalf of a customer if the item is defective, the item doesn’t meet their expectations, bought/received the wrong item, etc. The item(s) can be returned at the item level.
To return product(s) on behalf of a customer,
- In the Total Orders tab, filter and click the required order.
- In the order’s Overview section, select Return from the Action dropdown list.
- Select the required product(s):
Once you select the product(s), the following fields appear:
Field Description Reasons* Select a reason from the dropdown list for returning the item(s). Comments* Enter the required comments. This field is required when returning the item(s). Quantity* Select the required quantity to be returned from the dropdown list. The quantity can be partial or full. - Click the Proceed button. The following checkout page for Return appears:
- Check all the details and add the warehouse address if required.
- Select the appropriate payment method for refunding the amount to the customer.
- Click the Submit button.
Note: To ignore returning the product(s), click the Cancel button. - After placing the order successfully, the order type is shown as “Return”.
Replacing Product(s)
A CSR can replace item(s) with an identical or another item(s) on behalf of a customer if the item received by the customer is defective, damaged, or for any other reasons. The item(s) can be replaced at the item level.
To replace product(s) on behalf of a customer,
- In the Total Orders tab, filter and click the required order.
- In the order’s Overview section, select Replace from the Action dropdown list.
- Select the required product(s):
- Once you select the product(s), the following fields appear:
Field Description Reasons* Select a reason from the dropdown list for replacing the item(s) . Comments* Enter the required comments. This field is required when replacing the item(s). Quantity* Select the required quantity to be replaced from the dropdown list. The quantity can be partial or full. - Click the Proceed button. The checkout page for Replace appears.
- Check all the details and add the warehouse address if required.
- Select the appropriate payment method for refunding the amount to the customer.
- Click the Submit button.
Note: To ignore returning the product(s), click the Cancel button. - After placing the order successfully, the order type is shown as “Replace”.
Exchanging Product(s)
When a wrong SKU item is delivered to a user, the CSR can accept the return of the wrong SKU item and deliver the right SKU for which the order has been placed by the user. The item(s) can be exchanged at the item level.
To exchange the incorrect SKU items with the correct SKU items,
- In the Total Orders tab, filter and click the required order. 
- In the order’s Overview section, select Exchange from the Action dropdown list.
- Select the required product(s):
Once you select the product(s), the following fields appear:Field Description Reasons* Select a reason from the dropdown list for exchanging the item(s) . Comments* Enter the required comments. This field is required when returning the item(s). Quantity* Select the required quantity to be returned from the dropdown list. The quantity can be partial or full. - Click the Proceed button. The following checkout page for Exchange appears:
- In the Exchanged Item(s) section, click the Add PRODUCT button and add the required product(s).
- View the item(s) in the Product Quickview page and click the Add to Cart button.
Note: If required, before submitting, you can delete the added item(s) by clicking the Delete icon in the Exchanged Item(s) section. - In the Exchanged Item(s) section, select:
- Ship It: to deliver the item(s) to the selected shipping address.
- Pick It Up: to pick up the item(s) from a nearby store. Enter the zip code, select the distance, and then select the location of the warehouse address from where you want to pick up the item(s).
- Select a shipping method.
- Select the warehouse address if required.
- Make the payment method for refunding the amount to the customer:
- Select the appropriate payment method.
- Click Add Payment to add a payment method.
- Click the Submit button.
Note: To ignore returning the product(s), click the Cancel button. - After placing the order successfully, the order type is shown as “Exchange”.
Making Correction in the Inventory
A CSR can reconcile and correct the item(s) at the item level in the inventory on behalf of a customer.
To reconcile the item(s) in the inventory,
- In the Total Orders tab, filter and click the required order. 
- In the order’s Overview section, select Correction from the Action dropdown list. 
- Select the required product(s):
Once you select the product(s), the following fields appear:Field Description Reasons* Select a reason from the dropdown list for returning the item(s) . Comments* Enter the required comments. This field is required when returning the item(s). Quantity* Select the required quantity to be returned from the dropdown list. The quantity can be partial or full. - Click the Proceed button. The checkout page for Correction appears.
- In the Correction Item(s) section, click the Add PRODUCT button and add the required product(s).
- View the item(s) in the Product Quickview page and click the Add to Cart button.
Note: If required, before submitting, you can delete the added item(s) by clicking the Delete icon in the Correction Item(s) section. - In the Correction Item(s) section, select:
- Ship It: to deliver the item(s) to the warehouse address.
- Pick It Up: to pick the item(s) from a nearby store. Enter the zip code, select the distance, and then select the location of the warehouse address from where you want to pick the item(s).
- Select the warehouse address.
- Make the payment method for refunding the amount to the customer:
- Click Add Payment to add a payment method.
- Add or choose the billing address.
- Click the Submit button.
Note: To ignore returning the product(s), click the Cancel button. - After placing the order successfully, the order type is shown as “Correction”.
Tracking a Shipment of a Product
Once the order is placed and fulfilled, a CSR can track the order’s progress at the item level.
To track shipment at the item level,
- In the Orders Admin console, click the Total Orders tab.
- Navigate to the required order.
- In the Products section, select Track Shipment from the Action dropdown list to track the shipment status of that item.
Resending Email(s)
A CSR can resend emails from the order creation until the current status to the provided email ID of the customer.
To resend the emails to the customer,
- In the Orders Admin console, click the Total Orders tab.
- Navigate to the required order.
- Click the Resend Email button.
The Resend Email pop-up appears: - Add a note information.
- Click the Send button to send the order details to the provided email ID.
Note: To ignore resending the email, click the Cancel button. - Click the Done button to go back to the order details page of the customer.
Printing Shipping Label
To print a shipping label,
- In the Orders Admin console, click the Total Orders tab.
- Navigate to the required order.
- In the required product, select Print Return Label from the Actions dropdown list.
- The print label screen appears as shown below:
Linking Orders
To link guest orders with the registered user ID,
- In the Orders Admin console, click the Total Orders tab.
- Navigate to the required order.
- Click the Link Order button:
- In the Link Order pop-up, enter the email address of the registered user and add a note information.
- Click the Link button.
Note: To ignore linking to the registered email address, click Cancel.
In Progress Orders Tab
The In Progress Orders page shows the list of orders that are placed, but not yet been fulfilled to the customers. By default, it displays the orders that are in progress for a period of 6 months till the current date. However, you can use a filter to specify your own date range.
As an order admin or CSR admin, you can filter and navigate to a particular in-progress order to view the order details, notify the customer via email about the order details with note information, or send an order confirmation email to the customer.
To view all the in-progress orders, click Orders in the left navigation panel and then click the In Progress Orders tab. Here, you can click on a particular order to view the order details.
Note:
- To filter and view the required orders, click , select the required search criteria, and then click the Go button. The list of orders matching the search criteria is displayed.
- If the store type is B2B or B2B2C, the Account ID dropdown list appears additionally in the search filter.
Failed Orders Tab
The Failed Orders tab displays the orders that are failed and cannot be fulfilled to the customers. For example, it could be due to some technical reasons, payment-related issues (card expired or insufficient balance in that card), unsuccessful delivery, incorrect billing information provided during checkout, etc.
Viewing All Failed Orders
To view the failed orders, click Orders in the left navigation panel, and then click the Failed Orders tab. Here, you can click a particular order to view the order details.
Note:
- To filter and view the required orders, click , select the required search criteria, and then click the Go button. The list of orders matching the search criteria is displayed.
- If the store type is B2B or B2B2C, the Account ID dropdown list appears additionally in the search filter.
Back Orders Tab
The Back Orders tab displays the back orders of all the customers. The back orders are listed in this tab when the item is temporarily out-of-stock in the storefront, but still the customer places the order. This tab appears in the Orders’ Overview page, when the following properties are configured in the Order Admin console:
- store property “enableBackOrder” is set to True as additional property in the Stores > Advanced tab
- back order is defined in the collection property “orderCategorizationTabs”. For more information, see Collection Properties – Order.
To view the back orders, click Orders in the left navigation panel, and then click the Back Orders tab. Here, you can click on a particular order to view the order details.
Note:
- To filter and view the required orders, click , select the required search criteria, and then click the Go button. The list of orders matching the search criteria is displayed.
- If the store type is B2B or B2B2C, the Account ID dropdown list appears additionally in the search filter.
Bulk Import Order Details
You can bulk upload orders using an Excel sheet or CSV file format from your local computer.
To bulk upload the order data onto the Order Admin console,
- Click the ORDER IMPORTS tab in the All Orders section.
- Click the Add File.
(OR)
Drag and drop the file. - Once the upload is successful, click the Import.
The file is uploaded to the Order Admin console.
Note:- To remove the file, click the Delete icon.
- After successful import, you view the summary details.
Returned Orders
The Return tab lists the orders that are submitted for returning the item(s) by a CSR on behalf of customers. The item is returned for one of the following reasons: if the item is defective, the item doesn’t meet their expectations, bought/received the wrong item, etc. The item(s) can be returned at the order/item level.
To view the list of orders that are submitted for returning the order or order item(s), click the Return tab in the left navigation panel. You can click a particular order to view the order details.
Note:
- To filter and view the required orders, click , select the required search criteria, and then click the Go button. The list of orders matching the search criteria is displayed.
- If the store type is B2B or B2B2C, the Account ID dropdown list appears additionally in the search filter.
Canceled Orders
Returned Orders | Exchanged Orders
The Cancelled Orders tab lists the orders that are submitted but canceled by the CSR or Admin on behalf of the customers. A reason is associated while canceling the order.
Note: The canceled order will not be fulfilled to the customer.
To view the canceled orders, click the Cancelled Orders tab in the left navigation panel. Here, you can click on a particular order to view the order details.
Note:
- To filter and view the required orders, click , select the required search criteria, and then click the Go button. The list of orders matching the search criteria is displayed.
- If the store type is B2B or B2B2C, the Account ID dropdown list appears additionally in the search filter.
Exchanged Orders
Exchanged Orders | Replaced Orders
You can view the orders that are submitted for exchanging the item(s). The exchange flow is initiated when a wrong SKU item is delivered to the customer. A CSR can accept the return of the wrong SKU item and deliver the right SKU. The item(s) can be exchanged at the order/item level.
The Exchange tab appears in the left-navigation panel as per the configurations defined in the collection property “AdditionalLeftNavOptions”.
To view orders that are submitted for exchange, click the Exchange tab in the left navigation panel. Here, you can click on a particular order to view the order details.
Note:
- To filter and view the required orders, click , select the required search criteria, and then click the Go button. The list of orders matching the search criteria is displayed.
- If the store type is B2B or B2B2C, the Account ID dropdown list appears additionally in the search filter.
Replaced Orders
Replaced Orders | Reconciled Orders
The Replace tab lists the orders that are submitted for replacement. A CSR initiates replacing item(s) with an identical or another item(s) on behalf of a customer if the item received by the customer is defective, damaged, or for any other reasons. The item(s) can be replaced at the order/item level.
The Replace tab appears in the left-navigation panel as per the configurations defined in the collection property “AdditionalLeftNavOptions”.
To view the list of orders that are submitted for replacing the order or order item(s), click the Replace tab in the left navigation panel. Here, you can click on a particular order to view the order details.
Note:
- To filter and view the required orders, click , select the required search criteria, and then click the Go button. The list of orders matching the search criteria is displayed.
- If the store type is B2B or B2B2C, the Account ID dropdown list appears additionally in the search filter.
Reconciled Orders
The Correction tab lists the orders that are placed for reconciliation of the item(s) at the order/item level in the inventory. A CSR initiates replacing item(s) with an identical or another item(s) on behalf of a customer if the item received by the customer is defective, damaged, or for any other reasons. The item(s) can be replaced at the order/item level.
The Correction tab appears in the left-navigation panel as per the configurations defined in the collection property “AdditionalLeftNavOptions”.
To reconcile the item(s) in the inventory, click the Correction tab in the left navigation panel. Here, you can click on a particular order to view the order details.
Note:
- To filter and view the required orders, click , select the required search criteria, and then click the Go button. The list of orders matching the search criteria is displayed.
- If the store type is B2B or B2B2C, the Account ID dropdown list appears additionally in the search filter.
Revision History
2023-11-21 | JP, SD – Updated the document for Release 8.15.4
2023-06-07 | SW – Updated the document for Release 8.14.0
2022-12-15 | JP – Updated the document for Release 8.13.0
2022-11-07 | JP – Updated the document for Release 8.12.0
2022-04-10 | JP – Fixed link and http issues.
2020-12-30 | HM – Updated the document for images for 8.11.0.
2020-05-25 | JP – Updated the document for Release 8.8.0.
2020-03-28 | AM – Minor copyedit.
2020-01-31 | JP – Updated the document for Release 8.6.0.
2019-11-29 | JP – Revamped the document.
2019-09-13 | JP – Updated contents for September 2019 release.
2019-07-22 | JP – Updated contents for July 2019 release.
2019-06-10 | PLK – Minor copyedits.
2019-05-08 | Ananthi – Fixed the link issues.
2019-05-04 | PLK – Updated TOC links and page formatting.
2019-01-23 | PLK – Content uploaded. TOC and links added.