הקדמה:
מערכת Restigo מנהלת את נתוני ה office back של המסעדה. לצורך ניתוח
הנתונים והצגתם למנהלי המסעדה נדרש לעשות שימוש בנתוני הקופה.
מצ"ב מבנה ה API מול Restigo.
ליד כל שדה רשום את סוג הערך הצפוי בו
(optional) = שדה לא חובה.
ממשק זה מאפשר לקבל מידע מפורט על כל העובדים שעבדו ביום מסוים, כולל פרטי עובד, נתוני משמרת, פירוט שכר וחלוקת שעות (100%, 125%, 150% וכו').
פרטי ה-Endpoint
Method:
GETURL:
https://api.restigo.co.il/api/thirdParty/get_employees_hoursAuthorization: נדרש Header מסוג
RESTIGO-API-KEY
פרמטרים נדרשים (Query Params)
branch_id: מזהה הסניף (מספר).working_date: התאריך המבוקש בפורמטyyyy-mm-dd.
מבנה השדות בתשובה (Response Fields)
| שם השדה | סוג נתון | תיאור |
branch_id | Number | מזהה סניף
|
firstName | String | שם פרטי
|
lastName | String | שם משפחה
|
Identifier | String | תעודת זהות
|
mobile_number | String | מספר טלפון נייד
|
Start_date | String | תאריך ושעת התחלה
|
End_date | String | תאריך ושעת סיום
|
hours_total | Number | סך כל שעות העבודה
|
Break | Number | זמן הפסקה (במידה והוגדר)
|
daily_notes | String | הערות למשמרת
|
hours_100 | Number | כמות שעות 100%
|
hours_125 | Number | כמות שעות 125%
|
hours_150 | Number | כמות שעות 150%
|
hours_175 | Number | כמות שעות 175%
|
hours_200 | Number | כמות שעות 200%
|
hours_150_shabat | Number | שעות 150% ביום שבת
|
bank_name | String | שם הבנק
|
bank_branch_number | String | מספר סניף בנק
|
account_number | String | מספר חשבון בנק
|
דוגמת קריאה (Request Example)
Request:
JavaScript
https://api.restigo.co.il/api/thirdParty/get_employees_hours?branch_id=1
234&working_date=2024-12-08
fetch(url, {
method: 'GET',
headers: {
'RESTIGO-API-KEY': 'YOUR_API_KEY_HERE'
}
})
.then(response => response.json())
.then(data => console.log(data));
דוגמת תשובה (Response Example)
{
"data": [
{
"branch_id": 1,
"firstName": "גבי",
"lastName": "קניקובסקי",
"identifier": null,
"start_date": "2024-12-08 05:00:00",
"end_date": "2024-12-08 22:00:00",
"shift_title": "מלצר פתיחה",
"daily_notes": null,
"break": 0,
"hours_total": 17,
"hours_100": 8,
"hours_125": 2,
"hours_150": 7,
"hours_175": 0,
"hours_200": 0,
"hours_150_shabat": 0,
"mobile_number": "0524522890",}
"bank_name": "בנק לאומי לישראל בע\"מ",
"bank_branch_number": "998",
"account_number": "18761616"
}
]
Endpoint
Method: POST
Url for production: https://api.restigo.co.il/api/customer/branches/{branch_id}/users
Url for development: https://dev.restigo.co.il/api/customer/branches/{branch_id}/users
Request
Headers
key | value |
RESTIGO-API-KEY | Provided separately |
המפתח שנשלח מקושר לרשת ספציפית וניתן פרטנית.
Path Parameters
Parameter | Type | Required | Description | |
branch_id | integer | ✅ | The ID of the branch where the user will be created |
Body Parameters (JSON)
Parameter | Type | Required | Description | |
users | array | ✅ | A list of users to be created | |
first_name | string | ✅ | User's first name | שם פרטי |
last_name | string | ✅ | User's last name | שם משפחה |
email_address | string | ✅ | A valid email address for the user | דואר אלקטרוני |
mobile_phone | string | ❌ | User's mobile phone number (nullable) | טלפון סלולרי |
privileges_id | integer | ❌ | The user's privilege group (nullable) | הרשאות |
job_type | integer | ❌ | The ID representing the user's job type (nullable) | מחלקה |
salary | float | ❌ | User's salary (nullable) | שכר בסיס |
travel_cost | float | ❌ | User's travel cost reimbursement (nullable) | ערך נסיעות |
Example Request:
{
"users": [
{
"first_name": "john",
"last_name": "doe",
"email_address": "[email protected]",
"mobile_phone": null,
"privileges_id": null,
"job_type": null,
"salary": null,
"travel_cost": null
},
{
"first_name": "mike",
"last_name": "mike",
"email_address": "[email protected]",
"mobile_phone": null,
"privileges_id": null,
"job_type": null,
"salary": null,
"travel_cost": null
}
]
}
Response
Success Response
Status Code: 201 Created
Example Response
{
"message": "Users created successfully",
"user": [
{
"id": 255095,
"first_name": "john",
"last_name": "doe",
"email_address": "[email protected]"
},
{
"id": 255096,
"first_name": "mike",
"last_name": "mike",
"email_address": "[email protected]"
}
]
}
ביצירת עובד נשלח מייל לכתובת המייל שהוזנה לעובד עם סיסמא להתחברות לרסטיגו (שם המשתמש לכניסה למערכת הוא כתובת המייל).
Error Response
Validation Error
Status Code: 422 Unprocessable Entity
Example Response:
{
"errors": {
"users.0.email_address": [
"validation.required"
],
"users.1.email_address": [
"validation.unique"
]
}
}
במידה ומתקבלת השגיאה הבאה:
validation.unique
יש לנסות כתובת מייל שונה, או לפנות לרסטיגו בטלפון 074-7050790 על מנת שנבדוק את הכתובת הרלוונטית מאחר והיא כבר משוייכת למשתמש אחר ברסטיגו.
Unauthorized Request
Status Code: 401 Unauthorized
Example Response:
{
"message": "Unauthorized"
}
Branch Not Found
Status Code: 404 Not Found
Example Response:
{
"errors": "Invalid branch_id for the provided customer"
}
Endpoint
Method: PATCH
Url for production: https://api.restigo.co.il/api/customer/branches/{branch_id}/users/{user_id}/reset-password
Url for development: https://dev.restigo.co.il/api/customer/branches/{branch_id}/users/{user_id}/reset-password
Request
{
"method": "PATCH",
"url": "https://api.restigo.co.il/api/customer/branches/{branch_id}/users/{user_id}/reset-password",
"headers": {
"RESTIGO-API-KEY": "Provided separately"
},
"path_parameters": {
"branch_id": {
"type": "integer",
"required": true,
"description": "The ID of the branch"
},
"user_id": {
"type": "integer",
"required": true,
"description": "The ID of the user"
}
},
"body": {},
"notes": [
"המפתח שנשלח מקושר לרשת ספציפית וניתן פרטנית."
]
}
Response
Success Response
Status Code: 200 Ok
Example Response
{
"message": "Password reset successfully, please check your mobile number: 0540000000 for instructions."
}
{
"message": "Password reset successfully, please check your email [email protected] for instructions."
}
באיפוס סיסמה אם הוגדר למשתמש גם כתובת מייל וגם טלפון סלולרי- איפוס הסיסמא יישלח לטלפון. אם הוגדר רק מייל נשלח לכתובת מייל שהוגדר.
ממשק עובדים time Real :
https://app.restigo.co.il/api/pos/{provider}/receive/employees
יש להקים ממשק time Real אשר יישלח נתונים בכל 3 דקות ויכיל את הנתונים הבאים:
• מס' עובד
• שם העובד
• תאריך כניסה
• שעת כניסה
• תאריך יציאה
• שעת יציאה
ז.ת •
• כתובת מייל
{
"restigo": {
הממשק יכיל את שעות העובדים שנכנסו ו / או יצאו שעתיים אחורה
:
"branch_id": int, "key": string,
"employees": [
{
"number": int,
"start_date": string,// yyyy-mm-dd "end_date": string,// yyyy-mm-dd "start_time": string,// hh:ii "end_time": string,// hh:ii "identifier": string, (optional) "eMail": string (optional)
}
]
}
}
תמצית :ה 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
הערה להזמנה : זאת הזמנה לתת לאוריאל במפעל
באמצעות ממשק זה ניתן להוסיף או לעדכן מוצרים במחירון קיים, לפי קוד לקוח, מזהה מחירון ומערך של מוצרים הכולל מק״ט ומחיר לאחר הנחה.
Endpoint
Method: POST
Url for production: https://suppliers.restigo.co.il/api/departments/thirdParty/pricings/items
Url for development: https://suppliers-dev.restigo.co.il/api/departments/thirdParty/pricings/items
Request
key | value |
token (header) | Provided separately |
pricing_id (מזהה מחירון) | Required | integer |
customer_number (קוד לקוח) | Required | string |
items (מוצרים) | Required | array |
items.catalog_number (מק״ט מוצר) | Required | string |
items.price_after_discount (מחיר מוצר לאחר הנחה) | Required | number |
המפתח שנשלח מקושר לספק ספציפי וניתן פרטנית.
Request Example:
{
"pricing_id": 4515,
"customer_number": "556781",
"items": [
{
"catalog_number": "100106",
"price_after_discount": 32
},
{
"catalog_number": "0101",
"price_after_discount": 55
},
{
"catalog_number": "100105",
"price_after_discount": 21.6
}
]
}
Response
Success Response
Status Code: 201 Created
Example Response
{
"message": "success",
"items_added": [
"100106"
],
"items_updated": [
"0101",
"100105"
]
}
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "token not found"
}
הכנסות + פריטי מכירה : ממשק Get בו מערכת RESTIGO פונה לספק
לצורך קבלת הנתונים .2 ממשק RT – עבור שעות עובדים, יישלח בכל 3 דקות
// = הערות, בדרך כלל מתייחס לפורמט של התאריך.
ממשקים:
Web report income .1
https://app.restigo.co.il/api/pos/{provider}/receive/income
provider = שם הקופה
ממשק income משמש להעברת נתוני הכנסות (דו"ח )Z לפי 3 חתכים :
T.A משלוחים
א. פירוט לפי אמצעי תשלום ב. פירוט לפי משמרת
ב. פירוט לפי ערוץ מכירה : ישיבה במקום /
הממשק בנוי מ:
• Branch_id – מס' סניף ב RESTIGO , נשלח בעת בקשת חיבור סניף חדש
• Key – מזהה חיבור לסניף ב RESTIGO , נשלח בעת בקשת חיבור סניף חדש
• Startdate – תאריך פתיחת Z
• Enddate – תאריך סגירת Z
• Transactiondate – תאריך אליו משוייך ה Z
• המספר Znumber – Z
• customers Total -מס' סועדים , אם לא קיים ניתן להגדיר ערך קבוע "1"
• AvregeDeliverytime – ממוצע זמן משלוח ,אם לא קיים ניתן להגדיר ערך קבוע "1"
• “breakdownShifts”: – פירוט לפי משמרות :
o “shiftID-1 "shiftType”: – מזהה של המשמרת בקופה (נקבע ע״י הקופה בלבד.)
ShiftName – שם משמרת "בוקר" לדוגמא
Totalcharged – סה"כ הכנסות כולל מע"מ, סה"כ הכנסות מתייחס לכלל אמצעי התשלום
o Totalorders – מס' הזמנות למשמרת
TotalRedunds – סה"כ זיכויים / החזרות לסוג אמצעי תשלום
o sumRefunded – סכום עסקאות מסוג זיכוי
Totaldiscount – מספר עסקאות מסוג הנחה
Sumdiscount – סכום עסקאות מסוג הנחה
BreakdownPayments – פירוט אמצעי תשלום למשמרת
paymentType -סוג אמצעי התשלום
paymentname – שם אמצעי התשלום
Totalcharged – סה"כ הכנסות כולל מע"מ, סה"כ הכנסות מתייחס לכלל אמצעי
התשלום הרלוונטיים למשמרת
Totalcustomers – מס' לקוחות לאמצעי תשלום
Z ב מחושב האם – calcInTotalZ”: true“
1, “orderType”: – פירוט לפי ערוץ מכירה
המכירה ערוץ שם – ”orderName”: “TAKEAWAY“
Totalcharged – סה"כ הכנסות כולל מע"מ, סה"כ הכנסות מתייחס לכלל אמצעי התשלום
הרלוונטיים למשמרת TotalRefunds – סה"כ זיכויים / החזרות במשמרת
Totalorders – מס' הזמנות למשמרת
יתר השדות זהים לממשק BreakdownPayments
כתובת ה API – תועבר לפני התחלת בדיקות
:BranchID יועבר לאחר תחילת בדיקות
מפתח: יועבר לאחר תחילת בדיקות
מבנה ה Json :
{
“restigo”: {
“branch_id”: xxxx,
“key”:
“xxxxxxxxxxxxx",
“income”: {
“startDate”: “2022-07-02”,
“endDate”: “2022-07-02”,
“transactionsDate”: “2022-07-02”,
“zNumber”: “466”,
“totalCustomers”: 182,
“averageDeliveryTime”: 32,
“breakdownShifts”: [
{
“shiftType”: “shiftID-1",
“shiftName”: “בוקר“,
“totalCharged”: 16078.1525,
“totalRefunded”: 7,
“sumRefunded”:2,
“Totaldiscount”:10,
“Sumdiscount”:45,
“breakdownOrders”: [
{
“orderType”: 2,
“orderName”: “מסעדה“,
“totalCharged”: 2084.95,
“totalRefunded”: 0,
“totalOrders”: 5,
“breakdownPayments”: [
{
“paymentType”: “credit”,
“paymentName”: “אשראי“,
“totalCharged”: 1160.2,
“totalRefunded”: 0,
“totalCustomers”: 21,
“calcInTotalZ”: true
},
{
“paymentType”: “cash”,
“paymentName”: “מזומן“,
“totalCharged”: 739.2,
“totalRefunded”: 0,
“totalCustomers”: 12,
“calcInTotalZ”: true
},
{
“paymentType”: 7777,
“paymentName”: “מ“\בע ביס תן”,
“totalCharged”: 185.55,
“totalRefunded”: 0,
“totalCustomers
“calcInTotalZ”: true
}
]
},
{
“orderType”: 1,
“orderName”: “TAKEAWAY”,
“totalCharged”: 4431.75,
“totalRefunded”: 0,
“totalOrders”: 5,
“breakdownPayments”: [
{
“paymentType”: “credit”,
“paymentName”: “אשראי“,
“totalCharged”: 3560.45,
“totalRefunded”: 0,
“totalCustomers”: 40,
“calcInTotalZ”: true
},
{
“paymentType”: “cash”,
“paymentName”: “מזומן“,
“totalCharged”: 561.1,
“totalRefunded”: 0,
“totalCustomers”: 6,
“calcInTotalZ”: true
},
{
“paymentType”: 8888,
“paymentName”: “סיבוס SODEXO”,
“totalCharged”: 96.2,
“totalRefunded”: 0,
“totalCustomers”: 1,
“calcInTotalZ”: true
},
{
“paymentType”: 9999,
“paymentName”: “BUY ME”,
“totalCharged”: 214,
“totalRefunded”: 0,
“totalCustomers”: 2,
“calcInTotalZ”: true
}
]
},
{
“orderType”: 3,
“orderName”: “משלוחים“,
“totalCharged”: 9561.4525,
“totalRefunded”: 0,
“totalOrders”: 5,
“breakdownPayments”: [
{
“paymentType”: “credit”,
“paymentName”: “אשראי“,
“totalCharged”: 5284.65,
“totalRefunded”: 0,
“totalCustomers”: 39,
“calcInTotalZ”: true
},
{
“paymentType”: “cash”,
“totalRefunded”: 0,
“totalCustomers”: 20,
“calcInTotalZ”: true
},
{
“paymentType”: 5555,
“paymentName”: “משלוחה“,
“totalCharged”: 991.6,
“totalRefunded”: 0,
“totalCustomers”: 8,
“calcInTotalZ”: true
},
{
“paymentType”: 7777,
“paymentName”: “מ“\בע ביס תן”,
“totalCharged”: 1338.4525,
“totalRefunded”: 0,
“totalCustomers”: 10,
“calcInTotalZ”: true
}
]
}
]
}
]
}
}
}
ממשק הכנסות נוספות
באמצעות ממשק זה ניתן ליצור הכנסות נוספות לסניף מסוים.
Endpoint
Method: POST
Url for production: https://api.restigo.co.il/api/thirdParty/income/extra
Url for development: https://dev.restigo.co.il/api/thirdParty/income/extra
Request
key | value |
RESTIGO-API-KEY (header) | Provided separately |
date (תאריך) | Required | date |
client_name (שם לקוח) | Required | string |
total_with_vat (סכום כולל מע״מ) | Required | numeric |
type (סוג הכנסה) | Required | string |
diners (מספר סועדים) | Required | integer |
maturity_date (תאריך פירעון) | Required | date |
document_number (מספר קבלה) | Required | string |
המפתח שנשלח מקושר לסניף ספציפי וניתן פרטנית.
Request Example:
{
"date": "2025-04-08", // YYYY-MM-DD
"client_name": "name",
"total_with_vat": 443,
"type": "אירוח",
"diners": 2,
"maturity_date": "2025-04-18", // YYYY-MM-DD
"document_number": "65653871"
}
Response
Success Response
Status Code: 201 CREATED
Example Response
{
"branch_id": 1,
"date": "2025-04-08",
"client_name": "name",
"total_with_vat": 443,
"diners": 2,
"total_without_vat": 375.42,
"notes": "מספר קבלה: 65653871, תאריך פירעון: 2025-04-18",
"branch_name": "נתניה",
"type_name": "אירוח"
}
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "Unauthorized"
}
ממשק הוספת לקוח חדש
בעזרת ממשק זה ניתן ליצור לקוח חדש (עסק).
Method: POST
Url for production: https://api.restigo.co.il/api/customer/branches
Url for development: https://dev.restigo.co.il/api/customer/branches
Headers: RESTIGO-API-KEY
Required params: name, address, city, phone
המפתח שנשלח מקושר לרשת ספציפית וניתן פרטנית.
שם השדה בעברית | type | שם השדה |
שם העסק | string | name |
כתובת העסק רחוב ומספר | string | address |
עיר העסק | string | city |
מספר טלפון של העסק | string | phone |
Response:
{
"id": 9612,
"name": "coffee drink",
"city": "פתח לקווה",
"address": "הרצל 55"
}
באמצעות ממשק זה ניתן להסיר לקוח ממחירון באמצעות מזהה מחירון וקוד לקוח.
Endpoint
Method: DELETE
Url for production: https://suppliers.restigo.co.il/api/departments/thirdParty/pricings/removeClient
Url for development: https://suppliers-dev.restigo.co.il/api/departments/thirdParty/pricings/removeClient
Request
Headers
key | value |
token | Provided separately |
pricing_id (מזהה מחירון) | Required | integer |
customer_number (קוד לקוח) | Required | string |
המפתח שנשלח מקושר לספק ספציפי וניתן פרטנית.
Response
Success Response
Status Code: 200 Ok
Example Response
{
"message": "Client has been successfully removed from the pricing"
}
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "token not found"
}
באמצעות ממשק זה ניתן להסיר מוצרים ממחירון קיים, לפי קוד לקוח, מזהה מחירון ומערך של מק״טים של מוצרים.
Endpoint
Method: DELETE
Url for production: https://suppliers.restigo.co.il/api/departments/thirdParty/pricings/items
Url for development: https://suppliers-dev.restigo.co.il/api/departments/thirdParty/pricings/items
Request
key | value |
token (header) | Provided separately |
pricing_id (מזהה מחירון) | Required | integer |
customer_number (קוד לקוח) | Required | string |
items (מק״טים של מוצרים) | Required | array |
המפתח שנשלח מקושר לספק ספציפי וניתן פרטנית.
Request Example:
{
"pricing_id": 5544,
"customer_number": "123",
"items": ["0101", "100105", "100106"]
}
Response
Success Response
Status Code: 200 OK
Example Response
{
"message": "success",
"items_deleted": [
"0101",
"100105",
"100106"
]
}
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "token not found"
}
באמצעות ממשק זה ניתן ליצור מחירון לספק בהינתן שם.
Endpoint
Method: POST
Url for production: https://suppliers.restigo.co.il/api/departments/thirdParty/pricings
Url for development: https://suppliers-dev.restigo.co.il/api/departments/thirdParty/pricings
Request
Headers
key | value |
token | Provided separately |
name (שם מחירון) | Required | string |
המפתח שנשלח מקושר לספק ספציפי וניתן פרטנית.
Response
Success Response
Status Code: 201 Created
Example Response
{
"pricing_id": 123,
"pricing_name": "testname"
}
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "token not found"
}
בעזרת ממשק זה ניתן לקרוא ממערכת רסטיגו הזמנות שלא נקלטו.
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 :
קוד לקוח, במידה ואין קוד לקוח (כאשר מדובר בספק זמני במערכת רסטיגו) תחזור מחרוזת ריקה
באמצעות ממשק זה ניתן לקבל נתונים מעלות המכר לפי תאריך התחלה וסיום.
Endpoint
Method: GET
Url for production: https://api.restigo.co.il/api/thirdParty/salesCost
Url for development: https://dev.restigo.co.il/api/thirdParty/salesCost
Request
key | value |
RESTIGO-API-KEY (header) | Provided separately |
start_date (תאריך התחלה) | Required | date |
end_date (תאריך סיום) | Required | date |
המפתח שנשלח מקושר לסניף ספציפי וניתן פרטנית.
ניתן למשוך בכל בקשה עד 3 ימים.
Request Example:
{
"start_date": "2025-03-01", // YYYY-MM-DD
"end_date": "2025-03-04" // YYYY-MM-DD
}
Response
Success Response
Status Code: 200 OK
Example Response
[
{
"date": "2025-03-01", // תאריך מכירה
"branch_id": 7445, // מזהה סניף
"product_code": "101", // מזהה מנה בקופה
"product_name": "שם מנה",
"restigo_id": 17967, // מזהה מנה/מוצר ברסטיגו
"restigo_name": "שם מנה ברסטיגו",
"type": "product", // סוג מוצר/מנה (product/item)
"amount": 22, // כמות שנמכרה
"total": 404, // מכירות כולל מע״מ
"worth": 91.43 // עלות רכיבים
},
{
"date": "2025-03-01",
"branch_id": 7445,
"product_code": "105",
"product_name": "שם מוצר",
"restigo_id": 18040,
"restigo_name": "שם מוצר ברסטיגו",
"type": "item",
"amount": 10,
"total": 234,
"worth": 58.22
},
]
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "Unauthorized"
}
באמצעות ממשק זה ניתן לשלוף מידע על לקוח קיים, כולל שם ומזהה סניף, מחירונים המשויכים אליו וכן משתמשים המקושרים אליו – כל זאת על בסיס קוד הלקוח.
Endpoint
Method: GET
Url for production: https://suppliers.restigo.co.il/api/departments/thirdParty/clients
Url for development: https://suppliers-dev.restigo.co.il/api/departments/thirdParty/clients
Request
Headers
key | value |
token | Provided separately |
customer_number (קוד לקוח) | Required | string |
המפתח שנשלח מקושר לספק ספציפי וניתן פרטנית.
בעזרת ממשק זה ניתן לקבל רשימת מוצרים פעילים של הספק.
Endpoint
Method: GET
Url for production: https://suppliers.restigo.co.il/api/departments/thirdParty/items
Url for development: https://suppliers-dev.restigo.co.il/api/departments/thirdParty/items
Request
Headers
key | value |
token | Provided separately |
item_name | Nullable | string |
המפתח שנשלח מקושר לספק ספציפי וניתן פרטנית.
Response
Success Response
Status Code: 200 Ok
Example Response
[
{
"item_id": 1,
"item_name": "מוצר 1"
},
{
"item_id": 2,
"item_name": "מוצר 2"
},
{
"item_id": 3,
"item_name": "מוצר 3"
},
{
"item_id": 4,
"item_name": "מוצר 4"
},
]
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "token not found"
}
בעזרת ממשק זה ניתן לקבל את רשימת המחירונים של הספק, כולל הלקוחות והמוצרים המשויכים לכל מחירון.
Endpoint
Method: GET
Url for production: https://suppliers.restigo.co.il/api/departments/thirdParty/pricings
Url for development: https://suppliers-dev.restigo.co.il/api/departments/thirdParty/pricings
Request
Headers
key | value |
token | Provided separately |
pricing_name | Nullable | string |
המפתח שנשלח מקושר לספק ספציפי וניתן פרטנית.
Response
Success Response
Status Code: 200 Ok
Example Response
[
{
"pricing_id": 123,
"pricing_name": "שם מחירון",
"clients": [
{
"client_id": 1,
"client_name": "שם לקוח 1"
},
{
"client_id": 2,
"client_name": "שם לקוח 2"
}
],
"catalog_items": [
{
"item_name": "שם מוצר 1",
"item_id": 435,
"price_after_discount": 112
},
{
"item_name": "שם מוצר 2",
"item_id": 436,
"price_after_discount": 159
},
]
}
]
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "token not found"
}
בעזרת ממשק זה ניתן לקבל רשימת סניפים ברשת.
Endpoint
Method: GET
Url for production: https://api.restigo.co.il/api/customer/branches
Url for development: https://dev.restigo.co.il/api/customer/branches
Request
Headers
key | value |
RESTIGO-API-KEY | Provided separately |
המפתח שנשלח מקושר לרשת ספציפית וניתן פרטנית.
Response
Success Response
Status Code: 200 Ok
Example Response
[
{
"id": 6242,
"name": "מטה",
"city": "קדימה",
"address": "קדימה"
},
{
"id": 6374,
"name": "אפרת ארליך",
"city": "כללי",
"address": "כללי"
},
{
"id": 6424,
"name": "א.נ.ר.י מעדנינה בעמ",
"city": "פתח תקווה",
"address": "העצמאות 65"
},
{
"id": 6425,
"name": "קאלו מרקט",
"city": "פרדס חנה כרכור",
"address": "דרך בית לחם 31"
},
]
Error Response
Unauthorized Request
Status Code: 401 Unauthorized
Example Response:
{
"message": "Unauthorized"
}
בעזרת ממשק זה ניתן לקבל רשימת עובדים בסניף.
Endpoint
Method: GET
Url for production: https://api.restigo.co.il/api/customer/branches/{branch_id}/users
Url for development: https://dev.restigo.co.il/api/customer/branches/{branch_id}/users
Request
Headers
key | value |
RESTIGO-API-KEY | Provided separately |
המפתח שנשלח מקושר לרשת ספציפית וניתן פרטנית.
Response
Success Response
Status Code: 200 Ok
Example Response
[
{
"id": 101701,
"first_name": "משה",
"last_name": "בייקרי אנד מור",
"email_address": "[email protected]",
"mobile_number": "054-2232701"
},
{
"id": 101702,
"first_name": "משה",
"last_name": "בייקרי אנד מור",
"email_address": "[email protected]",
"mobile_number": "054-2232701"
},
{
"id": 255099,
"first_name": "john",
"last_name": "doe",
"email_address": "[email protected]",
"mobile_number": "0540000000"
},
{
"id": 255100,
"first_name": "mike",
"last_name": "mike",
"email_address": "[email protected]",
"mobile_number": null
}
]
Error Response
Unauthorized Request
Status Code: 401 Unauthorized
Example Response:
{
"message": "Unauthorized"
}
Branch not found
Status Code: 404 Not Found
Example Response:
{
"errors": "Invalid branch_id for the provided customer"
}
API תנועות מלאי
באמצעות ממשק זה ניתן לקבל את תנועות המלאי של המוצרים המקושרים למנה המבוקשת.
Method: GET
Url for production: https://api.restigo.co.il/api/thirdParty/productItemInventories
Url for development: https://dev.restigo.co.il/api/thirdParty/productItemInventories
Request
חובה לפנות עם אחד מהפרמטרים product_id ,או product_code
key | Location | type | שם השדה בעברית |
RESTIGO-API-KEY | Headers | Required | המפתח מקושר לסניף ספציפי וניתן פרטנית |
date (תאריך) | Params | Required | date | תאריך מבוקש |
product_id | Params | Optional | integer | מזהה מנה ברסטיגו |
count_type | Params | Required | 'package' | 'unit' | 'weight' | צורת ספירת מלאי מבוקשת |
product_code | Params | Optional | integer | מזהה מנה מהקופה |
Request example
https://api.restigo.co.il/api/thirdParty/productItemInventories?date=2026-02-01&product_id=17951&count_type=package
Response
key | type | שם השדה בעברית |
date | string | תאריך מבוקש |
branch_id | number | מזהה סניף |
worth_without_VAT | number | עלות מנה ללא מע״מ |
worth_with_VAT | number | עלות מנה כולל מע״מ |
count_type | 'package' | 'unit' | 'weight' | צורת ספירת מלאי מבוקשת |
base_items | array | מערך מוצרים מקושרים למנה |
name | string | שם מוצר מקושר למנה |
part_number | string | מק״ט מוצר מקושר |
supplier_name | string | ספק מוצר מקושר |
price | number | מחיר מוצר מקושר |
inventories | array | מערך תנועות מלאי של המוצר |
new_inventory_id | number | מזהה תנועת מלאי |
inventory_type | number | סוג תנועת מלאי |
date | string | תאריך תנועת מלאי |
amount | number | כמות תנועת מלאי |
worth | number | שווי תנועת מלאי |
creator | string | מבצע תנועת מלאי |
product_code | string | מזהה מנה מהקופה |
product_id | number | מזהה מנה ברסטיגו |
Success Response
Status Code: 200 OK
{
"date": "2026-02-01",
"branch_id": 1234,
"worth_without_VAT": 7.6,
"worth_with_VAT": 8.97,
"count_type": "package",
"base_items": [
{
"name": "צ'יפס",
"part_number": "1234",
"supplier_name": "תפוחי אדמה לוהטים",
"price": 173.81,
"inventories": [
{
"new_inventory_id": 979899,
"inventory_type": "מכירות",
"date": "2026-02-01",
"amount": 0.1,
"worth": 13.381,
"creator": "מנהל מערכת"
}
]
}
],
"product_id": "37364"
Error Response
Status Code: 401
{
"message": "Unauthorized"
}
Web report products
https://app.restigo.co.il/api/pos/{provider}/receive/products
ממשק products משמש להעברת נתוני מכירות הפריטים במהלך היום. הממשק
בנוי מ:
• Branch_id – מספר סניף ב RESTIGO , יונפק ע"י RESTIGO בעת שליחת בקשת חיבור
• Key – מזהה סניף, יונפק ע"י RESTIGO בעת שליחת בקשת חיבור
• Start_date : תאריך פתיחת ה Z
• End_date : תאריך סגירת ה Z
• date Transaction : תאריך ערך אליו משוייך ה Z /תאריך פתיחת הZ.
• Products : פירוט עבור כל מוצר שנמכר בקופה
• ID – מזהה מוצר בקופה
• Name – שם המוצר
• Type – יכיל 2 ערכים :
– " 0 " = Sold Dish (מנה / ארוחה שנמכרה בקופה)
– "1" = Waste (זריקה)
– שדה Waste : אם בשדה Type יופיע ערך "1" , בשדה Waste תופיע הכמות שנזרקה, אחר יופיע על " Null"
– שדה sold : אם בשדה Type יופיע ערך "0 ":
1. Catalog_price = מחיר קטלוגי קבוע של המוצר
2. בשדה Sold תופיע כלל הכמות שנמכרה בטווח תאריכים (כולל מכירות בסכום (0 וללא זריקות
3. Total = סכום המכירות
מבנה הממשק :
{
"restigo": { "branch_id": int "key": int,
"start date": string,// yyyy-mm-dd "end date": string,// yyyy-mm-dd
"transactions date": string,// yyyy-mm-dd "products": [
{
"id": int, "name": string,
"Type": float,
"Waste" : float
"catalog_price": float, "sold": float, "total": float, "items":[{
"id": int "name": int
"Type":float
"Waste" : float
"catalog_price": float, "sold": float,
}
]
}
לדוגמא :
מנה שנמכרה :
3 ארוחות "אקספרס 1 " נמכרו בסניף במהלך היום המכילות : 3 המבורגרים , שניים מתוכן עם תוספת בצל מטוגן
3 שתייה קלה
2 צ'יפס
1 טבעות בצל
{
"restigo": { "branch_id": {},
"key": {" "},
"start_date": "YYYY-MM-DD, "end_date": "YYY-MM-DD", "transactions_date": "YYYY-MM-DD", "products": [
{
id: 123
ארוחת אקספרס 1 name:
Type : 0
Waste :
catalog_price: 55
sold 3
total : 175 items : [
{
id: 444,
המבורגר אקספרס 1 name:
Type : 0
Waste :
catalog_price: 30
sold: 3
total: 0
},
{
id: 555,
בצל מטוגן name:
Type : 0
Waste:
catalog_price: 5
sold: 2
total: 10
},
{
id: 666,
name: יפס'צ
Type : 0
Waste:
catalog_price: 15
sold: 2
total: 0
},
{
id: 777,
טבעות בצל name:
Type : 0
Waste:
catalog_price: 18
sold: 1
total: 0
},
{
id: 888,
שתיה קלה name:
Type : 0
Waste:
catalog_price: 12sold: 3
total: 0
}
]
}
]
}
}
לדוגמא :
מנה שנזרקה :
2 קפה ומאפה נזרקו בסניף במהלך היום
{
"restigo": { "branch_id": {},
"key": {" "},
"start_date": "YYYY-MM-DD, "end_date": "YYY-MM-DD", "transactions_date": "YYYY-MM-DD", "products": [
{
id: 123
קפה ומאפה name:
Type : 1
Waste : 2
catalog_price:
sold
total : items : [
{
id: 444,
קפה הפוך name:
Type : 2
Waste : 2
catalog_price:
sold:
total:
},
{
id: 555,
קוראסון name:
Type : 1
Waste: 2
catalog_price:
sold:
total:
},
{
}
]
}
}
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 // האם נקלט לפי יחידות
}
]
}
]