Skip to main content
GET
/
v1
/
products
Get products
curl --request GET \
  --url https://api.quickbutik.com/v1/products \
  --header 'Authorization: Basic <encoded-value>'
{
  "product": {
    "id": "12",
    "sku": "BBB222",
    "hasVariants": "1",
    "title": "VITA Ljus lampskärm",
    "visible": "1",
    "qty": "<string>",
    "price": "899",
    "purchase_price": "<string>",
    "before_price": "<string>",
    "description": "<string>",
    "seo_title": "<string>",
    "seo_description": "<string>",
    "weight": "0",
    "gtin": "<string>",
    "date_modified": "2017-09-27 10:29:22",
    "variants": [
      {
        "id": "1058",
        "ovalue_id_1": "987",
        "product_id": "2436",
        "sku": "Grönd",
        "price": "200.00",
        "qty": "<string>",
        "weight": "<string>",
        "before_price": "<string>",
        "purchase_price": "<string>",
        "image_id": "<string>",
        "gtin": "<string>",
        "supplier_sku": "<string>",
        "hidden": "<string>",
        "qty_location": "",
        "preorder": "<string>",
        "min_purchase_quantity": "<string>",
        "max_purchase_quantity": "<string>",
        "preselected": "<string>",
        "disable_minusqty": true,
        "values": [
          {
            "ovalue_field": "987",
            "name": "Färg",
            "val": "Grön \" 32 size"
          }
        ]
      }
    ],
    "product_package_products": [
      {
        "product_id": 456,
        "variant_id": 789,
        "title": "T-shirt Red",
        "variant": "Large",
        "qty": 2,
        "sku": "TSHIRT-RED-L",
        "price": "299"
      }
    ]
  }
}

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.

Query Parameters

​
product_id
string

Product ID(s) to fetch. Can be a single ID or comma-separated list of IDs

Example:

"123,456,789"

​
sku
string

Product SKU(s) to fetch. Can be a single SKU or comma-separated list of SKUs

Example:

"T-SHIRT-123,HOODIE-456"

​
search
string

Search products by title, description, SKU, or variant SKU. Note: When this parameter is used, the response returns a direct array instead of the usual {product: [...]} wrapper.

Example:

"cotton t-shirt"

​
categories
string

Filter products by category ID(s). Can be a single ID or comma-separated list of IDs

Example:

"1,2,3"

​
visibility
boolean

Filter products by visibility status

Example:

true

​
from_date_modified
integer

Filter products modified since this date (UNIX timestamp)

Example:

1596097247

​
order_by
enum<string>
default:id

Field to sort products by

Available options:
id,
title,
price,
qty,
sku,
visits,
purchase_price
​
sort_order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
limit
integer
default:100

The maximum number of rows returned. The default is 100, and the value may not exceed 500

Required range: 1 <= x <= 500
​
offset
integer
default:0

The amount of rows to skip before returning. This can be used to loop through all objects if there are more than the limit allows to be returned

Required range: x >= 0
​
include_details
boolean

Indicates whether or not details are returned. When true, includes additional information such as images, categories, metadata, and product package components for bundled products. Default is false for multiple items, true for single items

Response

Product(s) retrieved successfully

Response structure when fetching by product_id/sku or without search parameter. Returns object with 'product' key containing either a single product or array of products.

​
product
object