This method enables the creation of a new CustomerGroups into the system.
POST https://gambio-shop.de/shop1/api.php/v2/customer_groups
Read-only parameters such as a resource's ID field are to be omitted.
The request body takes a GXCustomerGroup resource, containing the following writable properties:
{
"configurations": {
"discount": 0.5,
"maxOrder": 20,
"minOrder": 2.5,
"otDiscount": 0,
"unallowedPaymentModules": [
"paypal",
"cod",
"moneyorder"
],
"unallowedShippingModules": [
"selfpickup"
]
},
"names": [
{
"de": "Kinder",
"en": "Kids"
}
],
"settings": {
"addTaxOt": false,
"discountAttributes": false,
"fsk18": false,
"fsk18Display": false,
"graduatedPrices": false,
"otDiscountFlag": false,
"public": false,
"readReviews": false,
"showPrice": true,
"showPriceTax": false,
"writeReviews": false
}
}
{
"configurations": {
"discount": "int64",
"maxOrder": "int64",
"minOrder": "int64",
"otDiscount": "int64",
"unallowedPaymentModules": [
"string"
],
"unallowedShippingModules": [
"string"
]
},
"names": {
"de": "string",
"en": "string"
},
"settings": {
"addTaxOt": "boolean",
"discountAttributes": "boolean",
"fsk18": "boolean",
"fsk18Display": "boolean",
"graduatedPrices": "boolean",
"otDiscountFlag": "boolean",
"public": "boolean",
"readReviews": "boolean",
"showPrice": "boolean",
"showPriceTax": "boolean",
"writeReviews": "boolean"
}
}
Name | Type | Description | Additional |
---|---|---|---|
configurations | object | GXCustomerGroupConfigurations | Required |
configurations.discount | int64 | Required | |
configurations.maxOrder | int64 | Required | |
configurations.minOrder | int64 | Required | |
configurations.otDiscount | int64 | Required | |
configurations.unallowedPaymentModules[] | array of string | Required | |
configurations.unallowedShippingModules[] | array of string | Required | |
names | object | GXMultiLangOption | Required |
names.de | string | Required | |
names.en | string | Required | |
settings | object | GXCustomerGroupSettings | Required |
settings.addTaxOt | boolean | Required | |
settings.discountAttributes | boolean | Required | |
settings.fsk18 | boolean | Required | |
settings.fsk18Display | boolean | Required | |
settings.graduatedPrices | boolean | Required | |
settings.otDiscountFlag | boolean | Required | |
settings.public | boolean | Required | |
settings.readReviews | boolean | Required | |
settings.showPrice | boolean | Required | |
settings.showPriceTax | boolean | Required | |
settings.writeReviews | 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@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 |
---|---|---|
201 | Created Upon success, returns the newly created customer group |
GXCustomerGroup |
400 | Bad Request (Failed to create customer group) |
defaultErrorResponse |
Here are some example implementations for this operation.
MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"settings\":{\"public\":false,\"otDiscountFlag\":false,\"graduatedPrices\":false,\"showPrice\":false,\"showPriceTax\":false,\"addTaxOt\":false,\"discountAttributes\":false,\"fsk18\":false,\"fsk18Display\":false,\"writeReviews\":false,\"readReviews\":false},\"configurations\":{\"minOrder\":0,\"maxOrder\":0,\"discount\":0,\"otDiscount\":0,\"unallowedPaymentModules\":[\"\"],\"unallowedShippingModules\":[\"\"]}}"); Request request = new Request.Builder() .url("https://gambio-shop.de/shop1/api.php/v2/customer_groups") .post(body) .addHeader("accept", "application/json") .addHeader("content-type", "application/json") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build();
Response response = client.newCall(request).execute();
const options = { "method": "POST", "hostname": "gambio-shop.de", "port": null, "path": "/shop1/api.php/v2/customer_groups", "headers": {
"accept": "application/json",
"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({ id: 0, names: {en: '', de: ''}, settings: {
public: false,
otDiscountFlag: false,
graduatedPrices: false,
showPrice: false,
showPriceTax: false,
addTaxOt: false,
discountAttributes: false,
fsk18: false,
fsk18Display: false,
writeReviews: false,
readReviews: false
}, configurations: {
minOrder: 0,
maxOrder: 0,
discount: 0,
otDiscount: 0,
unallowedPaymentModules: ['<ADD STRING VALUE>'],
unallowedShippingModules: ['<ADD STRING VALUE>']
} })); req.end();
const options = { method: 'POST', url: 'https://gambio-shop.de/shop1/api.php/v2/customer_groups', headers: {
accept: 'application/json',
'content-type': 'application/json',
Authorization: 'Basic REPLACE_BASIC_AUTH'
}, body: {
id: 0,
names: {en: '<ADD STRING VALUE>', de: '<ADD STRING VALUE>'},
settings: {
public: false,
otDiscountFlag: false,
graduatedPrices: false,
showPrice: false,
showPriceTax: false,
addTaxOt: false,
discountAttributes: false,
fsk18: false,
fsk18Display: false,
writeReviews: false,
readReviews: false
},
configurations: {
minOrder: 0,
maxOrder: 0,
discount: 0,
otDiscount: 0,
unallowedPaymentModules: ['<ADD STRING VALUE>'],
unallowedShippingModules: ['<ADD STRING VALUE>']
}
}, json: true };
request(options, function (error, response, body) { if (error) throw new Error(error);
console.log(body); });
const req = unirest("POST", "https://gambio-shop.de/shop1/api.php/v2/customer_groups");
req.headers({ "accept": "application/json", "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>"
}, "settings": {
"public": false,
"otDiscountFlag": false,
"graduatedPrices": false,
"showPrice": false,
"showPriceTax": false,
"addTaxOt": false,
"discountAttributes": false,
"fsk18": false,
"fsk18Display": false,
"writeReviews": false,
"readReviews": false
}, "configurations": {
"minOrder": 0,
"maxOrder": 0,
"discount": 0,
"otDiscount": 0,
"unallowedPaymentModules": [
"<ADD STRING VALUE>"
],
"unallowedShippingModules": [
"<ADD STRING VALUE>"
]
} });
req.end(function (res) { if (res.error) throw new Error(res.error);
console.log(res.body); });
"en": "<ADD STRING VALUE>",
"de": "<ADD STRING VALUE>"
}, "settings": {
"public": false,
"otDiscountFlag": false,
"graduatedPrices": false,
"showPrice": false,
"showPriceTax": false,
"addTaxOt": false,
"discountAttributes": false,
"fsk18": false,
"fsk18Display": false,
"writeReviews": false,
"readReviews": false
}, "configurations": {
"minOrder": 0,
"maxOrder": 0,
"discount": 0,
"otDiscount": 0,
"unallowedPaymentModules": [
"<ADD STRING VALUE>"
],
"unallowedShippingModules": [
"<ADD STRING VALUE>"
]
} });
const xhr = new XMLHttpRequest(); xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () { if (this.readyState === this.DONE) {
console.log(this.responseText);
} });
xhr.open("POST", "https://gambio-shop.de/shop1/api.php/v2/customer_groups"); 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,\"names\":{\"en\":\"\",\"de\":\"\"},\"settings\":{\"public\":false,\"otDiscountFlag\":false,\"graduatedPrices\":false,\"showPrice\":false,\"showPriceTax\":false,\"addTaxOt\":false,\"discountAttributes\":false,\"fsk18\":false,\"fsk18Display\":false,\"writeReviews\":false,\"readReviews\":false},\"configurations\":{\"minOrder\":0,\"maxOrder\":0,\"discount\":0,\"otDiscount\":0,\"unallowedPaymentModules\":[\"\"],\"unallowedShippingModules\":[\"\"]}}" };
$.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/customer_groups", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"settings\":{\"public\":false,\"otDiscountFlag\":false,\"graduatedPrices\":false,\"showPrice\":false,\"showPriceTax\":false,\"addTaxOt\":false,\"discountAttributes\":false,\"fsk18\":false,\"fsk18Display\":false,\"writeReviews\":false,\"readReviews\":false},\"configurations\":{\"minOrder\":0,\"maxOrder\":0,\"discount\":0,\"otDiscount\":0,\"unallowedPaymentModules\":[\"\"],\"unallowedShippingModules\":[\"\"]}}", CURLOPT_HTTPHEADER => [
"Authorization: Basic REPLACE_BASIC_AUTH",
"accept: application/json",
"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/customer_groups'); $request->setMethod(HTTP_METH_POST);
$request->setHeaders([ 'accept' => 'application/json', 'content-type' => 'application/json', 'Authorization' => 'Basic REPLACE_BASIC_AUTH' ]);
$request->setBody('{"id":0,"names":{"en":"","de":""},"settings":{"public":false,"otDiscountFlag":false,"graduatedPrices":false,"showPrice":false,"showPriceTax":false,"addTaxOt":false,"discountAttributes":false,"fsk18":false,"fsk18Display":false,"writeReviews":false,"readReviews":false},"configurations":{"minOrder":0,"maxOrder":0,"discount":0,"otDiscount":0,"unallowedPaymentModules":[""],"unallowedShippingModules":[""]}}');
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,"names":{"en":"","de":""},"settings":{"public":false,"otDiscountFlag":false,"graduatedPrices":false,"showPrice":false,"showPriceTax":false,"addTaxOt":false,"discountAttributes":false,"fsk18":false,"fsk18Display":false,"writeReviews":false,"readReviews":false},"configurations":{"minOrder":0,"maxOrder":0,"discount":0,"otDiscount":0,"unallowedPaymentModules":[""],"unallowedShippingModules":[""]}}');
$request->setRequestUrl('https://gambio-shop.de/shop1/api.php/v2/customer_groups'); $request->setRequestMethod('POST'); $request->setBody($body);
$request->setHeaders([ 'accept' => 'application/json', '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 = "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"settings\":{\"public\":false,\"otDiscountFlag\":false,\"graduatedPrices\":false,\"showPrice\":false,\"showPriceTax\":false,\"addTaxOt\":false,\"discountAttributes\":false,\"fsk18\":false,\"fsk18Display\":false,\"writeReviews\":false,\"readReviews\":false},\"configurations\":{\"minOrder\":0,\"maxOrder\":0,\"discount\":0,\"otDiscount\":0,\"unallowedPaymentModules\":[\"\"],\"unallowedShippingModules\":[\"\"]}}"
headers = {
'accept': "application/json",
'content-type': "application/json",
'Authorization': "Basic REPLACE_BASIC_AUTH"
}
conn.request("POST", "/shop1/api.php/v2/customer_groups", payload, headers)
res = conn.getresponse() data = res.read()
print(data.decode("utf-8"))
url = "https://gambio-shop.de/shop1/api.php/v2/customer_groups"
payload = {
"id": 0,
"names": {
"en": "<ADD STRING VALUE>",
"de": "<ADD STRING VALUE>"
},
"settings": {
"public": False,
"otDiscountFlag": False,
"graduatedPrices": False,
"showPrice": False,
"showPriceTax": False,
"addTaxOt": False,
"discountAttributes": False,
"fsk18": False,
"fsk18Display": False,
"writeReviews": False,
"readReviews": False
},
"configurations": {
"minOrder": 0,
"maxOrder": 0,
"discount": 0,
"otDiscount": 0,
"unallowedPaymentModules": ["<ADD STRING VALUE>"],
"unallowedShippingModules": ["<ADD STRING VALUE>"]
}
} headers = {
"accept": "application/json",
"content-type": "application/json",
"Authorization": "Basic REPLACE_BASIC_AUTH"
}
response = requests.request("POST", url, json=payload, headers=headers)
print(response.text)
url = URI("https://gambio-shop.de/shop1/api.php/v2/customer_groups")
http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["content-type"] = 'application/json' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"id\":0,\"names\":{\"en\":\"\",\"de\":\"\"},\"settings\":{\"public\":false,\"otDiscountFlag\":false,\"graduatedPrices\":false,\"showPrice\":false,\"showPriceTax\":false,\"addTaxOt\":false,\"discountAttributes\":false,\"fsk18\":false,\"fsk18Display\":false,\"writeReviews\":false,\"readReviews\":false},\"configurations\":{\"minOrder\":0,\"maxOrder\":0,\"discount\":0,\"otDiscount\":0,\"unallowedPaymentModules\":[\"\"],\"unallowedShippingModules\":[\"\"]}}"
response = http.request(request) puts response.read_body
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST"); curl_easy_setopt(hnd, CURLOPT_URL, "https://gambio-shop.de/shop1/api.php/v2/customer_groups");
struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "accept: application/json"); 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\":\"\"},\"settings\":{\"public\":false,\"otDiscountFlag\":false,\"graduatedPrices\":false,\"showPrice\":false,\"showPriceTax\":false,\"addTaxOt\":false,\"discountAttributes\":false,\"fsk18\":false,\"fsk18Display\":false,\"writeReviews\":false,\"readReviews\":false},\"configurations\":{\"minOrder\":0,\"maxOrder\":0,\"discount\":0,\"otDiscount\":0,\"unallowedPaymentModules\":[\"\"],\"unallowedShippingModules\":[\"\"]}}");
CURLcode ret = curl_easy_perform(hnd);
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://gambio-shop.de/shop1/api.php/v2/customer_groups"
payload := strings.NewReader("{\"id\":0,\"names\":{\"en\":\"<ADD STRING VALUE>\",\"de\":\"<ADD STRING VALUE>\"},\"settings\":{\"public\":false,\"otDiscountFlag\":false,\"graduatedPrices\":false,\"showPrice\":false,\"showPriceTax\":false,\"addTaxOt\":false,\"discountAttributes\":false,\"fsk18\":false,\"fsk18Display\":false,\"writeReviews\":false,\"readReviews\":false},\"configurations\":{\"minOrder\":0,\"maxOrder\":0,\"discount\":0,\"otDiscount\":0,\"unallowedPaymentModules\":[\"<ADD STRING VALUE>\"],\"unallowedShippingModules\":[\"<ADD STRING VALUE>\"]}}")
req, _ := http.NewRequest("POST", 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,
@"names": @{ @"en": @"<ADD STRING VALUE>", @"de": @"<ADD STRING VALUE>" },
@"settings": @{ @"public": @NO, @"otDiscountFlag": @NO, @"graduatedPrices": @NO, @"showPrice": @NO, @"showPriceTax": @NO, @"addTaxOt": @NO, @"discountAttributes": @NO, @"fsk18": @NO, @"fsk18Display": @NO, @"writeReviews": @NO, @"readReviews": @NO },
@"configurations": @{ @"minOrder": @0, @"maxOrder": @0, @"discount": @0, @"otDiscount": @0, @"unallowedPaymentModules": @[ @"<ADD STRING VALUE>" ], @"unallowedShippingModules": @[ @"<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/customer_groups"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"]; [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, "names": [
"en": "<ADD STRING VALUE>",
"de": "<ADD STRING VALUE>"
], "settings": [
"public": false,
"otDiscountFlag": false,
"graduatedPrices": false,
"showPrice": false,
"showPriceTax": false,
"addTaxOt": false,
"discountAttributes": false,
"fsk18": false,
"fsk18Display": false,
"writeReviews": false,
"readReviews": false
], "configurations": [
"minOrder": 0,
"maxOrder": 0,
"discount": 0,
"otDiscount": 0,
"unallowedPaymentModules": ["<ADD STRING VALUE>"],
"unallowedShippingModules": ["<ADD STRING VALUE>"]
] ] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "https://gambio-shop.de/shop1/api.php/v2/customer_groups")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST" 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/customer_groups" 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,\"names\":{\"en\":\"\",\"de\":\"\"},\"settings\":{\"public\":false,\"otDiscountFlag\":false,\"graduatedPrices\":false,\"showPrice\":false,\"showPriceTax\":false,\"addTaxOt\":false,\"discountAttributes\":false,\"fsk18\":false,\"fsk18Display\":false,\"writeReviews\":false,\"readReviews\":false},\"configurations\":{\"minOrder\":0,\"maxOrder\":0,\"discount\":0,\"otDiscount\":0,\"unallowedPaymentModules\":[\"\"],\"unallowedShippingModules\":[\"\"]}}" in
Client.call ~headers ~body `POST uri
= fun (res, body_stream) -> (* Do stuff with the result *)