Sign in
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

  • Base URL: https://ssapi.shipstation.com
  • URL: https://ssapi.shipstation.com/orders/holduntil
  • Auth: HTTP basic

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."
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.