Update Status
Uri: https://api.finerworks.com/v3/update_order
Method: POST

Updates an existing submission order's status (note this is different than the production status). You can change the submission status of an order with the api prior to it being placed in production. Once an order is in production you will need to contact our customer support team to make any further updates.


Body

Order udpate details to be submitted via JSON

NameDescriptionTypeAdditional information
order_id

The unique order submission reference id you received after your order was successfully submitted.

number

Required

update_command

Command to change the status. Use the following: pending = forwards it to our fulfillment center, hold = places the order on hold, cancel = cancels the order submission. Cancel is useful if you need to resubmit the order later with the same order_po.

text

Required

Example JSON Body

application/json, text/json

{
  "order_id": 1234567,
  "update_command": "hold"
}

Sample Code Library


                        
curl --location --request sample_method 'https://api.finerworks.comsample_endpoint' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "order_id": 1234567,
  "update_command": "hold"
}'
                            
                        


require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.finerworks.comsample_endpoint');
$request->setMethod(HTTP_Request2::METHOD_sample_method);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'web_api_key' => 'my-web-api-key-goes-here',
'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
  'order_id': 1234567,
  'update_command': 'hold'
}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}

                        


var client = new RestClient("https://api.finerworks.comsample_endpoint");
client.Timeout = -1;
var request = new RestRequest(Method.sample_method);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
  'order_id': 1234567,
  'update_command': 'hold'
},  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

                        


var settings = {
"url": "https://api.finerworks.comsample_endpoint",
"method": "sample_method",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"web_api_key": "my-web-api-key-goes-here",
"app_key": "my-app-key-goes-here"
},
"data": JSON.stringify({
  'order_id': 1234567,
  'update_command': 'hold'
}),
};

$.ajax(settings).done(function (response) {
console.log(response);
});

                        

                        
var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
'method': 'sample_method',
'hostname': 'api.finerworks.com',
'path': 'sample_endpoint',
'headers': {
'Content-Type': 'application/json',
'web_api_key': 'my-web-api-key-goes-here',
'app_key': 'my-app-key-goes-here'
},
'maxRedirects': 20
};

var req = https.request(options, function (res) {
var chunks = [];

res.on("data", function (chunk) {
chunks.push(chunk);
});

res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});

res.on("error", function (error) {
console.error(error);
});
});

var postData = JSON.stringify({
  "order_id": 1234567,
  "update_command": "hold"
});

req.write(postData);

req.end();
                            
                        

                        
    require "uri"
    require "net/http"

    url = URI("https://api.finerworks.comsample_endpoint")

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

    request = Net::HTTP::sample_method.new(url)
    request["Content-Type"] = "application/json"
    request["web_api_key"] = "my-web-api-key-goes-here"
    request["app_key"] = "my-app-key-goes-here"
    request.body = "{
  'order_id': 1234567,
  'update_command': 'hold'
}"

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


                        

NameDescriptionTypeAdditional information
success

Indicates if the status returned was successful

boolean

None.

status_code

HTTP Status code

HttpStatusCode

None.

message

Additional information may be included here

text

None.

debug

Used to assist debugging any errors

Object

None.

Example JSON Response

application/json, text/json

{
  "success": true,
  "status_code": 200,
  "message": "",
  "debug": null
}