GET
/
v1
/
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"
  }
]

Authorizations

​
Authorization
string
header
required

API key authentication using Basic Auth. Use your API key as both username and password. See the Authentication guide for complete setup instructions.

Query Parameters

​
search
string

Search orders by customer name, email or order ID

Example:

"john@example.com"

​
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

​
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

200
application/json

Orders retrieved successfully

The response is of type object[].