Deletes Image Files
Uri: https://api.finerworks.com/v3/delete_images
Method: DELETE

Deletes a list of image files based on their unique id. Note if the image is assigned to the inventory library, this will also remove any virtual inventory products assigned to those images.


Body

NameDescriptionTypeAdditional information
guids

Array of unique identifiers assigned to images you want to delete.

array (text)

Required

library

Contains parameters which indicate the location of the image.

image_library

Required

Example JSON Body

application/json, text/json

{
  "guids": [
    "9a85d170-dca0-43d1-a00d-072281b122e7",
    "be9d78b7-866f-4941-b237-8f010eef3b9b"
  ],
  "library": null
}

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 '{
  "guids": [
    "9a85d170-dca0-43d1-a00d-072281b122e7",
    "be9d78b7-866f-4941-b237-8f010eef3b9b"
  ],
  "library": null
}'
                            
                        


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('{
  'guids': [
    '9a85d170-dca0-43d1-a00d-072281b122e7',
    'be9d78b7-866f-4941-b237-8f010eef3b9b'
  ],
  'library': 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://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", "{
  'guids': [
    '9a85d170-dca0-43d1-a00d-072281b122e7',
    'be9d78b7-866f-4941-b237-8f010eef3b9b'
  ],
  'library': null
},  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({
  'guids': [
    '9a85d170-dca0-43d1-a00d-072281b122e7',
    'be9d78b7-866f-4941-b237-8f010eef3b9b'
  ],
  'library': null
}),
};

$.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({
  "guids": [
    "9a85d170-dca0-43d1-a00d-072281b122e7",
    "be9d78b7-866f-4941-b237-8f010eef3b9b"
  ],
  "library": null
});

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 = "{
  'guids': [
    '9a85d170-dca0-43d1-a00d-072281b122e7',
    'be9d78b7-866f-4941-b237-8f010eef3b9b'
  ],
  'library': null
}"

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


                        

NameDescriptionTypeAdditional information
status

Response status details

response_status

None.

Example JSON Response

application/json, text/json

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