מוצרים

מוצרים מוגדרים מראש לשימוש בעסקאות ובמסמכים. אין שיוכים (associations) למשאב זה.

רשימת מוצרים get

שליפת רשימה עם עימוד.

https://your-company.example.com/api/products

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרי שאילתה

פרמטר סוג תיאור
page אופציונלי integer מספר עמוד. ברירת מחדל: 1.
per_page אופציונלי integer גודל עמוד (עד 100 ברוב המשאבים). ברירת מחדל: 15.
q אופציונלי string מחרוזת חיפוש חופשית.
order אופציונלי string מיון. דוגמה: `created_at` או `created_at|desc`.
select אופציונלי string בחירת שדות. דוגמה: `id;first_name;email`.
with אופציונלי string טעינת יחסים (eager load).

שליפת מוצר get

שליפת רשומה בודדת לפי מזהה.

https://your-company.example.com/api/products/{product}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
product חובה integer מזהה הרשומה.

יצירת מוצר post

יצירת רשומה חדשה. תשובה מוצלחת מחזירה סטטוס 201.

https://your-company.example.com/api/products

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
name חובה string שם ייחודי.
sku אופציונלי string מק״ט ייחודי.
description אופציונלי string תיאור.
unit_price חובה number מחיר יחידה (decimal).
direct_cost אופציונלי number עלות ישירה.
tax_rate אופציונלי number שיעור מס 0–100.
tax_label אופציונלי string תווית מס (למשל מע״מ).
unit אופציונלי string יחידת מידה.
is_active אופציונלי boolean פעיל (ברירת מחדל true).

דוגמת גוף בקשה

{
    "name": "רישיון שנתי",
    "sku": "LIC-2026",
    "unit_price": 1500,
    "direct_cost": 400,
    "tax_label": "מע״מ",
    "tax_rate": 17,
    "unit": "unit",
    "is_active": true
}

עדכון מוצר put

עדכון חלקי או מלא של רשומה קיימת.

https://your-company.example.com/api/products/{product}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
product חובה integer מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
name אופציונלי string שם ייחודי.
sku אופציונלי string מק״ט ייחודי.
description אופציונלי string תיאור.
unit_price אופציונלי number מחיר יחידה (decimal).
direct_cost אופציונלי number עלות ישירה.
tax_rate אופציונלי number שיעור מס 0–100.
tax_label אופציונלי string תווית מס (למשל מע״מ).
unit אופציונלי string יחידת מידה.
is_active אופציונלי boolean פעיל (ברירת מחדל true).

מחיקת מוצר delete

מחיקה רכה. תשובה מוצלחת: 204 No Content.

https://your-company.example.com/api/products/{product}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
product חובה integer מזהה הרשומה.

רשימת מוצרים פעילים get

שליפת מוצרים פעילים בלבד.

https://your-company.example.com/api/products/active

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרי שאילתה

פרמטר סוג תיאור
page אופציונלי integer מספר עמוד. ברירת מחדל: 1.
per_page אופציונלי integer גודל עמוד (עד 100 ברוב המשאבים). ברירת מחדל: 15.
q אופציונלי string מחרוזת חיפוש חופשית.
order אופציונלי string מיון. דוגמה: `created_at` או `created_at|desc`.
select אופציונלי string בחירת שדות. דוגמה: `id;first_name;email`.
with אופציונלי string טעינת יחסים (eager load).

© 2026 BeCRM