Use this method if you want to update an existing vpe record.
PATCH https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}
Parameter name | Value | Description | Additional |
---|---|---|---|
vpe_id | int64 | The VPE ID |
Required |
Read-only parameters such as a resource's ID field are to be omitted.
The request body takes a GXVPE resource, containing the following writable properties:
{
"default": false,
"names": {
"de": "API Verpackungseinheit",
"en": "API Packing unit"
}
}
{
"default": "boolean",
"names": {
"de": "string",
"en": "string"
}
}
Name | Type | Description | Additional |
---|---|---|---|
default | boolean | Required | |
names | object | GXMultiLangOption | Required |
names.de | string | Optional | |
names.en | string | Optional |
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@shop.de: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 updated VPE |
GXVPE |
400 | Bad Request (Missing or invalid ID) |
defaultErrorResponse |
Here are some example implementations for this operation.
curl --request PATCH \ --header 'authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: application/json' \ --data '{"id":0,"default":false,"names":{"en":"","de":""}}'
wget --quiet \ --method PATCH \ --header 'content-type: application/json' \ --header 'authorization: Basic REPLACE_BASIC_AUTH' \ --body-data '{"id":0,"default":false,"names":{"en":"","de":""}}' \ --output-document
echo '{"id":0,"default":false,"names":{"en":"","de":""}}' | \ http PATCH https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id} \ authorization:'Basic REPLACE_BASIC_AUTH' \ content-type:application/json
HttpResponse response = Unirest.patch("https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}") .header("content-type", "application/json") .header("authorization", "Basic REPLACE_BASIC_AUTH") .body("{\"id\":0,\"default\":false,\"names\":{\"en\":\"\",\"de\":\"\"}}") .asString();
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"id\":0,\"default\":false,\"names\":{\"en\":\"\",\"de\":\"\"}}"); Request request = new Request.Builder() .patch(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute();
var request = new RestRequest(Method.PATCH); request.AddHeader("authorization", "Basic REPLACE_BASIC_AUTH"); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\"id\":0,\"default\":false,\"names\":{\"en\":\"\",\"de\":\"\"}}", ParameterType.RequestBody); IRestResponse response = client.Execute(request);
var http = require("https"); var options = {
"method": "PATCH", "hostname": "gambio-shop.de", "port": null, "path": "/shop1/api.php/v2/vpe/{vpe_id}", "headers": { "content-type": "application/json",
"authorization": "Basic REPLACE_BASIC_AUTH" }
}; var req = http.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()); });
}); req.write(JSON.stringify({ id: 0,
default: false, names: { en: '', de: '' } })); req.end();
var request = require("request"); var options = { method: 'PATCH',
headers: { authorization: 'Basic REPLACE_BASIC_AUTH', 'content-type': 'application/json' },
body:
{ id: 0, default: false,
names: { en: '<ADD STRING VALUE>', de: '<ADD STRING VALUE>' } }, json: true };
request(options, function (error, response, body) {
if (error) throw new Error(error); console.log(body);
});
var unirest = require("unirest"); var req = unirest("PATCH", "https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}");
req.headers({
"authorization": "Basic REPLACE_BASIC_AUTH", "content-type": "application/json" }); req.type("json");
req.send({ "id": 0, "default": false, "names": { "en": "<ADD STRING VALUE>",
"de": "<ADD STRING VALUE>" }
}); req.end(function (res) {
if (res.error) throw new Error(res.error); console.log(res.body);
});
var data = JSON.stringify({ "id": 0, "default": false, "names": { "en": "<ADD STRING VALUE>",
"de": "<ADD STRING VALUE>" }
}); var xhr = new XMLHttpRequest();
xhr.withCredentials = true; xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) { console.log(this.responseText);
}
}); xhr.open("PATCH", "https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}");
xhr.setRequestHeader("content-type", "application/json"); xhr.setRequestHeader("authorization", "Basic REPLACE_BASIC_AUTH"); xhr.send(data);
var settings = { "async": true, "crossDomain": true, "method": "PATCH", "headers": { "content-type": "application/json",
"authorization": "Basic REPLACE_BASIC_AUTH" },
"processData": false, "data": "{\"id\":0,\"default\":false,\"names\":{\"en\":\"\",\"de\":\"\"}}" } $.ajax(settings).done(function (response) {
console.log(response); });
<?php $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PATCH", CURLOPT_POSTFIELDS => "{\"id\":0,\"default\":false,\"names\":{\"en\":\"\",\"de\":\"\"}}", CURLOPT_HTTPHEADER => array( "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; }
<?php HttpRequest::methodRegister('PATCH');
$request = new HttpRequest(); $request->setUrl('https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}'); $request->setMethod(HttpRequest::HTTP_METH_PATCH); $request->setHeaders(array(
'authorization' => 'Basic REPLACE_BASIC_AUTH', 'content-type' => 'application/json' )); $request->setBody('{"id":0,"default":false,"names":{"en":"","de":""}}');
try {
$response = $request->send(); echo $response->getBody();
} catch (HttpException $ex) { echo $ex; }
<?php $client = new http\Client;
$request = new http\Client\Request; $body = new http\Message\Body;
$body->append('{"id":0,"default":false,"names":{"en":"","de":""}}'); $request->setRequestUrl('https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}');
$request->setRequestMethod('PATCH'); $request->setBody($body); $request->setHeaders(array(
'authorization' => 'Basic REPLACE_BASIC_AUTH', 'content-type' => 'application/json' )); $client->enqueue($request)->send();
$response = $client->getResponse(); echo $response->getBody();
import http.client conn = http.client.HTTPSConnection("gambio-shop.de")
payload = "{\"id\":0,\"default\":false,\"names\":{\"en\":\"\",\"de\":\"\"}}"
headers = {
'content-type': "application/json",
'authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PATCH", "/shop1/api.php/v2/vpe/{vpe_id}", payload, headers)
res = conn.getresponse()
data = res.read() print(data.decode("utf-8"))
import requests payload = "{\"id\":0,\"default\":false,\"names\":{\"en\":\"\",\"de\":\"\"}}"
headers = { 'content-type': "application/json",
'authorization': "Basic REPLACE_BASIC_AUTH" } response = requests.request("PATCH", url, data=payload, headers=headers)
print(response.text)
require 'uri' require 'net/http' http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json' request["authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"id\":0,\"default\":false,\"names\":{\"en\":\"\",\"de\":\"\"}}" response = http.request(request)
puts response.read_body
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}"); struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "authorization: Basic REPLACE_BASIC_AUTH"); headers = curl_slist_append(headers, "content-type: application/json"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"id\":0,\"default\":false,\"names\":{\"en\":\"\",\"de\":\"\"}}");
CURLcode ret = curl_easy_perform(hnd);
package main import (
"fmt"
"strings" "net/http" "io/ioutil" )
func main() {
url := "https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}"
payload := strings.NewReader("{\"id\":0,\"default\":false,\"names\":{\"en\":\"<ADD STRING VALUE>\",\"de\":\"<ADD STRING VALUE>\"}}") req, _ := http.NewRequest("PATCH", 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)) }
#import NSDictionary *headers = @{ @"content-type": @"application/json",
@"authorization": @"Basic REPLACE_BASIC_AUTH" };
NSDictionary *parameters = @{ @"id": @0,
@"default": @NO,
@"names": @{ @"en": @"<ADD STRING VALUE>", @"de": @"<ADD STRING VALUE>" } }; NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0]; [request setHTTPMethod:@"PATCH"];
[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];
import Foundation let headers = [
"content-type": "application/json", "authorization": "Basic REPLACE_BASIC_AUTH" ] let parameters = [ "id": 0, "default": false, "names": [ "en": "<ADD STRING VALUE>",
"de": "<ADD STRING VALUE>" ]
] let postData = NSJSONSerialization.dataWithJSONObject(parameters, options: nil, error: nil)
var request = NSMutableURLRequest(URL: NSURL(string: "https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}")!,
cachePolicy: .UseProtocolCachePolicy,
timeoutInterval: 10.0) request.HTTPMethod = "PATCH"
request.allHTTPHeaderFields = headers request.HTTPBody = postData let session = NSURLSession.sharedSession()
let dataTask = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in if (error != nil) { println(error)
} else {
let httpResponse = response as? NSHTTPURLResponse
println(httpResponse) }
}) dataTask.resume()
open Cohttp_lwt_unix open Cohttp open Lwt let uri = Uri.of_string "https://gambio-shop.de/shop1/api.php/v2/vpe/{vpe_id}" 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 "{\"id\":0,\"default\":false,\"names\":{\"en\":\"\",\"de\":\"\"}}" in Client.call ~headers ~body `PATCH uri
= fun (res, body_stream) ->
(* Do stuff with the result *)