Gambio GX3 API: Create Withdrawal

Create a new withdrawal.

Request

POST https://gambio-shop.de/shop1/api.php/v2/withdrawals

Request body

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

Example
Schema

{
    "content": "This is an example for a withdrawal's content.",
    "createdByAdmin": true,
    "dateCreated": "2018-05-28 12:45:07",
    "id": 1,
    "order": {
        "customerCity": "Bremen",
        "customerCountry": "Germany",
        "customerEmail": "m.musterfrau@example.com",
        "customerFirstName": "Maxi",
        "customerGender": "Frau",
        "customerId": 0,
        "customerLastName": "Musterfrau",
        "customerPostCode": "28219",
        "customerStreetAddress": "Musterstraße 3",
        "deliveryDate": "1000-01-01 00:00:00",
        "orderDate": "2018-05-14 12:45:07",
        "orderId": 400276
    },
    "withdrawalDate": "2018-05-28 12:45:07"
}

{
    "content": "string",
    "createdByAdmin": "boolean",
    "dateCreated": "string",
    "order": {
        "customerCity": "string",
        "customerCountry": "string",
        "customerEmail": "string",
        "customerFirstname": "string",
        "customerGender": "string",
        "customerId": "int64",
        "customerLastName": "string",
        "customerPostCode": "string",
        "customerStreetAddress": "string",
        "deliveryDate": "string",
        "orderDate": "string"
    },
    "withdrawalDate": "string"
}

Properties

Name	Type	Description
content	string
createdByAdmin	boolean
dateCreated	string
order	object	GXWithdrawalOrder
order.customerCity	string
order.customerCountry	string
order.customerEmail	string
order.customerFirstname	string
order.customerGender	string
order.customerId	int64
order.customerLastName	string
order.customerPostCode	string
order.customerStreetAddress	string
order.deliveryDate	string
order.orderDate	string
withdrawalDate	string

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 newly created withdrawal	GXWithdrawal
400	Bad Request (Missing data)	defaultErrorResponse

Example Snippets

Here are some example implementations for this operation.

Shell

cURL
wget
HTTPie

Java

Unirest
OkHttp

Node.js

native
Request
Unirest

JavaScript

native
jQuery

PHP

cURL
http1
http2

Python

Python 3
Requests

curl --request POST \ --url https://gambio-shop.de/shop1/api.php/v2/withdrawals \ --header 'accept: application/json' \ --header 'authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: application/json' \ --data '{"id":0,"withdrawalDate":"","content":"","order":{"orderId":0,"customerId":0,"customerGender":"","customerFirstname":"","customerLastName":"","customerStreetAddress":"","customerPostCode":"","customerCity":"","customerCountry":"","customerEmail":"","orderDate":"","deliveryDate":""},"dateCreated":"","createdByAdmin":false}'

wget --quiet \ --method POST \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --header 'authorization: Basic REPLACE_BASIC_AUTH' \ --body-data '{"id":0,"withdrawalDate":"","content":"","order":{"orderId":0,"customerId":0,"customerGender":"","customerFirstname":"","customerLastName":"","customerStreetAddress":"","customerPostCode":"","customerCity":"","customerCountry":"","customerEmail":"","orderDate":"","deliveryDate":""},"dateCreated":"","createdByAdmin":false}' \ --output-document \ - https://gambio-shop.de/shop1/api.php/v2/withdrawals

echo '{"id":0,"withdrawalDate":"","content":"","order":{"orderId":0,"customerId":0,"customerGender":"","customerFirstname":"","customerLastName":"","customerStreetAddress":"","customerPostCode":"","customerCity":"","customerCountry":"","customerEmail":"","orderDate":"","deliveryDate":""},"dateCreated":"","createdByAdmin":false}' | \ http POST https://gambio-shop.de/shop1/api.php/v2/withdrawals \ accept:application/json \ authorization:'Basic REPLACE_BASIC_AUTH' \ content-type:application/json

