Update Orders Learn how to update orders in progress yet to be shipped with HotWax Commerce using the updateOrder endpoint and POST method.
Updates orders that are currently in progress and have not yet been shipped, to update the orders, you will need to call the updateOrder
endpoint with the POST method. There are two main reasons for updating orders: changing the shipment box and rejecting specific order items.
Request
Endpoint
https://<host>/api/updateOrder
Example: https://demo-oms.hotwax.io/api/updateOrder
For Order Item rejection:
Body
Copy facilityId: <facilityId>,
box_shipmentId_0: item.shipmentId,
0_box_rowSubmit`: 0,
box_shipmentBoxTypeId_0: boxType,
rej_shipmentId_0: item.shipmentId
rej_shipmentItemSeqId_0: item.shipmentItemSeqId
0_rej_rowSubmit_: 0
rej_rejectionReason_0: item.rejectReason
Note: Pass this information as a form data.
For Shipment Package Change:
Body
Copy facilityId: <facilityId>,
box_shipmentId_1: item.shipmentId,
1_box_rowSubmit`: 1,
box_shipmentBoxTypeId_1: boxType,
rtp_shipmentId_1: item.shipmentId
rtp_shipmentItemSeqId_1: item.shipmentItemSeqId
1_rtp_rowSubmit_: 1
rtp_newShipmentId_1: shipmentPackage.shipmentId
Response
For Order Item rejection:
Body
Copy facilityId: <facilityId>,
box_shipmentId_0: item.shipmentId,
0_box_rowSubmit`: 0,
box_shipmentBoxTypeId_0: boxType,
rej_shipmentId_0: item.shipmentId
rej_shipmentItemSeqId_0: item.shipmentItemSeqId
0_rej_rowSubmit_: 0
rej_rejectionReason_0: item.rejectReason
_EVENT_MESSAGE_: "Order updated successfully"
For Shipment Package Change:
Body
Copy facilityId: <facilityId>,
box_shipmentId_1: item.shipmentId,
1_box_rowSubmit`: 1,
box_shipmentBoxTypeId_1: boxType,
rtp_shipmentId_1: item.shipmentId
rtp_shipmentItemSeqId_1: item.shipmentItemSeqId
1_rtp_rowSubmit_: 1
rtp_newShipmentId_1: shipmentPackage.shipmentId
_EVENT_MESSAGE_: "Order updated successfully"
Last updated 3 months ago