Remove the product image file from the server. This method will always provide a successful response even if the image file was not found.
DELETE https://gambio-shop.de/shop1/api.php/v2/product_images
Read-only parameters such as a resource's ID field are to be omitted.
The request body takes a GXFilename resource, containing the following writable properties:
{
"filename": "artikelbild_1_1.jpg"
}
{
"filename": "string"
}
Name | Type | Description | Additional |
---|---|---|---|
filename | string | Required |
In order to provide the authentication, you must insert the Basic Auth inside the HTTP header. The Basic Auth
is an encrypted base64 string that holds the following content: admin@example.org:12345
where the structure is
as follows: username:password
.
An example header would look as follows:
Authorization: Basic YWRtaW5Ac2hvcC5kZToxMjM0NQ==
This request requires the use of one of following authorisation methods:
BASIC
.
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK Upon success, returns the default success response with the deleted filename |
defaultSuccessResponseWithFilename |
400 | Bad Request (Missing data) |
defaultErrorResponse |
Here are some example implementations for this operation.
MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{}"); Request request = new Request.Builder() .url("https://gambio-shop.de/shop1/api.php/v2/product_images") .delete(body) .addHeader("content-type", "application/json") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build();
Response response = client.newCall(request).execute();
const options = { "method": "DELETE", "hostname": "gambio-shop.de", "port": null, "path": "/shop1/api.php/v2/product_images", "headers": {
"content-type": "application/json",
"Authorization": "Basic REPLACE_BASIC_AUTH"
} };
const req = http.request(options, function (res) { const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
}); });
req.write(JSON.stringify({})); req.end();
const options = { method: 'DELETE', url: 'https://gambio-shop.de/shop1/api.php/v2/product_images', headers: {'content-type': 'application/json', Authorization: 'Basic REPLACE_BASIC_AUTH'}, body: {}, json: true };
request(options, function (error, response, body) { if (error) throw new Error(error);
console.log(body); });
const req = unirest("DELETE", "https://gambio-shop.de/shop1/api.php/v2/product_images");
req.headers({ "content-type": "application/json", "Authorization": "Basic REPLACE_BASIC_AUTH" });
req.type("json"); req.send({});
req.end(function (res) { if (res.error) throw new Error(res.error);
console.log(res.body); });
const xhr = new XMLHttpRequest(); xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () { if (this.readyState === this.DONE) {
console.log(this.responseText);
} });
xhr.open("DELETE", "https://gambio-shop.de/shop1/api.php/v2/product_images"); xhr.setRequestHeader("content-type", "application/json"); xhr.setRequestHeader("Authorization", "Basic REPLACE_BASIC_AUTH");
xhr.send(data);
"content-type": "application/json",
"Authorization": "Basic REPLACE_BASIC_AUTH"
}, "processData": false, "data": "{}" };
$.ajax(settings).done(function (response) { console.log(response); });
$curl = curl_init();
curl_setopt_array($curl, [ CURLOPT_URL => "https://gambio-shop.de/shop1/api.php/v2/product_images", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_POSTFIELDS => "{}", CURLOPT_HTTPHEADER => [
"Authorization: Basic REPLACE_BASIC_AUTH",
"content-type: application/json"
], ]);
$response = curl_exec($curl); $err = curl_error($curl);
curl_close($curl);
if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
$request = new HttpRequest(); $request->setUrl('https://gambio-shop.de/shop1/api.php/v2/product_images'); $request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Basic REPLACE_BASIC_AUTH' ]);
$request->setBody('{}');
try { $response = $request->send();
echo $response->getBody(); } catch (HttpException $ex) { echo $ex; }
$client = new http\Client; $request = new http\Client\Request;
$body = new http\Message\Body; $body->append('{}');
$request->setRequestUrl('https://gambio-shop.de/shop1/api.php/v2/product_images'); $request->setRequestMethod('DELETE'); $request->setBody($body);
$request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Basic REPLACE_BASIC_AUTH' ]);
$client->enqueue($request)->send(); $response = $client->getResponse();
echo $response->getBody();
conn = http.client.HTTPSConnection("gambio-shop.de")
payload = "{}"
headers = {
'content-type': "application/json",
'Authorization': "Basic REPLACE_BASIC_AUTH"
}
conn.request("DELETE", "/shop1/api.php/v2/product_images", payload, headers)
res = conn.getresponse() data = res.read()
print(data.decode("utf-8"))
url = "https://gambio-shop.de/shop1/api.php/v2/product_images"
payload = {} headers = {
"content-type": "application/json",
"Authorization": "Basic REPLACE_BASIC_AUTH"
}
response = requests.request("DELETE", url, json=payload, headers=headers)
print(response.text)
url = URI("https://gambio-shop.de/shop1/api.php/v2/product_images")
http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Delete.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{}"
response = http.request(request) puts response.read_body
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE"); curl_easy_setopt(hnd, CURLOPT_URL, "https://gambio-shop.de/shop1/api.php/v2/product_images");
struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "content-type: application/json"); headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{}");
CURLcode ret = curl_easy_perform(hnd);
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://gambio-shop.de/shop1/api.php/v2/product_images"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("content-type", "application/json")
req.Header.Add("Authorization", "Basic REPLACE_BASIC_AUTH")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
NSDictionary *headers = @{ @"content-type": @"application/json",
@"Authorization": @"Basic REPLACE_BASIC_AUTH" };
NSDictionary *parameters = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://gambio-shop.de/shop1/api.php/v2/product_images"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"]; [request setAllHTTPHeaderFields:headers]; [request setHTTPBody:postData];
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;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
let headers = [ "content-type": "application/json", "Authorization": "Basic REPLACE_BASIC_AUTH" ] let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "https://gambio-shop.de/shop1/api.php/v2/product_images")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE" request.allHTTPHeaderFields = headers request.httpBody = postData as Data
let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) {
print(error)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
} })
dataTask.resume()
let uri = Uri.of_string "https://gambio-shop.de/shop1/api.php/v2/product_images" in let headers = Header.add_list (Header.init ()) [ ("content-type", "application/json"); ("Authorization", "Basic REPLACE_BASIC_AUTH"); ] in let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `DELETE uri
= fun (res, body_stream) -> (* Do stuff with the result *)