Page Comparison

...

Info
Now you can also create the Inward Orders by passing some Custom attributes along with the order which can be stored and used in different ways in Increff system.

Note: Please note that the Custom Order or Order Item attribute key must be added in the OMS UI using screen Custom order/ line Item Attribute, else it can result into failure of order creation in Increff OMS system.

In cases where the Custom order attribute key is not defined and custom order or order item attributes are part of the Inward/Outward order creation payloads then the order would move to FAILED status in CIMS.

Request

Code Block

language	json

{
    "locationCode": "Wid234",
 
  "orderCode": "H19304030003",

   "orderCustomAttributesorderItems": {[
    {
   "attribute1": "Value1",         "attribute2"channelSkuCode": "Value2100005643",

       "attribute3orderItemCode": "Value3item123",
        "attribute4orderItemCustomAttributes": "Value4",{
        "attribute5attribute1": "Value5Value1",
        "attribute6attribute2": "Value6Value2",
        "attribute7attribute3": "Value7Value3",
        "attribute8attribute4": "Value8Value4",
        "attribute9attribute5": "Value9Value5",
        "attribute10attribute6": "Value10Value6",
        "channelMetadataattribute7": {
            "totalCashOnDeliveryFee": 0"Value7",
            "departmentattribute8": "HRValue8",
            "paymentMethodattribute9": "ccavenueValue9",
  
         "statusattribute10": "processing"
        }Value10",
        "currency": "INR"
    },
    "orderItems": [
        channelMetadata": {
            "channelSkuCodecustom_keys": "100005643value",
        }
   "orderItemCode": "item123",    },
        "orderItemCustomAttributesquantity": {
     2,
          "attribute1sellingPricePerUnit": "Value1",1500
    }
  ],
        "attribute2"orderTime": "Value2",
             2020-10-16T20:22:28.000+05:30",
  "attribute3orderType": "Value3",
             SO/STO/RTV/RPO",
  "attribute4parentOrderCode": "Value4132",
                "attribute5"partnerCode": "Value5PUSH112",
     
          "attribute6"partnerLocationCode": "Value6UIH786",

               "attribute7"taxBreakupForms": "Value7",[
        {
       "attribute8channelSkuId": "Value8sky1",
       
        "attribute9baseSellingPricePerUnit": "Value9",
  100.8,
             "attribute10"taxItemForms": "Value10",
        [
       "channelMetadata": {
         
          "totalCashOnDeliveryFee": 0,
                    "department"type": "HRCGST",
                    "paymentMethod"rate": "ccavenue",
   1.2,
                "status"taxPerUnit": "processing"27.5
                }
       ]
    },
  ],
  "orderCustomAttributes":  {
    "quantityattribute1": 2"Value1",
            "sellingPricePerUnit": 1500
        }
    ]"attribute2": "Value2",
    "orderTimeattribute3": "2020-10-16T20:22:28.000+05:30Value3",
    "orderTypeattribute4": "SO/STO/RTV/RPOValue4",
    "parentOrderCodeattribute5": "132Value5",
    "partnerCodeattribute6": "PUSH112Value6",
    "partnerLocationCodeattribute7": "UIH786Value7",
    "taxBreakupFormsattribute8": [
        {
  "Value8",
         "channelSkuIdattribute9": "sky1Value9",
   
        "baseSellingPricePerUnitattribute10": 100.8,
"Value10",
           "taxItemForms": [
                "channelMetadata": {
                    "type"custom_keys": "CGSTvalue",
      },
             "rate": 1.2,
                    "taxPerUnit": 27.5
                }
            ]
        }
    ]"currency": "INR"
  }
}