HttpResponse response = Unirest.post("https://gambio-shop.de/shop1/api.php/v2/withdrawals") .header("accept", "application/json") .header("content-type", "application/json") .header("authorization", "Basic REPLACE_BASIC_AUTH") .body("{\"id\":0,\"withdrawalDate\":\"\",\"content\":\"\",\"order\":{\"orderId\":0,\"customerId\":0,\"customerGender\":\"\",\"customerFirstname\":\"\",\"customerLastName\":\"\",\"customerStreetAddress\":\"\",\"customerPostCode\":\"\",\"customerCity\":\"\",\"customerCountry\":\"\",\"customerEmail\":\"\",\"orderDate\":\"\",\"deliveryDate\":\"\"},\"dateCreated\":\"\",\"createdByAdmin\":false}") .asString();

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"id\":0,\"withdrawalDate\":\"\",\"content\":\"\",\"order\":{\"orderId\":0,\"customerId\":0,\"customerGender\":\"\",\"customerFirstname\":\"\",\"customerLastName\":\"\",\"customerStreetAddress\":\"\",\"customerPostCode\":\"\",\"customerCity\":\"\",\"customerCountry\":\"\",\"customerEmail\":\"\",\"orderDate\":\"\",\"deliveryDate\":\"\"},\"dateCreated\":\"\",\"createdByAdmin\":false}"); Request request = new Request.Builder() .url("https://gambio-shop.de/shop1/api.php/v2/withdrawals") .post(body) .addHeader("accept", "application/json") .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/withdrawals"); var request = new RestRequest(Method.POST); request.AddHeader("authorization", "Basic REPLACE_BASIC_AUTH"); request.AddHeader("content-type", "application/json"); request.AddHeader("accept", "application/json"); request.AddParameter("application/json", "{\"id\":0,\"withdrawalDate\":\"\",\"content\":\"\",\"order\":{\"orderId\":0,\"customerId\":0,\"customerGender\":\"\",\"customerFirstname\":\"\",\"customerLastName\":\"\",\"customerStreetAddress\":\"\",\"customerPostCode\":\"\",\"customerCity\":\"\",\"customerCountry\":\"\",\"customerEmail\":\"\",\"orderDate\":\"\",\"deliveryDate\":\"\"},\"dateCreated\":\"\",\"createdByAdmin\":false}", ParameterType.RequestBody); IRestResponse response = client.Execute(request);

var http = require("https");

var options = { "method": "POST", "hostname": "gambio-shop.de", "port": null, "path": "/shop1/api.php/v2/withdrawals", "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, withdrawalDate: '', content: '', order: { orderId: 0, customerId: 0, customerGender: '', customerFirstname: '', customerLastName: '', customerStreetAddress: '', customerPostCode: '', customerCity: '', customerCountry: '', customerEmail: '', orderDate: '', deliveryDate: '' }, dateCreated: '', createdByAdmin: false })); req.end();

var request = require("request");

var options = { method: 'POST', url: 'https://gambio-shop.de/shop1/api.php/v2/withdrawals', headers: { authorization: 'Basic REPLACE_BASIC_AUTH', 'content-type': 'application/json', accept: 'application/json' }, body: { id: 0, withdrawalDate: '', content: '', order: { orderId: 0, customerId: 0, customerGender: '', customerFirstname: '', customerLastName: '', customerStreetAddress: '', customerPostCode: '', customerCity: '', customerCountry: '', customerEmail: '', orderDate: '', deliveryDate: '' }, dateCreated: '', createdByAdmin: false }, json: true };

request(options, function (error, response, body) { if (error) throw new Error(error);

console.log(body); });

var unirest = require("unirest");

var req = unirest("POST", "https://gambio-shop.de/shop1/api.php/v2/withdrawals");

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

req.type("json"); req.send({ "id": 0, "withdrawalDate": "", "content": "", "order": { "orderId": 0, "customerId": 0, "customerGender": "", "customerFirstname": "", "customerLastName": "", "customerStreetAddress": "", "customerPostCode": "", "customerCity": "", "customerCountry": "", "customerEmail": "", "orderDate": "", "deliveryDate": "" }, "dateCreated": "", "createdByAdmin": false });

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

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

var data = JSON.stringify({ "id": 0, "withdrawalDate": "", "content": "", "order": { "orderId": 0, "customerId": 0, "customerGender": "", "customerFirstname": "", "customerLastName": "", "customerStreetAddress": "", "customerPostCode": "", "customerCity": "", "customerCountry": "", "customerEmail": "", "orderDate": "", "deliveryDate": "" }, "dateCreated": "", "createdByAdmin": false });

var 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/withdrawals"); xhr.setRequestHeader("accept", "application/json"); 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/withdrawals", "method": "POST", "headers": { "accept": "application/json", "content-type": "application/json", "authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"id\":0,\"withdrawalDate\":\"\",\"content\":\"\",\"order\":{\"orderId\":0,\"customerId\":0,\"customerGender\":\"\",\"customerFirstname\":\"\",\"customerLastName\":\"\",\"customerStreetAddress\":\"\",\"customerPostCode\":\"\",\"customerCity\":\"\",\"customerCountry\":\"\",\"customerEmail\":\"\",\"orderDate\":\"\",\"deliveryDate\":\"\"},\"dateCreated\":\"\",\"createdByAdmin\":false}" }

$.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/withdrawals", 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,\"withdrawalDate\":\"\",\"content\":\"\",\"order\":{\"orderId\":0,\"customerId\":0,\"customerGender\":\"\",\"customerFirstname\":\"\",\"customerLastName\":\"\",\"customerStreetAddress\":\"\",\"customerPostCode\":\"\",\"customerCity\":\"\",\"customerCountry\":\"\",\"customerEmail\":\"\",\"orderDate\":\"\",\"deliveryDate\":\"\"},\"dateCreated\":\"\",\"createdByAdmin\":false}", 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; }

