כל מה שקראתם כאן, המערכת עושה בשבילכם בקליק
45 יום לנסות את ביג בוס בחינם. בלי כרטיס אשראי, בלי התקנה: מייל וסיסמה וזהו.
מוצר חדש באתר נפתח גם בביג בוס
חנות שמוסיפה מוצר חדש לאתר יכולה לפתוח אותו גם בביג בוס, עם מק״ט, ברקוד, מחיר וקטגוריה. כך המוצר מוכן למסמכים ולמלאי בלי להקליד אותו שוב, והמערכת שלכם יכולה לשלוף מביג בוס את רשימת הפריטים והקטגוריות.
המדריך מפרט את הפעולות על פריטים ועל קטגוריות פריטים: הוספה, עדכון, שליפה ורשימה. מבנה הבקשה והתשובה הכללי מוסבר במדריך הקריאה הראשונה ל-API: מבנה הבקשה, התשובה וקודי התשובה.
הוספת פריט
הפעולה item_new פותחת פריט חדש. שדה החובה היחיד הוא שם הפריט:
| שדה | מה הוא | כללים |
|---|---|---|
| item_name | שם הפריט | חובה, עד 200 תווים |
| catalog_number | מק״ט | עד 100 תווים, נשמר באותיות גדולות |
| barcode | ברקוד | טקסט |
| group_id | קטגוריה | מספר של קטגוריה פעילה |
| price_buy_nis · price_sell_nis | מחיר קנייה ומחיר מכירה | מחיר המכירה 0 ומעלה, עד 2 ספרות אחרי הנקודה |
| price_sell_vat_included | האם מחיר המכירה כולל מע״מ | 0 או 1 |
| image_url · extended_description | קישור לתמונה ותיאור מורחב | עד 500 ועד 4,000 תווים |
| managed_in_inventory | פריט שמנוהל במלאי | 0 או 1 |
| inventory_min_qtty · inventory_max_qtty | כמות מינימום ומקסימום במלאי | מספרים |
| request_reference | מזהה מהמערכת שלכם | נשמר בפריט, ואינו מונע כפילות |
בהצלחה חוזר { "item_id": n } עם ההודעה "הפריט עודכן", גם בהוספה. שגיאות נפוצות: "לא ניתן להגדיר מספר פריט בעת הוספת הפריט", "שם הפריט הועבר ריק", "קבוצת הפריט לא מוגדרת", וקוד 409 עם "לא ניתן להוסיף פריט חדש: פריט עם מספר קטלוגי זה כבר קיים".
לכל פריט עובר מחיר מכירה אחד. מחירונים ומחיר לפי לקוח אינם עוברים דרך ה-API.
עדכון פריט
הפעולה item_update מקבלת את item_id ואת השדות שמשנים. פריט שלא נמצא או שמוגדר כלא פעיל מחזיר 404 עם "הפריט לא נמצא" או "הפריט מוגדר כלא פעיל". אם כבר יש תנועות מלאי על המק״ט הישן, אי אפשר לשנות אותו, והבקשה נדחית עם הודעה שמסבירה זאת.
שימו לב: פריט שמוגדר עם "נדרש מס' סידורי" מעדכנים מתוך ביג בוס, ולא דרך ה-API.
אם מוגדר אצלכם Webhook על הוספת פריט או על עדכון פריט, הפעולות האלה דרך ה-API שולחות גם אותו.
שליפת פריט ורשימת פריטים
item_get מקבלת item_id או catalog_number, ולא את שניהם יחד. בלי אף אחד מהם חוזרת ההודעה "יש להעביר שדה item_id או שדה catalog_number". התשובה כוללת את כל שדות הפריט, ובנוסף את שם הקטגוריה:
"data": {
"item_id": 4947, "item_name": "כבל USB-C 2 מטר - דוגמה",
"catalog_number": "DEMO-003", "group_name": "ציוד היקפי - דוגמה",
"managed_in_inventory": 1, ...
}
בבקשה לפריט שלא קיים, התשובה עלולה להגיע כשגיאת שרת (HTTP 500) ולא כ-204, ולכן הקוד שלכם צריך לטפל גם במקרה הזה.
item_list מחזירה את כל הפריטים הפעילים בקריאה אחת. אפשר לסנן לפי managed_in_inventory (-1 הכול, 0 לא מנוהלים, 1 מנוהלים במלאי) ולפי group_id (0 לכל הקטגוריות). בלי תוצאות חוזרת ההודעה "לא נמצאו פריטים התואמים לסינון".
קטגוריות פריטים
בביג בוס הקטגוריות נמצאות ב"הגדרות מערכת" ← "קטגוריות פריטים", וב-API שמן itemgroup. יש ארבע פעולות:
- itemgroup_new: הוספה עם
group_name. חוזרgroup_idעם "הקבוצה עודכנה". שם שכבר קיים נדחה בקוד 409, ו-group_idאסור בהוספה: "אין להעביר מס' קבוצה בעת הוספה". - itemgroup_update: שינוי שם, עם
group_idו-group_name. קטגוריה שלא קיימת: "הקבוצה לא נמצאה". - itemgroup_get: קטגוריה אחת לפי
group_id, עם המספר והשם שלה. - itemgroup_list: כל הקטגוריות הפעילות.
אין מחיקה של קטגוריה דרך ה-API.
בתפריט "הגדרות מערכת": "קטגוריות פריטים", שבו מנהלים את הקטגוריות שה-API קורא ויוצר.
כמויות המלאי של הפריטים נשלפות בפעולות נפרדות: משיכת כמויות מלאי למערכת חיצונית.
כל שכבת המדריכים מרוכזת בעמוד ממשק API בביג בוס.
