Tenant API - Moving Items Between Orders

Modified on Fri, 28 Feb at 12:11 PM

Moving Items Between Orders

The Tenant API allows you to move items from one order to another.

Endpoint

POST /api/v1/orders/{orderId}/items/move

{orderId} refers to the original order containing the items to be moved.

Request Parameters

Parameter	Type	Description
`updateWeightExtraFee`	Boolean	`true`: Recalculates the Total Weight system extra fee for both orders. `false`: Keeps the original order’s fee unchanged and sets it to 0 in the target order.
`updateNumberOfPiecesExtraFee`	Boolean	`true`: Recalculates the Number of Pieces system extra fee for both orders. `false`: Keeps the original order’s fee unchanged and sets it to 0 in the target order.
`targetOrderId`	String	The Order ID where the items should be moved.
`itemIds`	Array	A list of Item IDs to transfer from the original order to the target order. Item IDs can be retrieved using the GET /api/v1/orders/{orderId}/items endpoint.

Example Request (cURL)

curl -X POST "https://your-api-url.com/api/v1/orders/{orderId}/items/move" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
           "updateWeightExtraFee": true,
           "updateNumberOfPiecesExtraFee": true,
           "targetOrderId": "targetOrder123",
           "itemIds": ["itemid1", "itemid2"]
         }'

Items with a parcel type that is not in the new order parcel type schedule will not be editable. It can be deleted and exception codes can be added on the item.