Parameter Name	Data Type	Description	Mandatory
`parentOrderCode`	String	Represents code of parent order of the order	No
`orderTime`	String	Time at which order got placed by customer	Yes
`orderType`	String	Possible values PO (Purchase Order) STO (Stock Transfer Order) RO (Return Order) OPEN_PO OPEN_RO	Yes
`orderCode`	String	Unique code used by channel to identify the order	Yes
`locationCode`	String	Location code of the warehouse from where the order will get fulfilled	Yes
`partnerCode`	String	This represents the partner from which order will come. If Order is of type PO/STO, this field represents vendor's code If Order is of type RO, this field represents customer’s code	Yes
`partnerLocationCode`	String	This represents the partner’s location from which order will come. If Order is of type PO/STO, this field represents vendor location’s code If Order is of type RO, this field represents customer location’s code	Yes
`taxBreakupForms`	Object[ ]	Tax break up for the items (if object is sent, all the fields of the object should be sent)	No
`taxBreakupForms.channelSkuId`	String	Channel Sku id	Yes
`taxBreakupForms.baseSellingPricePerUnit`	Double	Base selling price per unit of the Sku	Yes
`taxBreakupForms.taxItemForms`	Object[ ]	Distribution of tax with tax type	Yes
`taxItemForms.type`	String	Type of tax applicable	Yes
`taxItemForms.rate`	Double	Tax rate for this tax type	Yes
`taxItemForms.taxPerUnit`	Double	Tax applicable for this type of tax per unit	Yes
`orderItems`	Object[ ]	Order Items list if order type is OPEN_PO or OPEN_RO then non mandatory else mandatory If this object is sent then all children fields must also be sent.	Conditional
`orderItems.channelSkuCode`	String	Channel SKUs expected to arrive	Yes
`orderItems.quantity`	Int	qty expected to arrive	Yes
`orderItems.sellingPricePerUnit`	Double	price per unit	Yes
`orderItems.orderItemCode`	String	Unique order item code of the item(This should be unique in an order)	Yes
`orderItems.orderItemCustomAttributes`	Object	Custom attributes for an order item	No
`orderItemCustomAttributes.attribute1`	String	Custom attribute 1	No
`orderItemCustomAttributes.attribute2`	String	Custom attribute 2	No
`orderItemCustomAttributes.attribute3`	String	Custom attribute 3	No
`orderItemCustomAttributes.attribute4`	String	Custom attribute 4	No
`orderItemCustomAttributes.attribute5`	String	Custom attribute 5	No
`orderItemCustomAttributes.attribute6`	String	Custom attribute 6	No
`orderItemCustomAttributes.attribute7`	String	Custom attribute 7	No
`orderItemCustomAttributes.attribute8`	String	Custom attribute 8	No
`orderItemCustomAttributes.attribute9`	String	Custom attribute 9	No
`orderItemCustomAttributes.attribute10`	String	Custom attribute 10	No
`orderItemCustomAttributes.channelMetaData`	Object	This is an object of extra metadata fields which can be used in subsequent flows	No
`orderCustomAttributes`	Object	Custom attributes for an order	No
`orderCustomAttributes.attribute1`	String	Custom attribute 1	No
`orderCustomAttributes.attribute2`	String	Custom attribute 2	No
`orderCustomAttributes.attribute3`	String	Custom attribute 3	No
`orderCustomAttributes.attribute4`	String	Custom attribute 4	No
`orderCustomAttributes.attribute5`	String	Custom attribute 5	No
`orderCustomAttributes.attribute6`	String	Custom attribute 6	No
`orderCustomAttributes.attribute7`	String	Custom attribute 7	No
`orderCustomAttributes.attribute8`	String	Custom attribute 8	No
`orderCustomAttributes.attribute9`	String	Custom attribute 9	No
`orderCustomAttributes.attribute10`	String	Custom attribute 10	No
`orderCustomAttributes.channelMetaData`	Object	This is an object of extra metadata fields which can be used in subsequent flows	No
`orderCustomAttributes.currency`	String	Currency	No

Response

Empty Body

HttpStatus Code

...

Versions Compared

Old Version 2

New Version Current

Key

Request

Response

HttpStatus Code