נקודות קצה משלוחים

מדריך זה מתעד את כל נקודות הקצה של API הקשורות למשלוחים, כולל יצירת משלוחים, אחזור פרטים, ניהול סטטוסים ויצירת מדבקות.

POST /shipping/open_new_order

יצירת משלוח חדש עם ספק משלוחים.

בקשה

URL: https://app.shipos.co.il/api/shipping/open_new_order שיטה: POST Content-Type: application/x-www-form-urlencoded

פרמטרים נדרשים

פרמטרי נתוני הזמנה

פורמט מערך Items

items[0][name]=Product Name
items[0][quantity]=2
items[0][sku]=SKU-001
items[0][price]=99.90
items[0][is_virtual]=false

דוגמת בקשה

curl -X POST https://app.shipos.co.il/api/shipping/open_new_order \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d "license_key=LIC-12345" \
  -d "domain=mystore.com" \
  -d "version=3.1.1" \
  -d "order_id=5001" \
  -d "shipping_first_name=David" \
  -d "shipping_last_name=Cohen" \
  -d "shipping_address_1=Ben Yehuda 50" \
  -d "shipping_city=Tel Aviv" \
  -d "shipping_postcode=6343200" \
  -d "shipping_phone=0521234567" \
  -d "shipping_email=david@example.com" \
  -d "total_weight=2.0" \
  -d "num_of_packages=1" \
  -d "notes=Please leave at door" \
  -d "items[0][name]=T-Shirt" \
  -d "items[0][quantity]=1" \
  -d "items[0][sku]=TSH-BLK-L" \
  -d "items[0][price]=89.90"

תגובת הצלחה (200)

{
  "success": true,
  "data": {
    "order_id": "5001",
    "shipping_code": "SHP-78901",
    "tracking_number": "ZZ987654321",
    "tracking_url": "https://tracking.provider.co.il/ZZ987654321",
    "status": "created",
    "label_url": "https://app.shipos.co.il/api/shipping/label?id=78901"
  }
}

תגובת שגיאה (422)

{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "shipping_city": ["The shipping city field is required."],
    "shipping_phone": ["The shipping phone format is invalid."]
  }
}

⚠️ אזהרה: שדה is_virtual בפריטי הזמנה חשוב. פריטים וירטואליים (מוצרים דיגיטליים, שירותים) לא דורשים משלוח פיזי. אם כל הפריטים בהזמנה וירטואליים, יצירת המשלוח עלולה להידחות.

POST /shipping/get_order_details

אחזור פרטי משלוח/הזמנה קיימים.

URL: https://app.shipos.co.il/api/shipping/get_order_details שיטה: POST

פרמטרים

POST /shipping/get_shipping_status

קבלת סטטוס משלוח נוכחי ומידע מעקב.

URL: https://app.shipos.co.il/api/shipping/get_shipping_status שיטה: POST

פרמטרים זהים ל-get_order_details.

POST /shipping/label

יצירה ואחזור של מדבקת משלוח PDF למשלוח בודד.

URL: https://app.shipos.co.il/api/shipping/label שיטה: POST

פרמטרים נוספים

הערה: כתובות URL של מדבקות זמניות ופגות אחרי תקופה. הורידו או הדפיסו מדבקות מיד אחרי יצירה.

POST /shipping/bulk-label

יצירת מדבקות למספר משלוחים ב-PDF אחד.

URL: https://app.shipos.co.il/api/shipping/bulk-label שיטה: POST

פרמטרים נוספים

POST /shipping/order

אחזור כל המשלוחים המשויכים להזמנה ספציפית.

URL: https://app.shipos.co.il/api/shipping/order שיטה: POST

הערה: להזמנה יכולים להיות מספר משלוחים (למשל אם פריטים נשלחים בנפרד או נוצר משלוח חלופי).

POST /shipping/change_order_status

שינוי סטטוס משלוח (למשל ביטול משלוח).

URL: https://app.shipos.co.il/api/shipping/change_order_status שיטה: POST

פרמטרים נוספים

⚠️ אזהרה: לא כל מעברי סטטוס מותרים. למשל, לא ניתן לבטל משלוח שכבר נמסר. ה-API יחזיר שגיאה אם המעבר לא תקין.

מדריך סטטוסים

צעדים הבאים

• נקודות קצה מיקומי איסוף - שאילתת נקודות איסוף
• נקודות קצה רישיונות - ניהול רישיונות
• Webhooks - הגדרת הודעות webhook
• סקירת API - אימות ושימוש כללי