Update Order Properties API
- Alaf Azam Khan
- Raghav Mehta
- Rahul Singh
- Mayank Kashyap
Inbound | PUT | /orders/{orderCode}
Summary
This API is used to update the properties of an order.
Description
This API is used to update the Order properties from Shopfront systems for forward orders once they are created in Increff system
Properties which can be updated are below:
Dispatch by time
Start processing time
Hold and Unhold Tag
After the order gets unheld , it will be available for processing.
Request
{
"dispatchByTime": "2022-10-17T20:22:28.000+00:00",
"locationCode": "string",
"onHold": true,
"startProcessingTime": "2022-10-16T20:22:28.000+00:00",
"deliveredAt": "2022-10-30T20:22:28.000+00:00",
"orderStatus": "DELIVERED"
}
Parameter Name | Data Type | Description | Mandatory |
| String | Time by which the order is expected to get dispatched | yes |
| String | Code used by channels to identify a warehouse | no |
| Boolean | This flag is true in case order has to be kept on hold. Processing starts only after call is made to unhold the order | yes |
| String | Time by which the order processing is expected to get started | yes |
| String | Time when the order get delivered to the customer(mandatory when order status is sent as DELIVERED) | no |
| String | To be sent as delivered to update the status as delivered on WMSPossible values(DELIVERED/CREATED) | no |
Response
Empty Body
HttpStatus : 200