PUT https://test-api.finerworks.com/v3/update_order

Update Status

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

Name	Description	Type	Additional 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
account_key	Optional - This will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and any update orders will be based upon the user's api credentials. Leave as null or ignore if not explicitly required to use this parameter.	text	None.

Name

Description

Type

Additional 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

account_key

Optional - This will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and any update orders will be based upon the user's api credentials. Leave as null or ignore if not explicitly required to use this parameter.

text

None.

Example JSON Body

application/json, text/json

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

Sample Code Library

curl --location --request PUT 'https://test-api.finerworks.com/v3/update_order' \
--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",
  "account_key": null
}'

require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://test-api.finerworks.com/v3/update_order');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$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',
  'account_key': null
}');
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://test-api.finerworks.com/v3/update_order");
client.Timeout = -1;
var request = new RestRequest(Method.PUT);
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',
  'account_key': null
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

var settings = {
    "url": "https://test-api.finerworks.com/v3/update_order",
    "method": "PUT",
    "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',
  'account_key': null
}),
};

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

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

var options = {
    'method': 'PUT',
    'hostname': 'test-api.finerworks.com',
    'path': '/v3/update_order',
    '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 () {
        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',
  'account_key': null
});

req.write(postData);
req.end();

require "uri"
require "net/http"

url = URI("https://test-api.finerworks.com/v3/update_order")

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

request = Net::HTTP::Put.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',
  'account_key': null
}"

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

Name	Description	Type	Additional 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.
reference_id	Used to reference crucial events	text	None.
domain	The domain in which the request was made	text	None.

Example JSON Response

application/json, text/json

{
  "success": true,
  "status_code": 200,
  "message": "",
  "debug": null,
  "reference_id": "551d3ef0a64c43ccb0ac82ba9ef90dee",
  "domain": null
}