Update Inward Order Attributes API (New API)(Beta)

Inbound | PUT | `/orders/inward/attributes/{orderCode}`

Summary

This API can be used to update the vaue of any Custom attribute which was passed with an Inward order during Inward order creation from external system.

Description

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.

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.

Thus, Update Inward Order Attributes API would also need definition of Custom Order or Order Item attribute key in OMS beforehand.

Request Body

{
  "locationCode": "test_77847b22cdc5",
  "updateOrderAttributes": {
    "attribute1": "test_4e10f67e0585",
    "attribute2": "test_df7f45161dbf",
    "attribute3": "test_511554245071",
    "attribute4": "test_285ab90a9a26",
    "attribute5": "test_c9902353bd62",
    "attribute6": "test_29bf877ad20e",
    "attribute7": "test_f05c5ee7bda0",
    "attribute8": "test_f05c5ee7bda1",
    "attribute9": "test_913b35f805f0",
    "attribute10": "test_e3af29b52cda",
    "channelMetadata": {
		"totalCashOnDeliveryFee": 0.0,
		"department": "HR",
		"paymentMethod": "ccavenue",
		"status": "processing"
    },
    "currency": "test_ad35da54ae2f"
  },
  "updateOrderItemAttributes": [
    {
      "orderItemCode": "test_d40fb41b069b",
      "channelSkuCode": "test_0b7bd2e16c1f",
        "attribute1": "test_9500ccd4855f",
        "attribute2": "test_957207fbdbb0",
        "attribute3": "test_e9c4494fc055",
        "attribute4": "test_2c6670838f48",
        "attribute5": "test_09156554f500",
        "attribute6": "test_20ab8d00c447",
        "attribute7": "test_f0c3e77287ae",
        "attribute8": "test_f0c3e77287af",
        "attribute9": "test_691c1f899bb8",
        "attribute10": "test_1e7511fe9fc8",
        "channelMetadata": {
			"totalCashOnDeliveryFee": 0.0,
			"department": "HR",
			"paymentMethod": "ccavenue",
			"status": "processing"
        },
    }
  ]
}

Parameter	Data type	Description	Mandatory

Parameter	Data type	Description	Mandatory
`locationCode`	String	Location code	Yes
`updateOrderAttributes`	Object	Update order attributes	No
`updateOrderAttributes.attribute1`	String	Custom attribute 1	No
`updateOrderAttributes.attribute2`	String	Custom attribute 2	No
`updateOrderAttributes.attribute3`	String	Custom attribute 3	No
`updateOrderAttributes.attribute4`	String	Custom attribute 4	No
`updateOrderAttributes.attribute5`	String	Custom attribute 5	No
`updateOrderAttributes.attribute6`	String	Custom attribute 6	No
`updateOrderAttributes.attribute7`	String	Custom attribute 7	No
`updateOrderAttributes.attribute8`	String	Custom attribute 8	No
`updateOrderAttributes.attribute9`	String	Custom attribute 9	No
`updateOrderAttributes.attribute10`	String	Custom attribute 10	No
`updateOrderAttributes.channelMetadata`	Object	These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows	No
`updateOrderAttributes.currency`	String	currency	No
`updateOrderItemAttributes`	Object[]	Attributes for updating an inward order item	No
`updateOrderItemAttributes.orderItemCode`	String	Order item code	No
`updateOrderItemAttributes.channelSkuCode`	String	Code to uniquely identify an sku on channel’s end	No
`updateOrderItemAttributes.attribute1`	String	Custom attribute 1	No
`updateOrderItemAttributes.attribute2`	String	Custom attribute 2	No
`updateOrderItemAttributes.attribute3`	String	Custom attribute 3	No
`updateOrderItemAttributes.attribute4`	String	Custom attribute 4	No
`updateOrderItemAttributes.attribute5`	String	Custom attribute 5	No
`updateOrderItemAttributes.attribute6`	String	Custom attribute 6	No
`updateOrderItemAttributes.attribute7`	String	Custom attribute 7	No
`updateOrderItemAttributes.attribute8`	String	Custom attribute 8	No
`updateOrderItemAttributes.attribute9`	String	Custom attribute 9	No
`updateOrderItemAttributes.attribute10`	String	Custom attribute 10	No
`updateOrderItemAttributes.channelMetaData`	Object	These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows	No

Response

Empty Body

Http Status

200