This method updates a order status in the database.

Request

PUT https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}

Path parameters

Parameter name Value Description Additional
order_status_id int64

The order status ID

Required

Request body

Read-only parameters such as a resource's ID field are to be omitted.

The request body takes a GXOrderStatus resource, containing the following writable properties:

{
    "color": "f6ae49",
    "names": {
        "de": "Offen",
        "en": "Pending"
    }
}
{
    "color": "string",
    "names": {
        "de": "string",
        "en": "string"
    }
}

Properties

Name Type Description Additional
color string Required
names object GXMultiLangOption Required
names.de string Required
names.en string Required

Authorization

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 .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Upon success, returns the updated order status

GXOrderStatus
400 Bad Request

(Order status ID invalid or missing data)

defaultErrorResponse

Example Snippets

Here are some example implementations for this operation.

curl --request PUT \ --url https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id} \ --header 'authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: application/json' \ --data '{"id":0,"names":{"en":"","de":""},"color":""}'
wget --quiet \ --method PUT \ --header 'content-type: application/json' \ --header 'authorization: Basic REPLACE_BASIC_AUTH' \ --body-data '{"id":0,"names":{"en":"","de":""},"color":""}' \ --output-document

echo '{"id":0,"names":{"en":"","de":""},"color":""}' | \ http PUT https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id} \ authorization:'Basic REPLACE_BASIC_AUTH' \ content-type:application/json
HttpResponse response = Unirest.put("https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}") .header("content-type", "application/json") .header("authorization", "Basic REPLACE_BASIC_AUTH") .body("{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"color\":\"\"}") .asString();
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"color\":\"\"}"); Request request = new Request.Builder() .url("https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}") .put(body) .addHeader("content-type", "application/json") .addHeader("authorization", "Basic REPLACE_BASIC_AUTH") .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "application/json"); request.AddHeader("authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("application/json", "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"color\":\"\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request);
var http = require("https");

var options = { "method": "PUT", "hostname": "gambio-shop.de", "port": null, "path": "/shop1/api.php/v2/order_statuses/{order_status_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, names: {en: '', de: ''}, color: '' })); req.end();

var request = require("request");

var options = { method: 'PUT', url: 'https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}', headers: {'content-type': 'application/json', authorization: 'Basic REPLACE_BASIC_AUTH'}, body: {

id: 0,
names: {en: '<ADD STRING VALUE>', de: '<ADD STRING VALUE>'},
color: '<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("PUT", "https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}");

req.headers({ "content-type": "application/json", "authorization": "Basic REPLACE_BASIC_AUTH" });

req.type("json"); req.send({ "id": 0, "names": {

"en": "<ADD STRING VALUE>",
"de": "<ADD STRING VALUE>"

}, "color": "" });

req.end(function (res) { if (res.error) throw new Error(res.error);

console.log(res.body); });

var data = JSON.stringify({ "id": 0, "names": {

"en": "<ADD STRING VALUE>",
"de": "<ADD STRING VALUE>"

}, "color": "" });

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/order_statuses/{order_status_id}"); xhr.setRequestHeader("content-type", "application/json"); xhr.setRequestHeader("authorization", "Basic REPLACE_BASIC_AUTH");

xhr.send(data);

var settings = { "async": true, "crossDomain": true, "url": "https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}", "method": "PUT", "headers": {

"content-type": "application/json",
"authorization": "Basic REPLACE_BASIC_AUTH"

}, "processData": false, "data": "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"color\":\"\"}" }

$.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/order_statuses/{order_status_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,\"names\":{\"en\":\"\",\"de\":\"\"},\"color\":\"\"}", 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

$request = new HttpRequest(); $request->setUrl('https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}'); $request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array( 'content-type' => 'application/json', 'authorization' => 'Basic REPLACE_BASIC_AUTH' ));

$request->setBody('{"id":0,"names":{"en":"","de":""},"color":""}');

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,"names":{"en":"","de":""},"color":""}');

$request->setRequestUrl('https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}'); $request->setRequestMethod('PUT'); $request->setBody($body);

$request->setHeaders(array( 'content-type' => 'application/json', 'authorization' => 'Basic REPLACE_BASIC_AUTH' ));

$client->enqueue($request)->send(); $response = $client->getResponse();

echo $response->getBody();

import http.client

conn = http.client.HTTPSConnection("gambio-shop.de")

payload = "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"color\":\"\"}"

headers = {

'content-type': "application/json",
'authorization': "Basic REPLACE_BASIC_AUTH"
}

conn.request("PUT", "/shop1/api.php/v2/order_statuses/{order_status_id}", payload, headers)

res = conn.getresponse() data = res.read()

print(data.decode("utf-8"))

import requests

url = "https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}"

payload = "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"color\":\"\"}" headers = {

'content-type': "application/json",
'authorization': "Basic REPLACE_BASIC_AUTH"
}

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

require 'uri' require 'net/http' require 'openssl'

url = URI("https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_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["content-type"] = 'application/json' request["authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"color\":\"\"}"

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

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT"); curl_easy_setopt(hnd, CURLOPT_URL, "https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}");

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, "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"color\":\"\"}");

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/order_statuses/{order_status_id}"

payload := strings.NewReader("{\"id\":0,\"names\":{\"en\":\"<ADD STRING VALUE>\",\"de\":\"<ADD STRING VALUE>\"},\"color\":\"<ADD STRING VALUE>\"}")

req, _ := http.NewRequest("PUT", 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,

                          @"names": @{ @"en": @"<ADD STRING VALUE>", @"de": @"<ADD STRING VALUE>" },
                          @"color": @"<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/order_statuses/{order_status_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];

import Foundation

let headers = [ "content-type": "application/json", "authorization": "Basic REPLACE_BASIC_AUTH" ] let parameters = [ "id": 0, "names": [

"en": "<ADD STRING VALUE>",
"de": "<ADD STRING VALUE>"

], "color": "" ] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_id}")! as URL,

                                    cachePolicy: .useProtocolCachePolicy,
                                timeoutInterval: 10.0)

request.httpMethod = "PUT" 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()

open Cohttp_lwt_unix open Cohttp open Lwt

let uri = Uri.of_string "https://gambio-shop.de/shop1/api.php/v2/order_statuses/{order_status_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,\"names\":{\"en\":\"\",\"de\":\"\"},\"color\":\"\"}" in

Client.call ~headers ~body `PUT uri

= fun (res, body_stream) -> (* Do stuff with the result *)