PUT v3/disconnect_virtual

< Back

Disconnect Virtual Inventory
Uri: https://test-api.finerworks.com/v3/disconnect_virtual_inventory
Method: PUT

Updates ALL virtual inventory items by removing the 3rd party platform data specified in the request. To update SINGLE virtual inventory items, use the update_virtual_inventory endpoint instead.

Request
Response

Body

Name	Description	Type	Additional information
platform	Name of platform to be disconnected (i.e., woocommerce, shopify, etsy, etc)	text	Required
account_key	Optional - This updates virtual inventory by account_key. Note, this will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and virtual inventory will be updated based upon the user's api credentials. Leave as null if not authorized to use this parameter.	text	None.

Example JSON Body

application/json, text/json

{
  "platform": "sample string 1",
  "account_key": "sample string 2"
}

Sample Code Library

                        
curl --location --request sample_method 'https://test-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 '{
  "platform": "sample string 1",
  "account_key": "sample string 2"
}'


require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://test-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('{
  'platform': 'sample string 1',
  'account_key': 'sample string 2'
}');
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.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", "{
  'platform': 'sample string 1',
  'account_key': 'sample string 2'
},  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);


var settings = {
"url": "https://test-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({
  'platform': 'sample string 1',
  'account_key': 'sample string 2'
}),
};

$.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({
  "platform": "sample string 1",
  "account_key": "sample string 2"
});

req.write(postData);

req.end();

                        
    require "uri"
    require "net/http"

    url = URI("https://test-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 = "{
  'platform': 'sample string 1',
  'account_key': 'sample string 2'
}"

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

Name	Description	Type	Additional information
status	Response status details	response_status	None.

Example JSON Response