Inbound | PUT | /orders/outward/attributes/{orderCode}
Summary
This API can be used to update the vaue of any Custom attribute which was passed with an Outward order during Outward order creation from any external system.
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.
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 Outward Order Attributes API would also need definition of Custom Order or Order Item attribute key in OMS beforehand.
Parameter
Name | Data type | Description | Mandatory |
|---|---|---|---|
| String | order code | Yes |
Request
Request Body
| Code Block | ||
|---|---|---|
| ||
{
"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_f05c5ee7bda1",
"attribute9": "test_691c1f899bb8",
"attribute10": "test_1e7511fe9fc8",
"channelMetadata": {
"totalCashOnDeliveryFee": 0.0,
"department": "HR",
"paymentMethod": "ccavenue",
"status": "processing"
}
}]
} |
Parameter | Data type | Description | Mandatory |
|---|---|---|---|
| String | Location code | Yes |
| Object | Custom attributes to update an outward order | No |
| String | Custom attribute 1 | No |
| String | Custom attribute 2 | No |
| String | Custom attribute 3 | No |
| String | Custom attribute 4 | No |
| String | Custom attribute 5 | No |
| String | Custom attribute 6 | No |
| String | Custom attribute 7 | No |
| String | Custom attribute 8 | No |
| String | Custom attribute 9 | No |
| String | Custom attribute 10 | No |
| Object |
These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflows | No | ||
| String | Currency | No |
| Object[] | List of custom attributes for order items | No |
| String | Code to uniquely identify an order item in an order | No |
| String | Code to uniquely identify an sku on channel’s end | No |
| String | Custom attribute 1 | No |
| String | Custom attribute 2 | No |
| String | Custom attribute 3 | No |
| String | Custom attribute 4 | No |
| String | Custom attribute 5 | No |
| String | Custom attribute 6 | No |
| String | Custom attribute 7 | No |
| String | Custom attribute 8 | No |
| String | Custom attribute 9 | No |
| String | Custom attribute 10 | No |
| Object |
These are additonal fields which can be sent to Increff system and can be used in subsequent Posting workflowsme | No |
Response
| Code Block |
|---|
Empty Body |
...