Inbound | PUT |/usp/update/outward-order-attribute/{orderCode}

Summary

This API can be used to update the vaue of any custom attribute which were passed with an Outward order during Outward order creation from any external system (ERP or Shopfront)

Description

• Since now external systems can push Outward 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 Outward order during Outward order creation from external system (ERP or Shopfront).

<aside> 🗒️ 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.
• Hence this API would also need definition of Custom Order or Order Item attribute key in OMS beforehand. </aside>

Parameter

Request

Request Body

{
	"locationCode": "test_77847b22cdc5",
	"channelName" : "channel1",
	"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_f05c5ee7bda1",
		"attribute9": "test_691c1f899bb8",
		"attribute10": "test_1e7511fe9fc8",
        "channelMetadata": {
			"totalCashOnDeliveryFee": 0.0,
			"department": "HR",
			"paymentMethod": "ccavenue",
			"status": "processing"
        }
	}]
}

Response

Empty Body

HTTP status

200