Hold Order Until

This method will change the status of the given order to On Hold status until the date you have specified, when the status will automatically change to Awaiting Shipment status.


  • You'll need an orderId to make this API call.
  • Find that orderId in your Response from the Create/Update Order call if you are creating the orders via OpenAPI.
  • If you’re importing orders from a marketplace, you can list orders and find the orderId using one of the endpoints in a List Orders By Tag call.

The body of this request should specify the following attributes:

Name Data Type Description
orderId number Identifies the order that will be held.

holdUntilDate string Date when order is moved from on_hold status to awaiting_shipment.


Example Request

POST /orders/holduntil HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__ 
Content-Type: application/json

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

Example Response

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