Gambio GX3 API: Get Order (Single)

Get a single order record through a GET request. This method supports all the GET parameters that are mentioned in the "Introduction" section of this documentation. Important: Whenever you make requests that will return multiple orders the response will contain a smaller version of each order record called order-list-item. This is done for better performance because the creation of a complete order record takes significant time (many objects are involved). If you still need the complete data of an order record you will have to make an extra GET request with the ID provided.

Request

GET https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}

Path parameters

Parameter name	Value	Description	Additional
order_id	int64	The order ID	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
200	OK Upon success, returns the order resource	GXOrder

Example Snippets

Here are some example implementations for this operation.

 curl --request GET \
  --url https://gambio-shop.de/shop1/api.php/v2/orders/{order_id} \
  --header 'authorization: Basic REPLACE_BASIC_AUTH' \
  --header 'content-type: application/json'

 wget --quiet \
  --method GET \
  --header 'content-type: application/json' \
  --header 'authorization: Basic REPLACE_BASIC_AUTH' \
  --output-document 
 
https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}

 http GET https://gambio-shop.de/shop1/api.php/v2/orders/{order_id} \
authorization:'Basic REPLACE_BASIC_AUTH' \
content-type:application/json

 HttpResponse response = Unirest.get("https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}")
.header("content-type", "application/json")
.header("authorization", "Basic REPLACE_BASIC_AUTH")
.asString();

 OkHttpClient client = new OkHttpClient();
 
 
Request request = new Request.Builder()
  .url("https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}")
  .get()
  .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/orders/{order_id}");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "Basic REPLACE_BASIC_AUTH");
request.AddHeader("content-type", "application/json");
IRestResponse response = client.Execute(request);

 var http = require("https");
 
var options = {
  "method": "GET",
  "hostname": "gambio-shop.de",
  "port": null,
  "path": "/shop1/api.php/v2/orders/{order_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.end();

 var request = require("request");
 
var options = { method: 'GET',
  url:
   'https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}',
  headers:
   { authorization: 'Basic REPLACE_BASIC_AUTH',
 
 'content-type': 'application/json' } };
 
request(options, function (error, response, body) {
  if (error) throw new Error(error);
 
console.log(body);
});

 var unirest = require("unirest");
 
var req = unirest("GET", "https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}");
 
req.headers({
  "authorization": "Basic REPLACE_BASIC_AUTH",
  "content-type": "application/json"
});
 
req.end(function (res) {
  if (res.error) throw new Error(res.error);
 
console.log(res.body);
});

 var data = null;
 
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
 
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
 
console.log(this.responseText);
 
}
});
 
xhr.open("GET", "https://gambio-shop.de/shop1/api.php/v2/orders/{order_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/orders/{order_id}",
  "method": "GET",
  "headers": {
 
"content-type": "application/json",
"authorization": "Basic REPLACE_BASIC_AUTH"
 
}
}
 
$.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/orders/{order_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/orders/{order_id}');
$request->setMethod(HTTP_METH_GET);
 
$request->setHeaders(array(
  'authorization' => 'Basic REPLACE_BASIC_AUTH',
  'content-type' => 'application/json'
));
 
try {
  $response = $request->send();
 
echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

 <?php
 
$client = new http\Client;
$request = new http\Client\Request;
 
$request->setRequestUrl('https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}');
$request->setRequestMethod('GET');
$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")
 
headers = {
 
'content-type': "application/json",
'authorization': "Basic REPLACE_BASIC_AUTH"
}
 
conn.request("GET", "/shop1/api.php/v2/orders/{order_id}", headers=headers)
 
res = conn.getresponse()
data = res.read()
 
print(data.decode("utf-8"))

 import requests
 
url = "https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}"
 
headers = {
 
'content-type': "application/json",
'authorization': "Basic REPLACE_BASIC_AUTH"
}
 
response = requests.request("GET", url, headers=headers)
 
print(response.text)

 require 'uri'
require 'net/http'
 
url = URI("https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}")
 
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
request = Net::HTTP::Get.new(url)
request["content-type"] = 'application/json'
request["authorization"] = 'Basic REPLACE_BASIC_AUTH'
 
response = http.request(request)
puts response.read_body

 CURL *hnd = curl_easy_init();
 
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://gambio-shop.de/shop1/api.php/v2/orders/{order_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);
 
CURLcode ret = curl_easy_perform(hnd);

 package main
 
import (
 
"fmt"
"net/http"
"io/ioutil"
 
)
 
func main() {
 
url := "https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}"
 
req, _ := http.NewRequest("GET", url, nil)
 
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" };
 
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}"]
 
                                                   cachePolicy:NSURLRequestUseProtocolCachePolicy
                                               timeoutInterval:10.0];
 
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];
 
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"
]
 
var request = NSMutableURLRequest(URL: NSURL(string: "https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}")!,
 
                                    cachePolicy: .UseProtocolCachePolicy,
                                timeoutInterval: 10.0)
 