<?php

$request = new HttpRequest(); $request->setUrl('https://gambio-shop.de/shop1/api.php/v2/withdrawals'); $request->setMethod(HTTP_METH_POST);

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

$request->setBody('{"id":0,"withdrawalDate":"","content":"","order":{"orderId":0,"customerId":0,"customerGender":"","customerFirstname":"","customerLastName":"","customerStreetAddress":"","customerPostCode":"","customerCity":"","customerCountry":"","customerEmail":"","orderDate":"","deliveryDate":""},"dateCreated":"","createdByAdmin":false}');

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,"withdrawalDate":"","content":"","order":{"orderId":0,"customerId":0,"customerGender":"","customerFirstname":"","customerLastName":"","customerStreetAddress":"","customerPostCode":"","customerCity":"","customerCountry":"","customerEmail":"","orderDate":"","deliveryDate":""},"dateCreated":"","createdByAdmin":false}');

$request->setRequestUrl('https://gambio-shop.de/shop1/api.php/v2/withdrawals'); $request->setRequestMethod('POST'); $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();

import http.client

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

payload = "{\"id\":0,\"withdrawalDate\":\"\",\"content\":\"\",\"order\":{\"orderId\":0,\"customerId\":0,\"customerGender\":\"\",\"customerFirstname\":\"\",\"customerLastName\":\"\",\"customerStreetAddress\":\"\",\"customerPostCode\":\"\",\"customerCity\":\"\",\"customerCountry\":\"\",\"customerEmail\":\"\",\"orderDate\":\"\",\"deliveryDate\":\"\"},\"dateCreated\":\"\",\"createdByAdmin\":false}"

headers = { 'accept': "application/json", 'content-type': "application/json", 'authorization': "Basic REPLACE_BASIC_AUTH" }

conn.request("POST", "/shop1/api.php/v2/withdrawals", payload, headers)

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

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

import requests

url = "https://gambio-shop.de/shop1/api.php/v2/withdrawals"

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

print(response.text)

require 'uri' require 'net/http'

