Summary
Order & Order Line Item Custom Attributes are used to store additional data related to an order or order item that may not be part of the standard data model.
These attributes are configurable in the Order Management System (OMS).
Order & Order Line Item Custom Attributes can be defined at client level.
These can be created or updated by various systems such as the ERP or Marketplace.
They can be used to fulfill feature requests relating to adding some attributes in inward/outward order every now and then.
Below are the limits on the number of Inward/ Outward Order/ Order Line Item Attributes:
Property | Inward/ Outward Order Attributes | Inward/ Outward Order Line Item Attributes |
|---|---|---|
Maximum number of Custom Attributes allowed | 10 | 10 |
Displayable Attributes | 5 | 3 |
Highlightable Attributes | 2 | 2 |
Searchable Attributes | 5 (first 5 attributes) | 0 |
The existing inward/ outward order attribute keys can be updated. There is no restriction on order here.
The existing inward/ outward order item attribute keys can be updated. There is no restriction on order/ order item here.
Outward Order & Order Line Item Attributes
Outward Order & Order Line Item Attributes Configuration
In OMS, a new screen is added under Outward Orders section to configure Order and order item-level attributes. Go to Order Attributes Configuration.
As attributes can be defined at client level, choose the client.
The order/ Order Line Item attributes which are configured will be displayed. Order Attribute Currency is a standard order attribute which is present in system by default.
To define a new custom order attribute, click on Add button. Enter the Attribute name and click Submit button.
The added attribute will be displayed as shown.
The order attributes can be made Searchable, Displayable and Highlightable in various screens to users by clicking the small icons present against the attribute as shown below. The limit on these were mentioned in the beginning of this document.
A Custom Order Attribute can be deleted by clicking Delete icon. Please note, an attribute can be deleted only when unselect Searchable, Displayable and Highlightable icons for that attribute(if any of those were enabled previously).
Similarly, a Custom Order Line Item Attribute can be added by clicking Add button under Order Line Attributes.
The Order Line Item attributes can be made Displayable and Highlightable in various screens to users by clicking the small icons present against the attribute as shown below. The limit on these were mentioned in the beginning of this document.
The name can be edited for any custom order/ order line item attributes. Click Edit button.
Name can be edited now.
Outward Order / Item Attribute creation during Outward Order creation:
Single order creation:
User selects client, based on which attribute keys are displayed.
The user selects the outward order and order item custom attribute keys that are applicable for the current outward order.
Outward Order Item upload CSV will consist of the order / order item attribute fields.
User will provide the details and upload this.
On success,
Outward Order attributes will be created for the inward order for the provided attribute keys.
Outward Order Item attributes will be created for the inward order item for the provided attribute keys.
Multiple order creation:
No changes in the existing workflow
- User can add inward order / item attributes for multiple orders using Outward Order / Item Attribute bulk update workflow in UI
Outward Order / Item Attribute update:
Customer Support Panel:
Provided a mechanism to update outward order/order item for the outwards orders which are visible in the Customer Support Panel.
The functionality is as follows:
If the attribute value is already present in the order, then update it with the new value.
If a new attribute is provided (which is defined in the client), then add the new attribute value for the order/order item.
If an attribute value was populated for the order during order creation, but it is not provided during the update, the attribute value won’t be modified.
UI Workflow (Outward Order/ Order Item Attributes values update):
Please follow the below steps to update the outward order attributes value:
Go to outward Order-> Create order screen
Go to the Add / Edit Custom Attributes tab.
Select the client and location.
Select either Order or Order Line Item in the Attribute type to update.
Based on Attribute type Selection, Select the outward order/ order line item attributes that need to be added/updated for the orders.
Download the template
Add data in a CSV & upload consisting of fields - channel order ID, attribute1, attribute2… (for multiple orders) Maximum Row Limit for CSV: 5000
The update functionality works as follows:
If the attribute value is already present in the order, then update it with the new value.
If a new attribute is provided (which is defined in the client), then add the new attribute value for the order/order item.
If an attribute value was populated for the order during order creation, but it is not provided during the update, it doesn’t modify the attribute value.
Outward / Sub Order attribute fetch/view
Outward Order Search Screen:
The order and order item attributes will be visible in the Outward order search screen. This will be loaded only when a particular order is viewed.
Sub Order Search Screen:
The order and order item attributes will be visible in the Sub order search screen. This will be loaded only when a particular order is viewed.
WMS Order Manager:
Packing screens:
Display the outward order item attribute for the particular SKU / order for which the item is being packed.
Pick Order Group Search
Select the client.
In case outward order attributes are configured for the client, provide a drop down for with all the searchable attributes keys.
The user can search based on order attributes, by selecting the required attribute key and providing the value that needs to be searched.
All the eligible B2B orders with the attribute value for the given attribute key will be displayed.
Sales Posting (Additional)
In case the order / order item attributes are present for the outward order, send the details for the corresponding sub orders in sales posting.
- Currently, we don’t have any restrictions on order / item attribute value update. In case the attributes gets updated even after the postings are sent it will not be handled at our end.
Packing (Additional)
In case the order / order item attributes are present for the outward order, send the details for the corresponding sub orders for all the SKUs which are present in the shipment.
Audits are captured client level when attribute key gets created / updated. There are no order level audits for attributes similar to sku master
Which screens will show these attributes and where not?
Order search screen in OMS, Order Manager screen in WMS, any other screen asked by client can be considered later.
Attribute Creation
Inward order attributes
Inward order item attributes
Outward order attributes
Outward order item attributes
Inward Order & Order Line Item Attributes
Inward Order & Order Line Item Attributes Configuration
In OMS, a new screen is added under Inward Orders section to configure Order and order line item-level attributes. Go to Order Attributes Configuration.
As attributes can be defined at client level, choose the client.
The order/ Order Line Item attributes which are configured will be displayed. Order Attribute Currency is a standard order attribute which is present in system by default.
To define a new custom order attribute, click on Add button. Enter the Attribute name and click Submit button.
The added attribute will be displayed as shown.
The order attributes can be made Searchable, Displayable and Highlightable in various screens to users by clicking the small icons present against the attribute as shown below. The limit on these were mentioned in the beginning of this document.
A Custom Order Attribute can be deleted by clicking Delete icon. Please note, an attribute can be deleted only when unselect Searchable, Displayable and Highlightable icons for that attribute(if any of those were enabled previously).
Similarly, a Custom Order Line Item Attribute can be added by clicking Add button under Order Line Attributes.
The Order Line Item attributes can be made Displayable and Highlightable in various screens to users by clicking the small icons present against the attribute as shown below. The limit on these were mentioned in the beginning of this document.
The name can be edited for any custom order/ order line item attributes. Click Edit button.
Name can be edited now.
Order / Item Attribute creation during Inward Order creation:
Single order creation:
The user selects the order and order item custom attribute keys that are applicable for the current inward order.
Inward Order Item upload CSV will consist of the order / order item attribute fields.
User will provide the details and upload this.
On success,
Order attributes will be created for the inward order for the provided attribute keys.
Order Item attributes will be created for the inward order item for the provided attribute keys.
Multiple order creation:
No changes in the existing workflow
- User can add inward order / item attributes for multiple orders using Inward Order / Item Attribute bulk update workflow in UI
Inward Order / Order Item Attribute update:
Inward Order Attribute update
Please follow the below steps to update the outward order attributes value:
Go to Inward Order-> Create order screen
Go to the Add / Edit Custom Attributes tab.
Select the client and location.
Select either Order or Order Line Item in the Attribute type to update.
Based on Attribute type Selection, Select the Inward order/ order line item attributes that need to be added/updated for the orders.
Download the template
Add data in a CSV & upload consisting of fields - channel order ID, attribute1, attribute2… (for multiple orders) Maximum Row Limit for CSV: 5000. In case of Order Line Item, CSV contains channel order ID, Client SKU ID, attribute1, attribute2… (for multiple orders)
The add/ update functionality works as follows:
If the attribute value is already present in the order, then update it with the new value.
If a new attribute is provided (which is defined in the client), then add the new attribute value for the order/order item.
If an attribute value was populated for the order during order creation, but it is not provided during the update, it doesn’t modify the attribute value.
Order attribute fetch/view
Inward Order Search Screen:
The order and order item attributes will be visible in the Inward order search screen. This will be loaded only when a particular order is viewed.
GRN / Stickering Item Screen:
Display the inward order item attribute for the particular SKU / order for which the item is being GRNed.
Select SKU Modal:
Inward Order Posting (Additional)
In case the order / order item attributes are present for the order, send them during inward order posting.
- Currently, we don’t have any restrictions on order / item attribute value update. In case the attributes gets updated even after the postings are sent it will not be handled at our end.
Display of order & order-item level attributes
In OMS
Display the order and order line item level attributes in the following screens:
search inward order
search outward order (outward & sub order)
In WMS
In all the following WMS screens, UI should only display the attributes with isDisplayable = true and value != null
Screen | Order Attributes | Order Line Item Attributes | Virtual SKU | UOM SKU |
|---|---|---|---|---|
GRN | yes (on scan of inward box id) | yes (on scan of barcode) | - | - |
GRN (Client SKU selection popup) | no | yes | - | - |
Stickering Item (Client SKU Selection popup) | no | yes | - | - |
Piece Pick Item | yes (collapsed) | yes (expanded) |
| yes |
Bulk Pick Item | yes (collapsed) | yes (expanded) |
| yes |
Guided Item Based Picking | yes (collapsed) | yes (expanded) | no | yes |
Pick Expired Items | no | no | - | - |
Bulk Break Pick Item | no | no | - | - |
Piece Packing | yes (expanded) | yes (collapsed) | yes | yes |
Bulk Packing | yes | no | - | - |
Bulk Break Pick Item | no | no | - | - |
Bulk Break Desk | no | no | - | - |
Cancel Bulk Break Pick List | no | no | - | - |
Order Manager | yes | yes | - | yes |
Return Order Processing | no | no | - | - |
Recycle Desk | yes | yes |
| yes |
Item Sorting | yes | yes |
| yes |
Search via Custom Order Attributes
User should be able to search via order attributes in Pick Order Group and Gate Pass creation screens
On selection of client, UI should fetch the list of order attributes and populate the attributes with isSearchable = true in a drop down
Currently Single attribute search is sufficient on UI, but in the future UI should support searching via multiple attributes.
Adding Order and Order Line Item Attributes
There should be 2 ways to add Order and Line Item Attributes to the orders
During Order Creation
This is applicable only for Single Orders
On selecting the client, UI should fetch the list of all custom order & order line item attributes configured for that client.
Add option on UI to select the attributes via check boxes
The attribute name should be present in the downloaded CSV template
The user should be able to upload the attribute values in order creation CSV
All the custom attribute fields should be non-mandatory in the CSV
Upload order attributes
This is applicable for both Single and Bulk Orders
Add a new tab in Create Orders screen to upload the order and order line item attributes
The user should be able to select the Client via drop down and select the Type as either Order Attributes / Order Line Item Attributes
The user should be able to select the attributes via check boxes
The sample CSV template should have the selected attribute names
All the custom attribute fields should be non-mandatory in the CSV
The CSV template should have the following fields:
order-level: channel order id, attributes (channel order id is unique)
order item-level: channel order id, sku, attributes (channel order id & sku combo is unique)
Updation of Order and Line Item Attributes
Outward order / line item attributes: can be updated via CSP
Inward order / line item attributes: can be updated by a user with oms.admin role (in search orders screen)