סקירת נקודות קצה

כל נקודות הקצה הפעילות של v2 במבט אחד. לחצו על כותרת קבוצה למעבר לתיעוד המלא — פרמטרים, מבני תגובה וטבלאות שגיאות.

כתובת בסיס: https://app.shipos.co.il/api/v2 · כל נקודות הקצה דורשות כותרות client-credentials מלבד GET /ping.

ציבורי

מתודה	נתיב	תיאור
GET	/ping	בדיקת תקינות — נקודת הקצה היחידה ללא אימות.

מעקב

מתודה	נתיב	תיאור
GET	/tracking/{shipping_code}	סטטוס ללא PII לפי קוד מעקב. דורש אימות ומצומצם לרישיונות שלכם.

חשבון

מתודה	נתיב	תיאור
GET	/account	הלקוח המאומת, כולל הרישיונות המוטמעים בתגובה.

משלוחים

מתודה	נתיב	תיאור
GET	/shipments	רשימת משלוחים.
POST	/shipments	יצירת משלוח (אידמפוטנטי).
POST	/shipments/labels	כתובות URL של תוויות עבור משלוחים רבים בבת אחת.
GET	/shipments/{shipment}	משלוח בודד.
GET	/shipments/{shipment}/status	סטטוס מסירה עדכני.
GET	/shipments/{shipment}/label	תווית למשלוח בודד.
POST	/shipments/{shipment}/cancel	ביטול אצל חברת השילוח.

‏{shipment} מקבל את ה-uuid, את קוד המעקב של חברת השליחויות או את קוד המעקב הקצר.

החזרות

החזרות אינן משאב נפרד: יוצרים אותן עם POST /shipments ו-ship_data.type = 2, ומציגים אותן עם GET /shipments?filter[type]=2. ראו טיפול בהחזרות.

אצוות

מתודה	נתיב	תיאור
GET	/batches	רשימת אצוות (הפריטים מוטמעים בתגובה).
POST	/batches	הכנסה לתור של עד 2,000 משלוחים (202).
GET	/batches/{uuid}	תשאול התקדמות האצווה.
GET	/batches/{uuid}/items	תוצאות לכל פריט, כולל כשלים.

ייצוא

מתודה	נתיב	תיאור
POST	/exports	הכנסת ייצוא CSV לתור (202).
GET	/exports/{export}	תשאול התקדמות הייצוא.

הזמנות

מתודה	נתיב	תיאור
GET	/orders	רשימת הזמנות (עימוד מבוסס cursor).
GET	/orders/{order}	הזמנה בודדת עם המשלוחים שלה.
GET	/orders/{order}/shipments	המשלוחים השייכים להזמנה.

נקודות איסוף

מתודה	נתיב	תיאור
GET	/pickup-points	רשת נקודות האיסוף של חברת השילוח — סינון לפי city/limit, מיון לפי קרבה באמצעות lat+lng או address.

רישיונות

מתודה	נתיב	תיאור
GET	/licenses	כל חשבונות חברות השילוח שבבעלותכם — המקור לערכי license_key.

נתוני עזר

מתודה	נתיב	תיאור
GET	/reference/shipping-statuses	שמות סטטוסי משלוח מוכרים.
GET	/reference/service-types	סוגי שירות (משלוח לבית / נקודת איסוף / החלפה / החזרה).

Webhooks

מתודה	נתיב	תיאור
GET	/webhooks	רשימת מנויים.
POST	/webhooks	הרשמה (סוד החתימה מוחזר פעם אחת בלבד).
PATCH	/webhooks/{uuid}	עדכון URL / אירועים.
POST	/webhooks/{uuid}/ping	שליחת מסירת בדיקה.
GET	/webhooks/{uuid}/deliveries	ניסיונות מסירה אחרונים.
DELETE	/webhooks/{uuid}	הסרת המנוי.

התראות

מתודה	נתיב	תיאור
GET	/notifications/sms-settings	הגדרות SMS נוכחיות.
PUT	/notifications/sms-settings	עדכון הגדרות SMS.
POST	/notifications/test-sms	שליחת SMS לבדיקה.
GET	/notifications/sms-logs	יומן ביקורת של הודעות SMS שנשלחו.
GET	/notifications/sms-templates	רשימת תבניות הודעה.
POST	/notifications/sms-templates	יצירה / עדכון (upsert) של תבנית.
PUT	/notifications/sms-templates/{template}/toggle	הפעלה / השבתה של תבנית.
DELETE	/notifications/sms-templates/{template}	מחיקת תבנית.