Sign in
latestOpenAPI 3.1.0MIT2026-08-104712182.1 KB

c71c20d26559

orders

Hold order until date

Changes the status of the order to On Hold until the specified date, when the status will automatically change to Awaiting Shipment.

post/orders/holduntil

Request body

orderIdinteger required

Order ID to hold

holdUntilDatestring date required

Date when order moves from on_hold to awaiting_shipment

Example request

{
  "orderId": 1072467,
  "holdUntilDate": "2014-12-01"
}

Response

Order held successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Order held successfully."
}