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

Outward Order / Item Attributes can be added for Single/ Multiple orders using the below steps.

Go to Oms-> Outwards-> Create Order screen.
Please select the client & location. Based on the client, attribute keys are displayed.
Select either Order or Order Line Item in the Attribute type to update.
Please select the outward order/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.
Please provide the details and upload the file. The maximum Row Limit for CSV with Order attributes is 5000. Maximum Row Limit for Order Line Item CSV is 10000 and Max. No. of Orders: 500
On success, Outward Order/ Order Item attributes will be created for the outward order for the provided attribute keys.

Outward Order / Item Attribute update

Customer Support Panel

We have provided a mechanism to update outward order/order items for the outwards orders which are visible in the Customer Support Panel.

In the Customer Support Panel, search the outward order.
Click on the Edit Attributes icon.
Please edit the values for the order attributes.
The functionality works as follows:
1. If the attribute value is already present in the order, then it updates with the new value.
2. If a new attribute is provided (which is defined in the client), then add the new attribute value for the order/order item.
3. 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.

Outward Order/ Order Item Attributes values update screen in Outwards Create Order

Please follow the below steps to update the outward order attributes value. This is the same screen that is used to add the custom attributes for a new order.

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). The maximum Row Limit for CSV with Order attributes is 5000. Maximum Row Limit for Order Line Item CSV is 10000 and Max. No. of Orders: 500
The update functionality works as follows:
1. If the attribute value is already present in the order, then update it with the new value.
2. If a new attribute is provided (which is defined in the client), then add the new attribute value for the order/order item.
3. 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 Order/ Order Item attributes 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 screen

The order and order item attributes will be visible in the WMS Order Manager screen on searching a specific order.

B2C Picking screen/ Bulk Pick Item/ Guided Item Based Picking

We display the outward order/ order item attribute for the particular SKU/order for which the item is being picked.

B2C Packing screens

We display the outward order/ order item attribute for the particular SKU/order for which the item is being packed.

B2B Packing screen

We display the outward order attributes for the particular 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, we have a drop-down with all the searchable attribute 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.

There are some other screens where custom order/ order item attributes are shown:

Recycle Desk
Item Sorting

Audits

Audits are captured client level when attribute key gets created/updated. There are no order-level audits for 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:

Inward Order / Item Attributes can be added for Single/ Multiple orders using the below steps.

Go to Oms-> Inards-> Create Order screen.
Please select the client & location. Based on the client, attribute keys are displayed.
Select either Order or Order Line Item in the Attribute type to update.
Please select the Inward order/order item custom attribute keys that are applicable for the current outward order.
Inward Order Item upload CSV will consist of the order/order item attribute fields.
Please provide the details and upload the file. The maximum Row Limit for CSV with Order attributes is 5000. Maximum Row Limit for Order Line Item CSV is 10000 and Max. No. of Orders: 500
On success, Outward Order/ Order Item attributes will be created for the inward order for the provided attribute keys.

Inward Order / Order Item Attribute update

Inward Order Attribute update using Inward Create Order screen

Please follow the below steps to update the outward order attributes value. The same screen is used to add the attributes during inward order creation.

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). In case of Order Line Item, CSV contains channel order ID, Client SKU ID, attribute1, attribute2… (for multiple orders). The maximum Row Limit for CSV with Order attributes is 5000. Maximum Row Limit for Order Line Item CSV is 10000 and Max. No. of Orders: 500
The add/ update functionality works as follows:
1. If the attribute value is already present in the order, then update it with the new value.
2. If a new attribute is provided (which is defined in the client), then add the new attribute value for the order/order item.
3. 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:

We display the inward order and order item attribute for the particular SKU / order for which the item is being GRNed.

The below screen reflects when the user needs to select an SKU out of multiple suggestions during GRN. Order Item attributes are displayed there.

APIs for Custom order/ Line Item Attributes

New APIs

New APIs

Description

Reference Links

Update Inward Order Attributes API (Beta)

Since now external systems can push Inward order with custom attributes tagged to it which can be stored and used in Increff systems in multiple ways.
This API can be used to update the value of any Custom attribute which was passed with an Inward order during Inward order creation from external system.