Place a manual hold on an order

POST

/v1/orders/{orderId}/manual-hold

Pauses a pre-production order for a fixed window so it can be corrected
before it reaches the vendor, then resumes on its own if nobody acts.

Note the route: /hold is already Customer Care Hold, a
higher-precedence agent review that the held user cannot clear. These are
different operations and this service does not make breaking changes to
existing routes, so manual hold lives under its own path.

Returns 409 when the order is at or past "Sent to Vendor", is already held
under either mechanism, or is mid-way through an order-processing job.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Body

🟠400

🟠401

🟠403

🟠404

🟠409

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dev.ordermesh.io/order/v1/orders//manual-hold' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "message": "string",
    "manualHold": {
        "active": true,
        "reason": "string",
        "heldAtStatus": 1,
        "appliedAt": "2019-08-24T14:15:22.123Z",
        "appliedByName": "string",
        "expiresAt": "2019-08-24T14:15:22.123Z",
        "extensionCount": 0
    }
}

Modified at 2026-09-11 13:46:42

Change the order status to Customer Care Hold

Add time to an active manual hold