Move Orders

Move orders to a new folder. This can target one order or multiple orders.

Please note that either destination_folder_id or destination_folder_name should be used, but not both. A folder name must match exactly.

The response contains a results array with one entry per order, including the folder that each order was moved from.

Moving an order triggers any rules assigned to the destination folder and adds an entry to the order's history.

post

Authorizations

ORDERDESK-API-KEYstringRequired

Your API key, found under Store Settings on the API tab. This should be kept server-side.

ORDERDESK-STORE-IDstringRequired

Your store ID, found under Store Settings on the API tab.

Body

order_id_listinteger[] · min: 1Required

An array of Order Desk's internal order IDs.

Example: [29491,29490]

destination_folder_idintegerOptional

The folder ID to which the orders should be moved.

Example: 21655

destination_folder_namestringOptional

The name of the folder to which the orders should be moved. It must match exactly.

Example: Prepared

Responses

200

The orders were moved.

application/json

statusstring · enumRequired

Either success or error.

Possible values:

messagestringOptional

Describes the result. Always present when an error occurs.

execution_timestringOptional

Time taken to process the request.

Example: 0.1524 seconds

order_idintegerOptionalExample: 29491

messagestringOptionalExample: Order Moved to Prepared Folder

original_folder_idintegerOptional

The folder the order was moved from.

Example: 21654

400

The move was rejected.

application/json

401

Authentication failed. See the Authentication guide, and note that an invalid store ID blocks your store rather than simply failing the request.

application/json

429

You are sending too fast. Wait X-Retry-After seconds. See the Rate Limits guide.

application/json

default

The request could not be completed.

application/json

post/move-orders

curl "https://app.orderdesk.me/api/v2/move-orders" \
  -X POST \
  -H "ORDERDESK-STORE-ID: your-store-id" \
  -H "ORDERDESK-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"order_id_list": [29491, 29490], "destination_folder_id": 21655}'

{
  "status": "success",
  "message": "2 Orders Moved",
  "execution_time": "0.1396 seconds",
  "results": [
    {
      "order_id": 29491,
      "message": "Order Moved to Prepared Folder",
      "original_folder_id": 21654
    },
    {
      "order_id": 29490,
      "message": "Order Moved to Prepared Folder",
      "original_folder_id": 21654
    }
  ]
}