Skip to main content
GET
/
v1
/
metadata
/
{scope}
/
{id}
Get metadata
curl --request GET \
  --url https://api.quickbutik.com/v1/metadata/{scope}/{id} \
  --header 'Authorization: Basic <encoded-value>'
{}

Authorizations

​
Authorization
string
header
required

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:

  1. Format your credentials as api_key:api_key (using the SAME API key for both username and password)
  2. Base64 encode the formatted string
  3. 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

​
scope
enum<string>
required

order|product|customer

Available options:
order,
product,
customer
​
id
string
required

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}
string

Key-value pairs of metadata