Use this method if you want to update an existing special offer.
PUT https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}
Parameter name | Value | Description | Additional |
---|---|---|---|
special_offer_id | int64 | The special offer ID |
Required |
Read-only parameters such as a resource's ID field are to be omitted.
The request body takes a GXSpecialOffer resource, containing the following writable properties:
{
"added": "2015-01-01 09:00:00",
"expiresAt": "2015-01-01 09:00:00",
"modified": "2015-01-01 09:00:00",
"price": 1.2345,
"productId": 2,
"quantity": 5.4321,
"status": true
}
{
"added": "string",
"expiresAt": "string",
"modified": "string",
"price": "double",
"productId": "int64",
"quantity": "double",
"status": "boolean"
}
Name | Type | Description | Additional |
---|---|---|---|
added | string | Optional | |
expiresAt | string | Required | |
modified | string | Optional | |
price | double | Required | |
productId | int64 | Optional | |
quantity | double | Required | |
status | boolean | 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@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 special offer |
GXSpecialOffer |
400 | Bad Request (Missing or invalid id, missing or invalid request body) |
Here are some example implementations for this operation.
MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"id\":0,\"productId\":0,\"price\":0,\"quantity\":0,\"status\":false,\"expiresAt\":\"\",\"added\":\"\",\"modified\":\"\"}"); Request request = new Request.Builder() .url("https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}") .put(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("authorization", "Basic REPLACE_BASIC_AUTH") .build();
Response response = client.newCall(request).execute();
var options = { "method": "PUT", "hostname": "gambio-shop.de", "port": null, "path": "/shop1/api.php/v2/special_offers/{special_offer_id}", "headers": {
"accept": "application/json",
"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, productId: 0, price: 0, quantity: 0, status: false, expiresAt: '', added: '', modified: '' })); req.end();
var options = { method: 'PUT', url: 'https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}', headers: { authorization: 'Basic REPLACE_BASIC_AUTH',
'content-type': 'application/json',
accept: 'application/json' },
body: { id: 0,
productId: 0,
price: 0,
quantity: 0,
status: false,
expiresAt: '<ADD STRING VALUE>',
added: '<ADD STRING VALUE>',
modified: '<ADD STRING VALUE>' },
json: true };
request(options, function (error, response, body) { if (error) throw new Error(error);
console.log(body); });
var req = unirest("PUT", "https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}");
req.headers({ "authorization": "Basic REPLACE_BASIC_AUTH", "content-type": "application/json", "accept": "application/json" });
req.type("json"); req.send({ "id": 0, "productId": 0, "price": 0, "quantity": 0, "status": false, "expiresAt": "", "added": "", "modified": "" });
req.end(function (res) { if (res.error) throw new Error(res.error);
console.log(res.body); });
var xhr = new XMLHttpRequest(); xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () { if (this.readyState === this.DONE) {
console.log(this.responseText);
} });
xhr.open("PUT", "https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}"); xhr.setRequestHeader("accept", "application/json"); xhr.setRequestHeader("content-type", "application/json"); xhr.setRequestHeader("authorization", "Basic REPLACE_BASIC_AUTH");
xhr.send(data);
"accept": "application/json",
"content-type": "application/json",
"authorization": "Basic REPLACE_BASIC_AUTH"
}, "processData": false, "data": "{\"id\":0,\"productId\":0,\"price\":0,\"quantity\":0,\"status\":false,\"expiresAt\":\"\",\"added\":\"\",\"modified\":\"\"}" }
$.ajax(settings).done(function (response) { console.log(response); });
$curl = curl_init();
curl_setopt_array($curl, array( CURLOPT_URL => "https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"id\":0,\"productId\":0,\"price\":0,\"quantity\":0,\"status\":false,\"expiresAt\":\"\",\"added\":\"\",\"modified\":\"\"}", CURLOPT_HTTPHEADER => array(
"accept: application/json",
"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/special_offers/{special_offer_id}'); $request->setMethod(HTTP_METH_PUT);
$request->setHeaders(array( 'authorization' => 'Basic REPLACE_BASIC_AUTH', 'content-type' => 'application/json', 'accept' => 'application/json' ));
$request->setBody('{"id":0,"productId":0,"price":0,"quantity":0,"status":false,"expiresAt":"","added":"","modified":""}');
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('{"id":0,"productId":0,"price":0,"quantity":0,"status":false,"expiresAt":"","added":"","modified":""}');
$request->setRequestUrl('https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}'); $request->setRequestMethod('PUT'); $request->setBody($body);
$request->setHeaders(array( 'authorization' => 'Basic REPLACE_BASIC_AUTH', 'content-type' => 'application/json', 'accept' => 'application/json' ));
$client->enqueue($request)->send(); $response = $client->getResponse();
echo $response->getBody();
conn = http.client.HTTPSConnection("gambio-shop.de")
payload = "{\"id\":0,\"productId\":0,\"price\":0,\"quantity\":0,\"status\":false,\"expiresAt\":\"\",\"added\":\"\",\"modified\":\"\"}"
headers = {
'accept': "application/json",
'content-type': "application/json",
'authorization': "Basic REPLACE_BASIC_AUTH"
}
conn.request("PUT", "/shop1/api.php/v2/special_offers/{special_offer_id}", payload, headers)
res = conn.getresponse() data = res.read()
print(data.decode("utf-8"))
url = "https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}"
payload = "{\"id\":0,\"productId\":0,\"price\":0,\"quantity\":0,\"status\":false,\"expiresAt\":\"\",\"added\":\"\",\"modified\":\"\"}" headers = {
'accept': "application/json",
'content-type': "application/json",
'authorization': "Basic REPLACE_BASIC_AUTH"
}
response = requests.request("PUT", url, data=payload, headers=headers)
print(response.text)
url = URI("https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}")
http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Put.new(url) request["accept"] = 'application/json' request["content-type"] = 'application/json' request["authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"id\":0,\"productId\":0,\"price\":0,\"quantity\":0,\"status\":false,\"expiresAt\":\"\",\"added\":\"\",\"modified\":\"\"}"
response = http.request(request) puts response.read_body
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT"); curl_easy_setopt(hnd, CURLOPT_URL, "https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_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"); headers = curl_slist_append(headers, "accept: application/json"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"id\":0,\"productId\":0,\"price\":0,\"quantity\":0,\"status\":false,\"expiresAt\":\"\",\"added\":\"\",\"modified\":\"\"}");
CURLcode ret = curl_easy_perform(hnd);
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}"
payload := strings.NewReader("{\"id\":0,\"productId\":0,\"price\":0,\"quantity\":0,\"status\":false,\"expiresAt\":\"<ADD STRING VALUE>\",\"added\":\"<ADD STRING VALUE>\",\"modified\":\"<ADD STRING VALUE>\"}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("accept", "application/json")
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 = @{ @"accept": @"application/json",
@"content-type": @"application/json",
@"authorization": @"Basic REPLACE_BASIC_AUTH" };
NSDictionary *parameters = @{ @"id": @0,
@"productId": @0,
@"price": @0,
@"quantity": @0,
@"status": @NO,
@"expiresAt": @"<ADD STRING VALUE>",
@"added": @"<ADD STRING VALUE>",
@"modified": @"<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/special_offers/{special_offer_id}"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"]; [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 = [ "accept": "application/json", "content-type": "application/json", "authorization": "Basic REPLACE_BASIC_AUTH" ] let parameters = [ "id": 0, "productId": 0, "price": 0, "quantity": 0, "status": false, "expiresAt": "", "added": "", "modified": "" ]
let postData = NSJSONSerialization.dataWithJSONObject(parameters, options: nil, error: nil)
var request = NSMutableURLRequest(URL: NSURL(string: "https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}")!,
cachePolicy: .UseProtocolCachePolicy,
timeoutInterval: 10.0)
request.HTTPMethod = "PUT" 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()
let uri = Uri.of_string "https://gambio-shop.de/shop1/api.php/v2/special_offers/{special_offer_id}" in let headers = Header.add_list (Header.init ()) [ ("accept", "application/json"); ("content-type", "application/json"); ("authorization", "Basic REPLACE_BASIC_AUTH"); ] in let body = Cohttp_lwt_body.of_string "{\"id\":0,\"productId\":0,\"price\":0,\"quantity\":0,\"status\":false,\"expiresAt\":\"\",\"added\":\"\",\"modified\":\"\"}" in
Client.call ~headers ~body `PUT uri
= fun (res, body_stream) -> (* Do stuff with the result *)