Get metadata
curl --request GET \
--url https://api.quickbutik.com/v1/metadata/{scope}/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.quickbutik.com/v1/metadata/{scope}/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.quickbutik.com/v1/metadata/{scope}/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quickbutik.com/v1/metadata/{scope}/{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 => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.quickbutik.com/v1/metadata/{scope}/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.quickbutik.com/v1/metadata/{scope}/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quickbutik.com/v1/metadata/{scope}/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{}{
"code": 404,
"error": "Resource not found"
}{
"code": 404,
"error": "Resource not found"
}{
"code": 404,
"error": "Resource not found"
}Metadata
Get metadata
Get metadata for selected scope and id
GET
/
v1
/
metadata
/
{scope}
/
{id}
Get metadata
curl --request GET \
--url https://api.quickbutik.com/v1/metadata/{scope}/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.quickbutik.com/v1/metadata/{scope}/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.quickbutik.com/v1/metadata/{scope}/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quickbutik.com/v1/metadata/{scope}/{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 => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.quickbutik.com/v1/metadata/{scope}/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.quickbutik.com/v1/metadata/{scope}/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quickbutik.com/v1/metadata/{scope}/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{}{
"code": 404,
"error": "Resource not found"
}{
"code": 404,
"error": "Resource not found"
}{
"code": 404,
"error": "Resource not found"
}Authorizations
Basic Authentication with API Keys
The Quickbutik API uses Basic Authentication where you use your API key as both the username and password.
How it works:
- Format your credentials as
api_key:api_key(using the SAME API key for both username and password) - Base64 encode the formatted string
- Include in the Authorization header as:
Authorization: Basic ENCODED_STRING
Example:
- API Key:
sk_live_abc123 - Formatted:
sk_live_abc123:sk_live_abc123 - Base64 Encoded:
c2tfbGl2ZV9hYmMxMjM6c2tfbGl2ZV9hYmMxMjM= - Header:
Authorization: Basic c2tfbGl2ZV9hYmMxMjM6c2tfbGl2ZV9hYmMxMjM=
cURL Example:
curl https://api.quickbutik.com/v1/orders -u your_api_key:your_api_key
All API requests must be made over HTTPS. Requests made over HTTP will be rejected.
API keys can be generated in the Quickbutik Control Panel under Settings → API.
Path Parameters
order|product|customer
Available options:
order, product, customer Id of the selected scope. E.g when scope is product and id is 1, metadata for product with id 1 will be returned
Response
Metadata retrieved successfully
Key-value pairs of metadata