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.

Requirements:

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. Required
`holdUntilDate`	string	Date when order is moved from `on_hold` status to `awaiting_shipment`. Required

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

curl -iX POST https://ssapi.shipstation.com/orders/holduntil \
-H 'Authorization: __YOUR_AUTH_HERE__ ' \
-H 'Content-Type: application/json' \
-d '{
  "orderId": 1072467,
  "holdUntilDate": "2014-12-01"
}'

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "ssapi.shipstation.com")
$headers.Add("Authorization", "__YOUR_AUTH_HERE__")
$headers.Add("Content-Type", "application/json")

$body = "{`n  `"orderId`": 1072467,`n  `"holdUntilDate`": `"2014-12-01`"`n}"

$response = Invoke-RestMethod 'https://ssapi.shipstation.com/orders/holduntil' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json

var myHeaders = new Headers();
myHeaders.append("Host", "ssapi.shipstation.com");
myHeaders.append("Authorization", "__YOUR_AUTH_HERE__");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({"orderId":1072467,"holdUntilDate":"2014-12-01"});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://ssapi.shipstation.com/orders/holduntil", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://ssapi.shipstation.com/orders/holduntil',
  'headers': {
    'Host': 'ssapi.shipstation.com',
    'Authorization': '__YOUR_AUTH_HERE__',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"orderId":1072467,"holdUntilDate":"2014-12-01"})

};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://ssapi.shipstation.com/orders/holduntil",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\n  \"orderId\": 1072467,\n  \"holdUntilDate\": \"2014-12-01\"\n}",
  CURLOPT_HTTPHEADER => array(
    "Host: ssapi.shipstation.com",
    "Authorization: __YOUR_AUTH_HERE__",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://ssapi.shipstation.com/orders/holduntil"

payload = "{\n  \"orderId\": 1072467,\n  \"holdUntilDate\": \"2014-12-01\"\n}"
headers = {
  'Host': 'ssapi.shipstation.com',
  'Authorization': '__YOUR_AUTH_HERE__',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

require "uri"
require "net/http"

url = URI("https://ssapi.shipstation.com/orders/holduntil")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Host"] = "ssapi.shipstation.com"
request["Authorization"] = "__YOUR_AUTH_HERE__"
request["Content-Type"] = "application/json"
request.body = "{\n  \"orderId\": 1072467,\n  \"holdUntilDate\": \"2014-12-01\"\n}"

response = https.request(request)
puts response.read_body

var client = new RestClient("https://ssapi.shipstation.com/orders/holduntil");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Host", "ssapi.shipstation.com");
request.AddHeader("Authorization", "__YOUR_AUTH_HERE__");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"orderId\": 1072467,\n  \"holdUntilDate\": \"2014-12-01\"\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"orderId\": 1072467,\n  \"holdUntilDate\": \"2014-12-01\"\n}");
Request request = new Request.Builder()
  .url("https://ssapi.shipstation.com/orders/holduntil")
  .method("POST", body)
  .addHeader("Host", "ssapi.shipstation.com")
  .addHeader("Authorization", "__YOUR_AUTH_HERE__")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://ssapi.shipstation.com/orders/holduntil"
  method := "POST"

  payload := strings.NewReader("{\n  \"orderId\": 1072467,\n  \"holdUntilDate\": \"2014-12-01\"\n}")

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Host", "ssapi.shipstation.com")
  req.Header.Add("Authorization", "__YOUR_AUTH_HERE__")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

#import <Foundation/Foundation.h>

dispatch_semaphore_t sema = dispatch_semaphore_create(0);

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://ssapi.shipstation.com/orders/holduntil"]
  cachePolicy:NSURLRequestUseProtocolCachePolicy
  timeoutInterval:10.0];
NSDictionary *headers = @{
  @"Host": @"ssapi.shipstation.com",
  @"Authorization": @"__YOUR_AUTH_HERE__",
  @"Content-Type": @"application/json"
};

[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n  \"orderId\": 1072467,\n  \"holdUntilDate\": \"2014-12-01\"\n}" dataUsingEncoding:NSUTF8StringEncoding]];
[request setHTTPBody:postData];

[request setHTTPMethod:@"POST"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
  if (error) {
    NSLog(@"%@", error);
  } else {
    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
    NSError *parseError = nil;
    NSDictionary *responseDictionary = [NSJSONSerialization JSONObjectWithData:data options:0 error:&parseError];
    NSLog(@"%@",responseDictionary);
    dispatch_semaphore_signal(sema);
  }
}];
[dataTask resume];
dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);

import Foundation

var semaphore = DispatchSemaphore (value: 0)

let parameters = "{\n  \"orderId\": 1072467,\n  \"holdUntilDate\": \"2014-12-01\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://ssapi.shipstation.com/orders/holduntil")!,timeoutInterval: Double.infinity)
request.addValue("ssapi.shipstation.com", forHTTPHeaderField: "Host")
request.addValue("__YOUR_AUTH_HERE__", forHTTPHeaderField: "Authorization")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
  semaphore.signal()
}

task.resume()
semaphore.wait()

Example Response

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