request.HTTPMethod = "GET"
request.allHTTPHeaderFields = headers
 
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/orders/{order_id}" in
let headers = Header.add_list (Header.init ()) [
  ("content-type", "application/json");
  ("authorization", "Basic REPLACE_BASIC_AUTH");
] in
 
Client.call ~headers `GET uri
 
= fun (res, body_stream) ->
  (* Do stuff with the result *)

	curl --request GET \
	--url https://gambio-shop.de/shop1/api.php/v2/orders/{order_id} \
	--header 'authorization: Basic REPLACE_BASIC_AUTH' \
	--header 'content-type: application/json'

	wget --quiet \
	--method GET \
	--header 'content-type: application/json' \
	--header 'authorization: Basic REPLACE_BASIC_AUTH' \
	--output-document


	https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}

	http GET https://gambio-shop.de/shop1/api.php/v2/orders/{order_id} \
	authorization:'Basic REPLACE_BASIC_AUTH' \
	content-type:application/json

	HttpResponse response = Unirest.get("https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}")
	.header("content-type", "application/json")
	.header("authorization", "Basic REPLACE_BASIC_AUTH")
	.asString();

	OkHttpClient client = new OkHttpClient();


	Request request = new Request.Builder()
	.url("https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}")
	.get()
	.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/orders/{order_id}");
	var request = new RestRequest(Method.GET);
	request.AddHeader("authorization", "Basic REPLACE_BASIC_AUTH");
	request.AddHeader("content-type", "application/json");
	IRestResponse response = client.Execute(request);

	var http = require("https");

	var options = {
	"method": "GET",
	"hostname": "gambio-shop.de",
	"port": null,
	"path": "/shop1/api.php/v2/orders/{order_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.end();

	var request = require("request");

	var options = { method: 'GET',
	url:
	'https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}',
	headers:
	{ authorization: 'Basic REPLACE_BASIC_AUTH',

	`'content-type': 'application/json' } };`


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

	console.log(body);
	});

	var unirest = require("unirest");

	var req = unirest("GET", "https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}");

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

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

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

	var data = null;

	var xhr = new XMLHttpRequest();
	xhr.withCredentials = true;

	xhr.addEventListener("readystatechange", function () {
	if (this.readyState === this.DONE) {

	`console.log(this.responseText);`


	}
	});

	xhr.open("GET", "https://gambio-shop.de/shop1/api.php/v2/orders/{order_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/orders/{order_id}",
	"method": "GET",
	"headers": {

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


	}
	}

	$.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/orders/{order_id}",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "GET",
	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/orders/{order_id}');
	$request->setMethod(HTTP_METH_GET);

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

	try {
	$response = $request->send();

	echo $response->getBody();
	} catch (HttpException $ex) {
	echo $ex;
	}

	<?php

	$client = new http\Client;
	$request = new http\Client\Request;

	$request->setRequestUrl('https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}');
	$request->setRequestMethod('GET');
	$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")

	headers = {

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


	conn.request("GET", "/shop1/api.php/v2/orders/{order_id}", headers=headers)

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

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

	import requests

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

	headers = {

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


	response = requests.request("GET", url, headers=headers)

	print(response.text)

	require 'uri'
	require 'net/http'

	url = URI("https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}")

	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	http.verify_mode = OpenSSL::SSL::VERIFY_NONE

	request = Net::HTTP::Get.new(url)
	request["content-type"] = 'application/json'
	request["authorization"] = 'Basic REPLACE_BASIC_AUTH'

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

	CURL *hnd = curl_easy_init();

	curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
	curl_easy_setopt(hnd, CURLOPT_URL, "https://gambio-shop.de/shop1/api.php/v2/orders/{order_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);

	CURLcode ret = curl_easy_perform(hnd);

	package main

	import (

	`"fmt"`
	"net/http"
	"io/ioutil"


	)

	func main() {

	`url := "https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}"`

	req, _ := http.NewRequest("GET", url, nil)

	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" };`


	NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}"]

	`cachePolicy:NSURLRequestUseProtocolCachePolicy`
	timeoutInterval:10.0];


	[request setHTTPMethod:@"GET"];
	[request setAllHTTPHeaderFields:headers];

	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"
	]

	var request = NSMutableURLRequest(URL: NSURL(string: "https://gambio-shop.de/shop1/api.php/v2/orders/{order_id}")!,

	`cachePolicy: .UseProtocolCachePolicy,`
	timeoutInterval: 10.0)


	request.HTTPMethod = "GET"
	request.allHTTPHeaderFields = headers

	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/orders/{order_id}" in
	let headers = Header.add_list (Header.init ()) [
	("content-type", "application/json");
	("authorization", "Basic REPLACE_BASIC_AUTH");
	] in

	Client.call ~headers `GET uri



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