url = URI("https://gambio-shop.de/shop1/api.php/v2/withdrawals")

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,\"withdrawalDate\":\"\",\"content\":\"\",\"order\":{\"orderId\":0,\"customerId\":0,\"customerGender\":\"\",\"customerFirstname\":\"\",\"customerLastName\":\"\",\"customerStreetAddress\":\"\",\"customerPostCode\":\"\",\"customerCity\":\"\",\"customerCountry\":\"\",\"customerEmail\":\"\",\"orderDate\":\"\",\"deliveryDate\":\"\"},\"dateCreated\":\"\",\"createdByAdmin\":false}"

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

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST"); curl_easy_setopt(hnd, CURLOPT_URL, "https://gambio-shop.de/shop1/api.php/v2/withdrawals");

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,\"withdrawalDate\":\"\",\"content\":\"\",\"order\":{\"orderId\":0,\"customerId\":0,\"customerGender\":\"\",\"customerFirstname\":\"\",\"customerLastName\":\"\",\"customerStreetAddress\":\"\",\"customerPostCode\":\"\",\"customerCity\":\"\",\"customerCountry\":\"\",\"customerEmail\":\"\",\"orderDate\":\"\",\"deliveryDate\":\"\"},\"dateCreated\":\"\",\"createdByAdmin\":false}");

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/withdrawals"

payload := strings.NewReader("{\"id\":0,\"withdrawalDate\":\"<ADD STRING VALUE>\",\"content\":\"<ADD STRING VALUE>\",\"order\":{\"orderId\":0,\"customerId\":0,\"customerGender\":\"<ADD STRING VALUE>\",\"customerFirstname\":\"<ADD STRING VALUE>\",\"customerLastName\":\"<ADD STRING VALUE>\",\"customerStreetAddress\":\"<ADD STRING VALUE>\",\"customerPostCode\":\"<ADD STRING VALUE>\",\"customerCity\":\"<ADD STRING VALUE>\",\"customerCountry\":\"<ADD STRING VALUE>\",\"customerEmail\":\"<ADD STRING VALUE>\",\"orderDate\":\"<ADD STRING VALUE>\",\"deliveryDate\":\"<ADD STRING VALUE>\"},\"dateCreated\":\"<ADD STRING VALUE>\",\"createdByAdmin\":false}")

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))

}

#import

NSDictionary *headers = @{ @"accept": @"application/json", @"content-type": @"application/json", @"authorization": @"Basic REPLACE_BASIC_AUTH" }; NSDictionary *parameters = @{ @"id": @0, @"withdrawalDate": @"", @"content": @"", @"order": @{ @"orderId": @0, @"customerId": @0, @"customerGender": @"", @"customerFirstname": @"", @"customerLastName": @"", @"customerStreetAddress": @"", @"customerPostCode": @"", @"customerCity": @"", @"customerCountry": @"", @"customerEmail": @"", @"orderDate": @"", @"deliveryDate": @"" }, @"dateCreated": @"", @"createdByAdmin": @NO };

NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://gambio-shop.de/shop1/api.php/v2/withdrawals"] 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];

import Foundation

let headers = [ "accept": "application/json", "content-type": "application/json", "authorization": "Basic REPLACE_BASIC_AUTH" ] let parameters = [ "id": 0, "withdrawalDate": "", "content": "", "order": [ "orderId": 0, "customerId": 0, "customerGender": "", "customerFirstname": "", "customerLastName": "", "customerStreetAddress": "", "customerPostCode": "", "customerCity": "", "customerCountry": "", "customerEmail": "", "orderDate": "", "deliveryDate": "" ], "dateCreated": "", "createdByAdmin": false ]

let postData = NSJSONSerialization.dataWithJSONObject(parameters, options: nil, error: nil)

var request = NSMutableURLRequest(URL: NSURL(string: "https://gambio-shop.de/shop1/api.php/v2/withdrawals")!, cachePolicy: .UseProtocolCachePolicy, timeoutInterval: 10.0) request.HTTPMethod = "POST" 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/withdrawals" 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,\"withdrawalDate\":\"\",\"content\":\"\",\"order\":{\"orderId\":0,\"customerId\":0,\"customerGender\":\"\",\"customerFirstname\":\"\",\"customerLastName\":\"\",\"customerStreetAddress\":\"\",\"customerPostCode\":\"\",\"customerCity\":\"\",\"customerCountry\":\"\",\"customerEmail\":\"\",\"orderDate\":\"\",\"deliveryDate\":\"\"},\"dateCreated\":\"\",\"createdByAdmin\":false}" in

Client.call ~headers ~body `POST uri >>= fun (res, body_stream) -> (* Do stuff with the result *)