תמצית :ה XML מפרט כלל המוצרים המופיעים בכל מסמך ,כאשר כל מוצר מופיע במקטע נפרד. הממשק נדרש לשדר את נתוני המסמכים שהופקו ביום קודם ורלוונטיים ללקוח X
2. מבנה ה XML :
• Package = מספר חבילות
• Quantity = מס' יחידות בכל חבילה
• Item_Sku= מק"ט
• Value date = תאריך מסמך
• reference_date = תאריך ערך
• supply_date = תאריך אספקה
• supply_time = שעת אספקה , לא חובה , ניתן להשאיר ערך קבוע 00:00
• account_code = מספר לקוח אצל הספק
• doc_type = סוג מסמך חשבונית / ת.משלוח
• doc_num = מספר מסמך
• Price = מחיר המוצר
• Remarks = הערות
דוגמא :
3 27
לחמא00905
2020-12-07
2020-12-07
2020-12-08
00:00
23101
11
193320
10
הערה להזמנה : זאת הזמנה לתת לאוריאל במפעל
1 40
הבלקן8386
2020-12-07
2020-12-07
2020-12-08
00:00
23101
11
193320
הערה להזמנה : זאת הזמנה לתת לאוריאל במפעל
בעזרת ממשק זה ניתן לקרוא ממערכת רסטיגו הזמנות שלא נקלטו.
Method: GET
Url: https://api.restigo.co.il/api/thirdParty/newOrder
Headers: RESTIGO-API-KEY
Required params: start_date, end_date
המפתח שנשלח מקושר לסניף ספציפי וניתן פרטנית.
כל התאריכים בפורמט yyyy-mm-dd :string.
שם השדה בעברית | type | שם השדה |
מספר הזמנה | int | id |
מספר סניף | int | branch_id |
שם סניף | string | branch_name |
מזהה ספק | int | supplier_id |
שם ספק | string | supplier_name |
תאריך הזמנה | string "2025-01-06 09:19:51" | order_date |
תאריך אספקה | string ״yyyy-mm-dd״ | supply_date |
סטטוס הזמנה | string | order_status |
הערות להזמנה | String, nullable | notes |
שם המשתמש שיצר את הזמנה | string | create_by |
תאריך יצירת הזמנה | string "2025-01-06 09:19:51" | created_at |
מוצרים | array | items |
מקט | string | items.sku |
שם מוצר | string | items.product_name |
כמות שהוזמנה | int | items.quantity |
מחיר ללא מע״מ, כולל פיקדון ומיסים | double | items.price |
מחיר כולל, price*quantity | double | items.sum |
יחידות מידה במארז | int | items.package_items |
יחידת מידה | string | items.scale |
Response:
{
"data": [
{
"id": 1650114,
"branch_id": 1193,
"branch_name": "עין כרמל",
"supplier_id": 8978,
"supplier_name": "גד – שמי דרעי",
"order_date": "2025-01-03 15:36:48",
"supply_date": "2025-01-05",
"order_status": "ממתין לאישור",
"notes": null,
"create_by": "תמיר חלואה",
"created_at": "2025-01-03T13:35:04.000000Z",
"items": [
{
"sku": "91303",
"product_name": "חלב בקרטון 3%",
"quantity": 5,
"price": 62.76,
"sum": 313.8,
"package_items": 12,
"scale": "ליטר"
},
{
"sku": "",
"product_name": "שמנת ק\"ג טבעי",
"quantity": 1,
"price": 29.95,
"sum": 29.95,
"package_items": 2,
"scale": "ק\"ג"
},
{
"sku": "60507",
"product_name": "מוצרלה מיוחדת",
"quantity": 1,
"price": 237.56,
"sum": 237.56,
"package_items": 3,
"scale": "ק\"ג"
},
{
"sku": "71303",
"product_name": "יוגורט 3 ליטר",
"quantity": 2,
"price": 22.72,
"sum": 45.44,
"package_items": 1,
"scale": "ליטר"
},
{
"sku": "71308",
"product_name": "שמנת מתוקה 2 ליטר",
"quantity": 1,
"price": 259.32,
"sum": 259.32,
"package_items": 6,
"scale": "ליטר"
},
{
"sku": "91115",
"product_name": "ברי צרפתי 130 גרם",
"quantity": 1,
"price": 10.98,
"sum": 10.98,
"package_items": 1,
"scale": "גרם"
}
]
}
]
}
בעזרת ממשק זה ניתן לקרוא ממערכת רסטיגו מסמכי קליטות של הזמנות.
Method: GET
Url: https://api.restigo.co.il/api/thirdParty/newReceivedOrder
Headers: RESTIGO-API-KEY
Required params: start_date, end_date
Optional params: status
המפתח שנשלח מקושר לסניף ספציפי וניתן פרטנית.
כל התאריכים בפורמט yyyy-mm-dd :string.
התשובה החוזרת מהשרת מכילה רשימה של מסמכים בצורה הבאה (לשדות הכחולים יש הסבר למטה):
[
{
“Id”: int, //db row
“doc_number”: string, // מס׳ מסמך
“doc_type”: int // סוג מסמך
“doc_date”: string // תאריך קליטה
“sent_at”: string, // תאריך יצירת מסמך
“supplier_id”: int, // מס׳ ספק
“supplier_name”: string, // שם ספק
“branch_id”: int, // מס׳ סניף
“branch_name”: string, // שם סניף
“status״: int, // פתוח או נעול
“notes”: string, // הערות
“total_with_vat”: double // סכום כולל מע״מ
“total_without_vat”: double // סכום ללא מע״מ
“customer_code”: string // קוד לקוח
“Assigned_number”: string, // מס הקצאה
“items”: [ // מוצרים
{
“catalog_number”: string // מק״ט
“name”: string, // שם
“package_items”: double, // כמות מארזים
“amount: double, // כמות יחידות
“total_amount”: double, // יחידות * מארזים
“scale”: string, // יחידת מידה
“price”: double, // מחיר
“has_vat”: boolean, // חייב במע״מ
“debit_account”: string, // חשבון חובה ברמת המוצר
“Is_weighted”: boolean // האם נקלט לפי יחידות
}
]
}
]
הסבר שדה status:
הסטטוס אומר האם המסמך במצב נעול (2) או פתוח (1)
מסמך נחשב לנעול (2) אם הוא עונה על אחד מ3 הסעיפים הבאים:
- המסמך שולם במערכת
- המסמך יוצא להנהלת חשבונות
- המסמך ננעל ידנית ע״י המשתמש
כל מסמך שלא עונה על אחד מ3 הסעיפים הללו יחזור עם סטטוס פתוח (1).
הסבר שדה doc_type:
יש במערכת 9 סוגי מסמכים ולכל אחד מספר מזהה משלו.
- חשבונית מס (1)
- תעודת משלוח (2)
- חשבונית קופה קטנה מזומן (3)
- חשבונית קופה קטנה אשראי (6)
- חשבונית זיכוי (7)
- תעודת החזרה (8)
- חשבונית עסקה (9)
- הצעת מחיר (10)
- קבלה (11)
- מס / קבלה (12)
מידע נוסף על שדה customer_code :
קוד לקוח, במידה ואין קוד לקוח (כאשר מדובר בספק זמני במערכת רסטיגו) תחזור מחרוזת ריקה
API הזמנות שלא נקלטו
בעזרת ממשק זה ניתן לקרוא ממערכת רסטיגו הזמנות שלא נקלטו.
Method: GET
Url: https://api.restigo.co.il/api/thirdParty/newOrder
Headers: RESTIGO-API-KEY
Required params: start_date, end_date
Date format:yyyy-mm-dd
המפתח שנשלח מקושר לסניף ספציפי וניתן פרטנית.
שם השדה בעברית | type | שם השדה |
מספר הזמנה | int | id |
מספר סניף | int | branch_id |
שם סניף | string | branch_name |
מזהה ספק | int | supplier_id |
שם ספק | string | supplier_name |
תאריך הזמנה | string "2025-01-06 09:19:51" | order_date |
תאריך אספקה | string ״yyyy-mm-dd״ | supply_date |
סטטוס הזמנה | string | order_status |
הערות להזמנה | String, nullable | notes |
שם המשתמש שיצר את הזמנה | string | create_by |
תאריך יצירת הזמנה | string "2025-01-06 09:19:51" | created_at |
מוצרים | array | items |
מקט | string | items.sku |
שם מוצר | string | items.product_name |
כמות שהוזמנה | int | items.quantity |
מחיר ללא מע״מ, כולל פיקדון ומיסים | double | items.price |
מחיר כולל, price*quantity | double | items.sum |
יחידות מידה במארז | int | items.package_items |
יחידת מידה | string | items.scale |
Response:
{
"data": [
{
"id": 1650114,
"branch_id": 1193,
"branch_name": "עין כרמל",
"supplier_id": 8978,
"supplier_name": "גד – שמי דרעי",
"order_date": "2025-01-03 15:36:48",
"supply_date": "2025-01-05",
"order_status": "ממתין לאישור",
"notes": null,
"create_by": "תמיר חלואה",
"created_at": "2025-01-03T13:35:04.000000Z",
"items": [
{
"sku": "91303",
"product_name": "חלב בקרטון 3%",
"quantity": 5,
"price": 62.76,
"sum": 313.8,
"package_items": 12,
"scale": "ליטר"
},
{
"sku": "",
"product_name": "שמנת ק\"ג טבעי",
"quantity": 1,
"price": 29.95,
"sum": 29.95,
"package_items": 2,
"scale": "ק\"ג"
},
{
"sku": "60507",
"product_name": "מוצרלה מיוחדת",
"quantity": 1,
"price": 237.56,
"sum": 237.56,
"package_items": 3,
"scale": "ק\"ג"
},
{
"sku": "71303",
"product_name": "יוגורט 3 ליטר",
"quantity": 2,
"price": 22.72,
"sum": 45.44,
"package_items": 1,
"scale": "ליטר"
},
{
"sku": "71308",
"product_name": "שמנת מתוקה 2 ליטר",
"quantity": 1,
"price": 259.32,
"sum": 259.32,
"package_items": 6,
"scale": "ליטר"
},
{
"sku": "91115",
"product_name": "ברי צרפתי 130 גרם",
"quantity": 1,
"price": 10.98,
"sum": 10.98,
"package_items": 1,
"scale": "גרם"
}
]
}
]
}
API הזמנות שנקלטו
בעזרת ממשק זה ניתן לקרוא ממערכת רסטיגו מסמכי קליטות של הזמנות.
Method: GET
Url: https://api.restigo.co.il/api/thirdParty/newReceivedOrder
Headers: RESTIGO-API-KEY
Required params: start_date, end_date
Optional params: status
Date format:yyyy-mm-dd
המפתח שנשלח מקושר לסניף ספציפי וניתן פרטנית.
לשדות הכחולים מצורף הסבר לאחר הטבלה:
שם השדה בעברית | type | שם השדה |
מספר הזמנה | int | Id |
מספר מסמך | string | doc_number |
סוג מסמך | int | doc_type |
תאריך קליטה | string | doc_date |
תאריך יצירת מסמך | string | sent_at |
מספר ספק | int | supplier_id |
שם ספק | string | supplier_name |
מספר סניף | int | branch_id |
שם סניף | String | branch_name |
סטטוס (פתוח/נעול) | int | status |
הערות | string | notes |
סכום כולל מע״מ | double | total_with_vat |
סכום ללא מע״מ | double | total_without_vat |
קוד לקוח | string | customer_code |
מספר הקצאה | string | Assigned_number |
מק״ט מוצר | string | catalog_number |
שם מוצר | string | name |
כמות מארזים למוצר | double | package_items |
כמות יחידות למוצר | double | amount |
יחידות כפול מארזים למוצר | double | total_amount |
יחידת מידה למוצר | string | scale |
מחיר מוצר | double | price |
חייב במע״מ | boolean | has_vat |
חשבון חובה ברמת המוצר | string | debit_account |
האם נקלט לפי יחידות | boolean | Is_weighted |
הסבר שדה status:
הסטטוס אומר האם המסמך במצב נעול (2) או פתוח (1)
מסמך נחשב לנעול (2) אם הוא עונה על אחד מ3 הסעיפים הבאים:
- המסמך שולם במערכת
- המסמך יוצא להנהלת חשבונות
- המסמך ננעל ידנית ע״י המשתמש
כל מסמך שלא עונה על אחד מ3 הסעיפים הללו יחזור עם סטטוס פתוח (1).
הסבר שדה doc_type:
יש במערכת 9 סוגי מסמכים ולכל אחד מספר מזהה משלו.
- חשבונית מס (1)
- תעודת משלוח (2)
- חשבונית קופה קטנה מזומן (3)
- חשבונית קופה קטנה אשראי (6)
- חשבונית זיכוי (7)
- תעודת החזרה (8)
- חשבונית עסקה (9)
- הצעת מחיר (10)
- קבלה (11)
- מס / קבלה (12)
מידע נוסף על שדה customer_code :
קוד לקוח, במידה ואין קוד לקוח (כאשר מדובר בספק זמני במערכת רסטיגו) תחזור מחרוזת ריקה
[
{
“Id”: int, //db row
“doc_number”: string, // מס׳ מסמך
“doc_type”: int // סוג מסמך
“doc_date”: string // תאריך קליטה
“sent_at”: string, // תאריך יצירת מסמך
“supplier_id”: int, // מס׳ ספק
“supplier_name”: string, // שם ספק
“branch_id”: int, // מס׳ סניף
“branch_name”: string, // שם סניף
“status״: int, // פתוח או נעול
“notes”: string, // הערות
“total_with_vat”: double // סכום כולל מע״מ
“total_without_vat”: double // סכום ללא מע״מ
“customer_code”: string // קוד לקוח
“Assigned_number”: string, // מס הקצאה
“items”: [ // מוצרים
{
“catalog_number”: string // מק״ט
“name”: string, // שם
“package_items”: double, // כמות מארזים
“amount: double, // כמות יחידות
“total_amount”: double, // יחידות * מארזים
“scale”: string, // יחידת מידה
“price”: double, // מחיר
“has_vat”: boolean, // חייב במע״מ
“debit_account”: string, // חשבון חובה ברמת המוצר
“Is_weighted”: boolean // האם נקלט לפי יחידות
}
]
}
]