באמצעות ממשק זה ניתן לקבל נתונים מעלות המכר לפי תאריך התחלה וסיום.
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"
}
API מכירות קופה
ממשק זה משמש להעברת נתוני מכירות הפריטים במהלך יום העסקים
Method: POST
Url Production: https://api.restigo.co.il/api/pos/{provider}/receive/products
Url Test: https://dev.restigo.co.il/api/pos/{provider}/receive/products
Provider- שם הקופה ברסטיגו
Request Body
key | Required/Optional | type | שם השדה בעברית + הערות |
Branch_id | Required | Integer | מס' סניף ב RESTIGO. ישלח בעת בקשת חיבור סניף חדש |
Key | Required | Integer | מזהה חיבור לסניף ב RESTIGO. ישלח בעת בקשת חיבור סניף חדש |
start_date | Required | String yyyy-mm-dd | תאריך פתיחת יום העסקים (z) |
end_date | Required | String yyyy-mm-dd | תאריך סגירת יום העסקים (z) |
transaction_date | Required | String yyyy-mm-dd | תאריך אליו משויך יום העסקים (z) |
products | Required | פירוט עבור כל מוצר שנמכר בקופה | |
| Required | Integer | מזהה מוצר בקופה |
| Required | Integer | שם המוצר |
| Required | Number | מחיר קטלוג קבוע של המוצר |
| Required | Number | כלל הכמות שנמכרה בטווח התאריכים וללא זריקות |
| Required | Number | סכום המכירות |
| optional | Number | סכום הזריקות |
| optional | Number | כלל כמות הזריקות בטווח התאריכים |
| optional | מוצרים בתוך ארוחה / מוצרים בעץ מוצר וכו׳ | |
| Required | Integer | |
| Required | Integer | |
| Required | Number | |
| Required | Number | |
| optional | Number | |
| optional | Number | |
| optional | Boolean | לאפשר מחיר אפס |
{
"restigo": {
"branch_id": { },
"key": {" "},
"start_date": "yyyy-mm-dd”,
"end_date": "yyyy-mm-dd”,
"transactions_date": "yyyy-mm-dd”,
"products": [
{
“id”: 123,
“ name”: ארוחת אקספרס,
“catalog_price”: 55.0,
“sold”: 3.0,
“total”: 175,
"throw": 0.0,
"throw_amount": 0.0,
“items” : [
{
“id”: 444,
“name”: המבורגר אקספרס,
“catalog_price”: 30,
“sold”: 3,
“total”: 0,
"throw": 0.0,
"throw_amount": 0.0,
"allow_zero_price": true
},
{
“id”: 555,
“name”: בצל מטוגן,
“catalog_price”: 5,
“sold”: 2,
“total”: 10,
"throw": 0.0,
"throw_amount": 0.0,
"allow_zero_price": true
},
{
“id”: 666,
“name”: צ׳יפס,
“catalog_price”: 15,
“sold”: 2,
“total”: 0,
"throw": 0.0,
"throw_amount": 0.0,
"allow_zero_price": true
},
{
“id”: 777,
“name”: טבעות בצל,
“catalog_price”: 18,
“sold”: 1,
“total”: 0,
"throw": 0.0,
"throw_amount": 0.0,
"allow_zero_price": true
},
{
“id”: 888,
“name”: קולה,
“catalog_price”: 12,
“sold”: 3,
“total”: 0,
"throw": 0.0,
"throw_amount": 0.0,
"allow_zero_price": true
}
]
}
]
}
}