REST API מלא לאינטגרציה עם חנויות QuickShop.
הזמנות, מוצרים, מלאי, לקוחות, Storefront ומובייל - הכל בגישת API.
https://my-quickshop.com/api/v1היכנסו לאדמין → Settings → API Keys ויצרו מפתח חדש עם ה-Scopes הרלוונטיים.
כל קריאה דורשת Header בשם X-API-Key עם המפתח שלכם.
קראו את התיעוד המלא ותתחילו לבנות אינטגרציות מדהימות!
curl -X GET "https://my-quickshop.com/api/v1/orders" \
-H "X-API-Key: qs_live_xxxxxxxxxxxxxxxxxxxx"כל הקריאות דורשות API Key
orders:readorders:writeproducts:readproducts:writecustomers:readinventory:readinventory:writediscounts:readdiscounts:writeanalytics:readwebhooks:readwebhooks:writestorefront:readcustomer:readcustomer:writemobile:writeX-RateLimit-Remaining - כמה קריאות נשארוX-RateLimit-Reset - מתי יתאפס המונהunauthorized- API key לא תקין או חסרforbidden- אין הרשאה (scope חסר)not_found- משאב לא נמצאinvalid_request- בקשה לא תקינהrate_limited- חריגה ממגבלת קריאות/api/v1/ordersרשימת הזמנות/api/v1/orders/{id}פרטי הזמנה/api/v1/orders/{id}עדכון הזמנה/api/v1/productsרשימת מוצרים/api/v1/productsיצירת מוצר/api/v1/products/{id}פרטי מוצר/api/v1/products/{id}עדכון מוצר/api/v1/categoriesרשימת קטגוריות/api/v1/categoriesיצירת קטגוריה/api/v1/categories/{id}פרטי קטגוריה/api/v1/categories/{id}עדכון קטגוריה/api/v1/categories/{id}מחיקת קטגוריה/api/v1/inventory/{id}צפייה במלאי/api/v1/inventory/{id}עדכון מלאי/api/v1/customersרשימת לקוחות/api/v1/discountsרשימת הנחות וקופונים/api/v1/discountsיצירת הנחה/קופון/api/v1/discounts/{id}פרטי הנחה/api/v1/discounts/{id}עדכון הנחה/api/v1/discounts/{id}מחיקת הנחה/api/v1/analyticsסטטיסטיקות וניתוח נתונים/api/v1/webhooksרשימת וובהוקים/api/v1/webhooksיצירת וובהוק/api/v1/webhooks/{id}פרטי וובהוק/api/v1/webhooks/{id}עדכון וובהוק/api/v1/webhooks/{id}מחיקת וובהוקEndpoints ציבוריים לפרונט חנות ואפליקציית מובייל. אימות לקוח באמצעות Customer Session.
/api/storefront/{slug}/configהגדרות חנות (שם, לוגו, צבעים, מטבע)/api/storefront/{slug}/app-configהגדרות אפליקציית מובייל (JSON)/api/storefront/{slug}/app-configשמירת הגדרות מובייל (Admin)/api/storefront/{slug}/productsקטלוג מוצרים (פילטר, מיון, דפדוף)/api/storefront/{slug}/products/{productSlug}פרטי מוצר + וריאנטים + תמונות/api/storefront/{slug}/categoriesרשימת קטגוריות (עם ספירת מוצרים)/api/customer/ordersהיסטוריית הזמנות הלקוח/api/customer/orders/{orderNumber}פרטי הזמנה + מעקב משלוח/api/customer/updateעדכון פרופיל לקוח/api/customer/addressesרשימת כתובות/api/customer/addressesהוספת כתובת/api/customer/addressesמחיקת כתובת/api/customer/wishlistרשימת המשאלות/api/customer/wishlistהוספה לרשימה/api/customer/wishlistToggle (הוסף/הסר)/api/customer/wishlist/{productId}בדיקה אם מוצר ברשימה/api/mobile/device/registerרישום מכשיר לפוש נוטיפיקציות/api/mobile/notifications/preferencesהעדפות התראות/api/mobile/notifications/preferencesעדכון העדפות התראותה-Storefront API משתמש ב-Customer Session (OTP via Email) לאימות לקוחות. Endpoints ציבוריים כמו config, products ו-categories לא דורשים אימות. Endpoints של לקוח (customer/*) דורשים session token.
const API_KEY = 'qs_live_xxxx';
const BASE_URL = 'https://my-quickshop.com/api/v1';
async function getOrders() {
const response = await fetch(`${BASE_URL}/orders`, {
headers: {
'X-API-Key': API_KEY,
},
});
const { data, meta } = await response.json();
return data;
}
async function updateInventory(productId, adjustment) {
const response = await fetch(`${BASE_URL}/inventory/${productId}`, {
method: 'PATCH',
headers: {
'X-API-Key': API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify({
type: 'product',
adjustment,
}),
});
return response.json();
}import requests
API_KEY = 'qs_live_xxxx'
BASE_URL = 'https://my-quickshop.com/api/v1'
HEADERS = {'X-API-Key': API_KEY}
def get_orders(page=1, limit=50):
response = requests.get(
f'{BASE_URL}/orders',
headers=HEADERS,
params={'page': page, 'limit': limit}
)
return response.json()['data']
def update_order_status(order_id, status):
response = requests.patch(
f'{BASE_URL}/orders/{order_id}',
headers=HEADERS,
json={'status': status}
)
return response.json()// יצירת מוצר חדש עם הורדת תמונות לשרת
const response = await fetch('https://my-quickshop.com/api/v1/products', {
method: 'POST',
headers: {
'X-API-Key': API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: "מוצר לדוגמא",
slug: "sample-product",
description: "תיאור המוצר",
price: "99.90",
compare_price: "149.90",
inventory: 100,
track_inventory: true,
category_ids: ["cat_123"],
// תמונות - URL חיצוני
images: [
{ url: "https://example.com/image1.jpg", alt: "תמונה ראשית", is_primary: true },
{ url: "https://example.com/image2.jpg" }
],
// download_images: true = הורד וממיר ל-WebP ב-Vercel Blob
// download_images: false (ברירת מחדל) = שמור URL כמו שהוא
download_images: true
})
});
// Response
{
"success": true,
"data": {
"id": "prod_xxx",
"name": "מוצר לדוגמא",
"slug": "sample-product",
"images": [
{ "id": "img_1", "url": "https://xxx.blob.vercel-storage.com/...", "is_primary": true }
]
}
}💡 עם download_images: true, תמונות יורדות → ממירות ל-WebP → עולות ל-Vercel Blob.
🎥 וידאו (media_type: "video") נשמר כ-URL כפי שהוא - שלחו URL מ-Cloudinary או מקור אחר.
const STORE = 'my-store';
const BASE = 'https://my-quickshop.com/api';
// שליפת הגדרות חנות
const config = await fetch(
`${BASE}/storefront/${STORE}/config`
).then(r => r.json());
// שליפת מוצרים עם פילטרים
const products = await fetch(
`${BASE}/storefront/${STORE}/products?page=1&limit=20&sort=newest`
).then(r => r.json());
// שליפת מוצר בודד
const product = await fetch(
`${BASE}/storefront/${STORE}/products/my-product`
).then(r => r.json());// הוספה לרשימת משאלות
await fetch('/api/customer/wishlist', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Cookie': sessionCookie,
},
body: JSON.stringify({
productId: 'prod_xxx'
}),
});
// שליפת הזמנות לקוח
const orders = await fetch(
'/api/customer/orders?page=1&limit=10',
{ headers: { 'Cookie': sessionCookie } }
).then(r => r.json());
// עדכון פרופיל
await fetch('/api/customer/update', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
'Cookie': sessionCookie,
},
body: JSON.stringify({
firstName: 'דניאל',
lastName: 'כהן',
phone: '0501234567',
}),
});{
"data": [
{
"id": "uuid",
"order_number": "1001",
"status": "processing",
"total": 480.00,
"created_at": "2026-01-06T10:00:00Z"
}
],
"meta": {
"pagination": {
"page": 1,
"limit": 50,
"total": 150,
"total_pages": 3,
"has_next": true,
"has_prev": false
}
}
}{
"error": {
"code": "not_found",
"message": "Order not found"
}
}צרו חשבון מפתח, קבלו API Key והתחילו לבנות אינטגרציות מדהימות.