Skip to main content
GET
/
v1
/
orders
Get orders
curl --request GET \
  --url https://api.quickbutik.com/v1/orders \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "order_id": "12345",
    "date_created": "2025-01-29 11:35:39",
    "total_amount": "148.95",
    "status": "1",
    "products": [
      {
        "id": 123,
        "product_id": 123,
        "variant_id": 123,
        "title": "<string>",
        "price": "<string>",
        "qty": 123,
        "sku": "<string>",
        "variant": "<string>",
        "weight": "<string>",
        "status": "<string>",
        "image": "<string>",
        "app": {
          "productpackages": [
            {
              "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

​
search
string

Search orders by customer name, email or order ID

Example:

"[email protected]"

​
offset
integer
default:0

Number of records to skip for pagination

Required range: x >= 0
​
limit
integer
default:1000

Maximum number of records to return (max 1000)

Required range: 1 <= x <= 1000
​
sort_order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
order_by
enum<string>
default:order_id

Field to sort by

Available options:
price,
date,
order_id
​
include_details
boolean
default:false

Include detailed order information including products, customer details, payment info, and product package components for bundled products

​
order_id
string

Order number for the order you would like to load

​
from_date_paid
string

Fetch paid orders since a specific date. UNIX timestamp should be used here

Example:

"1596097247"

​
to_date_paid
string

Fetch paid orders up to a specific date. UNIX timestamp should be used here

Example:

"1596097247"

​
from_status_date
string

Fetch orders since a specific status transition date. UNIX timestamp should be used here

Example:

"1596097247"

​
status
string

Fetch orders with a specific status. Can be used together with from_date_paid parameter

Example:

"done"

​
apps_load
boolean

Optional. Used together with a specific order_id and will return app specific order data (such as productproperties from the order)

Example:

true

Response

Orders retrieved successfully

​
order_id
string
Example:

"12345"

​
date_created
string
Example:

"2025-01-29 11:35:39"

​
total_amount
string
Example:

"148.95"

​
status
string
Example:

"1"

​
products
object[]

Order products. Only included when include_details=true.