סקירה כללית

כל נקודות הקצה של v1, ה-API מהגרסה הקודמת, בטבלה אחת. כל הנתיבים יחסיים ל:

https://app.shipos.co.il/api

גרסה קודמת

v1 מתוחזק עבור אינטגרציות קיימות ואינו מקבל יכולות חדשות. פיתוח חדש שייך ל-v2. מקבילות נתיב-אחר-נתיב נמצאות במעבר ל-v2.

---

משלוחים ותוויות

אלה יושבות תחת ה-prefix של shipping וחולקות שלושה רכיבי middleware: תיעוד בקשות, נרמול תשובות, ובדיקת hasLicense שקוראת את license_key ואת domain מגוף הבקשה. ראו אימות.

מתודה	נתיב	תיאור	עמוד
POST	/shipping/open_new_order	יצירת משלוח מתוך הזמנה. משחזרת את התשובה של עצמה במשך שעה בניסיון חוזר.	משלוחים
POST	/shipping/get_order_details	קריאת משלוח בודד לפי ה-shipping_code שלו.	משלוחים
POST	/shipping/get_shipping_status	קריאת סטטוס חברת השילוח של משלוח בודד.	משלוחים
POST	/shipping/change_order_status	ביטול או שינוי הסטטוס של משלוח אצל חברת השילוח.	משלוחים
POST	/shipping/order	רשימת כל המשלוחים השייכים להזמנה.	משלוחים
POST	/shipping/{shipment}/status	סטטוס לפי פרמטר בנתיב. מחוץ לקבוצת hasLicense — אימות שונה.	משלוחים
POST	/shipping/label	כתובת URL של תווית עבור משלוח בודד.	תוויות
POST	/shipping/order-label	כתובת URL של תווית לכל משלוח בהזמנה שלמה.	תוויות
POST	/shipping/bulk-label	כתובת URL אחת של תווית מאוחדת עבור משלוחים רבים.	תוויות
POST	/shipping/pickup_locations	רשת נקודות האיסוף של חברת השילוח של הקורא. אינה מקבלת פרמטרים משל עצמה.	נקודות איסוף

אקספרס ומשלוח באותו יום

גם אלה תחת ה-prefix של shipping ואותה בדיקת hasLicense, אבל הן GET עם פרמטרים ב-query string — נקודות הקצה היחידות מסוג זה ב-v1.

מתודה	נתיב	תיאור	עמוד
GET	/shipping/get_express_delivery_enabled	האם אקספרס זמין עבור הרישיון.	משלוח אקספרס
GET	/shipping/same_day_delivery_quote	הצעת מחיר/היתכנות למשלוח באותו יום.	משלוח אקספרס
GET	/shipping/create_shipping_promise	התחייבות לחלון זמן שהוצע למשלוח באותו יום.	משלוח אקספרס
GET	/shipping/get_express_delivery_status	הסטטוס של משלוח אקספרס.	משלוח אקספרס

רישיונות

שימו לב לפיצול: user-by-license נמצאת בתוך קבוצת hasLicense, ואילו שני הנתיבים /license/* אינם — הם מקבלים מפתח רישיון אך אינם מוגנים על ידי ה-middleware, והם אינם משתמשים במעטפת התקנית של v1.

מתודה	נתיב	תיאור	עמוד
GET	/shipping/user-by-license	החשבון שבבעלותו הרישיון. מוגנת על ידי hasLicense.	רישיונות
GET	/license/check_license	אימות תקינות של מפתח רישיון. ללא שכבת הגנה, גוף תשובה שטוח.	רישיונות
GET	/license/activate_license	קישור רישיון לדומיין. ללא שכבת הגנה, גוף תשובה שטוח.	רישיונות

אפליקציית הנמען

ממשק פנימי (first-party) של אפליקציית המסירה הפונה לצרכן, המוגן בסוד אפליקציה משותף ולא ברישיון. אינטגרציות של סוחרים אינן משתמשות בו.

מתודה	נתיב	תיאור	עמוד
GET	/get_app_user	שליפת משתמש אפליקציה.	משתמשי אפליקציה
POST	/create_app_user	רישום משתמש אפליקציה.	משתמשי אפליקציה
GET	/shipping/phone_number	המשלוחים של הנמען המאומת.	משתמשי אפליקציה

---

לא מתועד כאן

הקובץ routes/api.php נושא גם את קבוצות הנתיבים wix/* ו-shopify/*. אלה ה-backends הפרטיים של ממשקי הניהול של Wix ושל Shopify — הם מתאמתים באמצעות session tokens של הפלטפורמה, משנים צורה יחד עם ה-front end, ואינם נושאים שום הבטחת תאימות. הם אינם חלק ממשטח האינטגרציה של v1 והושמטו מהתיעוד הזה במכוון.

התנהגות רוחבית

• מעטפת — {data, message, success, warning} כמעט בכל נתיב, כאשר success ולא סטטוס ה-HTTP הוא שנושא את הפסיקה. כמה נתיבים חורגים מכך; כל חריגה מצוינת בעמוד שלה ומסוכמת בשגיאות.
• הגבלת קצב — 500 בקשות בדקה, לפי המשתמש המאומת כשיש כזה, ולפי כתובת ה-IP של הלקוח אחרת. חריגה מכך מחזירה 429.
• תיעוד — כל בקשה שעוברת דרך ה-prefix של shipping נכתבת אל api_request_logs, כולל גוף התשובה המנורמל (נחתך ב-60,000 בתים). זהו התיעוד היחיד של קריאות יוצאות לחברות שילוח, ולכן ניתן לענות ממנו על פניות תמיכה.