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 the 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 items here.
Applications for Order and Order Line Items Custom Attributes
Please find below some examples where custom Order and Order Line Item attributes can help.
Use Case | Solved using Custom Order/ Order Line Item Attributes |
---|---|
Pass customer order cancellation reason from Brand.com to Increff and get the seller cancellation reasons from Increff. | Customer Cancellation Here, the customer cancellation reason will be available at Brand.com end when customer cancels the order. Client system can send another api for updating the custom attributes at time of cancellation. Update Outward Order Attributes (Beta) Seller cancellation CSR team can update the reason in order custom attributes using CSR panel. |
Pincode Tracking for any marketplace Orders. Eg, Ajio. Due to the nature of B2B orders with AJIO, clients may not receive customer details such as customer name, customer city, and customer pincode from AJIO. | Custom Order attributes would help in updating data from Ajio proxy to OMS to be sent in postings. |
For B2B channel(Channel App) to integrate with Clickpost for shipping particular items via Air transport, Clickpost asked Increff to send the key word MPS_AIR in their create order call so that they can differentiate the orders from their end. | Custom Order Attributes fields can be captured at order creation and shared with Clickpost in pack call. |
Webshops to pass Gift Card Discount and the same details required at ERP | Fields can be captured at order creation and shared with ERP in posting. |
Webshops/ Brand.com to pass coupon codes (discount) of the orders and the same details required at ERP | Fields can be captured at order creation and shared with ERP in posting. |
Capture promotions on order and order-SKU levels coming from webshops like Shopify | Fields can be captured at order creation and shared with ERP in posting. |
Brands might be interested in capturing:
Against brand.com orders and send them to my ERP for financial and marketing analytics. | Fields can be captured at order creation and shared with ERP in posting. |
For Inward and Outward an Order Type might be required by ERP: Returnable Gate Pass and Non Returnable Gate Pass | Fields can be captured at order creation and shared with ERP in posting. |
APIs for Custom Order/ Line Item Attributes
New APIs
New APIs | Description | Reference Links |
---|---|---|
Update Inward Order Attributes API (Beta) |
| |
Update Outward Order Attributes (Beta) |
|
Existing APIs Enhancements
Exisiting API | Updates in the API | Reference Links |
---|---|---|
GRN Notifications to external systems (ERP/POS) for an Inward order after the GRN is completed.
| Introduced Custom order and order item attributes fields in the existing API which can be passed to the external system during GRN postings once the Inward order is marked as Completed or Gate entry for an Inward order is closed. | |
Real Time GRN Notifications to external systems (ERP/POS) for an Inward order.
| Introduced Custom order and order item attributes fields in the existing API which can be passed to the external system in Real time GRN postings. | |
Outward Order Creation APIs
| Introduced Custom order and order item attributes fields in the existing API which any external system can pass to Increff system during creation of an Outward order (B2C/B2B). | |
Outward Order Sales Posting APIs
| Addition of fields: Introduced Custom order and order item attributes | |
Pack Order API(Beta) | Introduced Custom order and order item attributes fields in the existing API which can be passed to the external system during Packing of an order |