Introduction:
Restigo manages your restaurant’s back-office data.
To analyze and present this information to restaurant managers, it’s necessary to use the available data fields.
Restigo provides access via API.
Each field includes its expected data type.
Fields marked as optional are not required.
Employee Hours – API Overview
This API endpoint allows branches to send a request with a branch ID and date to retrieve detailed information on all employees who worked that day.
The response includes employee details, shift data, and payroll broken down by hour rates (100%, 125%, 150%, etc.).
Usage
Request type:
GETEndpoint:
https://api.restigo.co.il/api/thirdParty/get_employees_hoursHeaders:
Use
authorizationheaderKey:
RESTIGO-API-KEYValue: your private API key
Required Parameters:
branch_id– Branch number (as defined in Restigo)working_date– Requested date inYYYY-MM-DDformat
Example URL:
https://api.restigo.co.il/api/thirdParty/get_employees_hours?branch_id=1&working_date=2024-12-19
Response Format
branch_id– Branch IDfirstName– First namelastName– Last nameIdentifier– ID (e.g. national ID)Start_date– Shift start timeEnd_date– Shift end timeshift_title– Position/title during that shiftdaily_notes– Notes from the shiftBreak– Break duration (if recorded in the system)
hours_total– Total hours workedhours_100– Hours at 100% ratehours_125– Hours at 125% ratehours_150– Hours at 150% ratehours_175– Hours at 175% ratehours_200– Hours at 200% ratehours_150_shabat– Hours at 150% rate on Shabbatmobile_number– Mobile phone numberbank_name– Bank namebank_branch_number– Bank branch numberaccount_number– Bank account number
{
"branch_id": "1",
"firstName": "xxx",
"lastName": "xxxxxxx",
"identifier": null,
"start_date": "2024-12-08 05:00:00",
"end_date": "2024-12-08 22:00:00",
"shift_title": "Opening Shift",
"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": "xxx-xxxxxx",
"bank_name": "Bank Leumi Le-Israel B.M.",
"bank_branch_number": "xxx",
"account_number": "xxxx"
}
Note:
The XML file should include only the products listed in the order. Each product must appear on a separate line.
The interface requires sending the order data structured as shown below, and should be submitted on the same day as the delivery to the supplier.
XML Structure:
Package = Number of packages
Quantity = Quantity per package × number of packages
item_Sku = Item code
Value date = Invoice date
reference_date = Document date
supply_time = Delivery time (optional). If omitted, default is 00:00
account_code = Supplier number in the system
doc_type = Document type (e.g. invoice/delivery note)
doc_num = Document number
Price = Item price
Remarks = Notes
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:
Note:
If the user exists with both an email and a mobile phone number, the reset link will be sent to the phone.
If the user has only an email, the reset link will be sent to the specified email address.
Let me know if you want it formatted as an API doc snippet or included in a full endpoint definition.
With this interface, you can add or update products in an existing price list, by customer code. The interface includes a list of catalog items and their discounted price.
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 Format
| Key | Value |
|---|---|
| token (header) | Provided separately |
| pricing_id (Price List ID) | Required | integer |
| customer_number (Client Code) | Required | string |
| items (Products) | Required | array |
| items.catalog_number (Catalog Number) | Required | string |
| items.price_after_discount (Discounted Price) | Required | number |
The key is sent in the header and is linked to a specific supplier. It can be provided separately.
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"
}
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 | ✅ Yes | A list of users to be created |
first_name | string | ✅ Yes | User's first name |
last_name | string | ✅ Yes | User's last name |
email_address | string | ✅ Yes | A valid email address for the user |
mobile_phone | string | ❌ No | User's mobile phone number (nullable) |
privileges_id | integer | ❌ No | The user's privilege group (nullable) |
job_type | integer | ❌ No | The ID representing the user's job (nullable) |
salary | float | ❌ No | User's salary (nullable) |
travel_cost | float | ❌ No | User's travel cost reimbursement (nullable) |
Example Request:
{
"users": [
{
"first_name": "john",
"last_name": "doe",
"email_address": "johndoe@restigo.biz",
"mobile_phone": null,
"privileges_id": null,
"job_type": null,
"salary": null,
"travel_cost": null
},
{
"first_name": "mike",
"last_name": "mike",
"email_address": "mikemike@restigo.biz",
"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": "johndoe@restigo.biz"
},
{
"id": 255096,
"first_name": "mike",
"last_name": "mike",
"email_address": "mikemike@restigo.biz"
}
]
}
When creating a user:
If the email address provided already exists in the system (even if it belongs to a different user who is already registered to Restigo), the system will reject the request because the email must be unique.
Error Response
Validation Error
Status Code: 422 Unprocessable Entity
Example Response:
{
"errors": {
"users.0.email_address": [
"validation.required"
],
"users.1.email_address": [
"validation.unique"
]
}
}
Explanation for the error received:
validation.unique
Please try a different email address, or contact Restigo support at 074-7050790 to verify if the email address is already associated with another user in Restigo's database.
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"
}
Income + Sales Details API
A GET request where the RESTIGO system sends data to the supplier:
For income reports
For RT reports – related to employee working hours
Sent every 3 minutes.
Note: All data refers to the date format of the report.
Endpoints:
Web report incomehttps://app.restigo.co.il/api/pos/{provider}/receive/income
provider = client name / branch name
income = name of the function used to transfer the income data
(according to Z reports – 3 parameters expected):
A. Payment Details
A.1 Based on payment methods
A.2 Based on invoice types / seating location
Sent parameters:
Branch_id – RESTIGO branch number, sent when requesting a new branch integration
Key – RESTIGO integration key, sent when requesting new integration
Startdate – opening date of the Z report
Enddate – closing date of the Z report
Transactiondate – date of the relevant Z report
Znumber – Z report number
Totalcustomers – total number of customers (if not available, use value “1”)
AvergeDeliverytime – average delivery time (if not available, use value “1”)
BreakdownShifts – list of shifts (structured as “shiftID1”, “shiftID2”)
ShiftName – employee's shift name (example: “Evening”)
Totalcharged – total income in NIS, excluding tax, per payment method
Totalorders – total number of invoices
TotalRefunds – total refunds / invoice returns per payment method
SumRefunded – total refund amount
Totaldiscount – total discounts amount
Sumdiscount – total discount per type
BreakdownPayments – payment breakdown by payment method
PaymentType – payment method name
Totalcharged – total income in NIS, excluding tax, per payment method
Totalcustomers – total number of customers per payment method
Z ב מחושב האם – calcInTotalZ”: true“
1. orderType – Sale channel description
2. orderName: "TAKEAWAY" – Name of the sale channel
Totalcharged – Total income including VAT. This value refers to all payment methods.
TotalRefunds – Total refunds to customers
Totalorders – Number of payment invoices
BreakdownPayments – Breakdown of payment methods
API Notes:
Passed before the minute interval starts
BranchID: Passed before the minute interval starts
Key: Passed before the minute interval starts
JSON Example:
startDate: 2022-07-02
endDate: 2022-07-02
transactionsDate: 2022-07-02
ZNumber: 466
totalCustomers: 182
averageDeliveryTime: 32
breakdownShifts:
shiftType: shiftID-1
shiftName: Morning
totalCharged: 16078.1525
totalRefunded: 7
sumRefunded: 2
totalDiscount: 10
sumDiscount: 45
breakdownOrders:
orderType: 2
orderName: Restaurant
totalCharged: 2084.95
totalRefunded: 0
“totalOrders”: 5,
“breakdownPayments”: [
{
“paymentType”: “credit”,
“paymentName”: “אשראי“,
“totalCharged”: 1160.2,
“totalRefunded”: 0,
“totalCustomers”: 21,
“calcInTotalZ”: true
},
{{
"paymentType": "cash",
"paymentName": "Cash",
"totalCharged": 739.2,
"totalRefunded": 0,
"totalCustomers": 12,
"calcInTotalZ": true
},
{
"paymentType": "7777",
"paymentName": "Voucher with VAT",
"totalCharged": 185.55,
"totalRefunded": 0,
"totalCustomers": null,
"calcInTotalZ": true
},
{
"orderType": 1,
"orderName": "TAKEAWAY",
"totalCharged": 4431.75,
"totalRefunded": 0,
"totalOrders": 5,
"breakdownPayments": [
{
"paymentType": "credit",
"paymentName": "Credit",
"totalCharged": 3560.45,
"totalRefunded": 0,
"totalCustomers": 40,
"calcInTotalZ": true
},
{
"paymentType": "cash",
"paymentName": "Cash",
"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": "Deliveries",
"totalCharged": 9561.4525,
"totalRefunded": 0,
"totalOrders": 5,
"breakdownPayments": [
{
"paymentType": "credit",
"paymentName": "Credit",
"totalCharged": 5284.65,
"totalRefunded": 0,
"totalCustomers": 39,
"calcInTotalZ": true
},
{
"paymentType": "cash",
"totalRefunded": 0,
"totalCustomers": 20,
"calcInTotalZ": true
}
]
}
{
"paymentType": "5555",
"paymentName": "Mishloha",
"totalCharged": 991.6,
"totalRefunded": 0,
"totalCustomers": 8,
"calcInTotalZ": true
},
{
"paymentType": "7777",
"paymentName": "Credit card via terminal",
"totalCharged": 1338.4525,
"totalRefunded": 0,
"totalCustomers": 10,
"calcInTotalZ": true
}
Additional Income Interface
Using this interface, it is possible to generate additional income records for a specific branch.
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 |
Additional Income Endpoint – Request Example
The key provided is linked to the specific supplier and is provided privately.
This endpoint allows you to create additional income records associated with a supplier.
Request Example:
Response Example
Success Response
Status Code: 201 CREATED
}
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "Unauthorized"
}
New Customer Creation Module
Using this module, you can create a new customer (business).
Method: POST
URL for production:
https://api.restigo.co.il/api/customer/branchesURL for development:
https://dev.restigo.co.il/api/customer/branches
Headers:RESTIGO-API-KEY
Required parameters:name, address, city, phone
(The API key is associated with a specific supplier and is private.)
Field Definitions:
| Field Name (English) | Type | Description |
|---|---|---|
name | string | Business name |
address | string | Business address (street + number) |
city | string | Business city |
phone | string | Business phone number |
Example Response:
Using this process, you can remove a client from a pricing list by providing a pricing ID and customer code.
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 (Pricing ID) |
customer_number | Required | string (Customer Code) |
The token provided is linked to a specific supplier and is private.
Response
Success Response
Status Code: 200 OK
Example Response:
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "token not found"
}
Using this process, you can remove products from an existing pricing list based on customer code, pricing ID, and an array of product catalog numbers.
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 (Pricing ID) |
customer_number | Required | string (Customer Code) |
items | Required | array (Catalog numbers of products) |
The token provided is linked to a specific supplier and is private.
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"
}
Using this process, you can create a new pricing list for a supplier by specifying a name.
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 |
Request Body
| key | value |
|---|---|
name | Required | string (pricing name) |
The token sent is linked to a specific supplier and is private.
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"
}
Using this process, you can retrieve uncompleted orders from the Restigo system.
Method: GET
URL: https://api.restigo.co.il/api/thirdParty/newOrder
Headers: RESTIGO-API-KEY
Required parameters: start_date, end_date
The token sent is linked to a specific supplier and is private.
All dates must be in the format: string: yyyy-mm-dd
| English Field Name | Type | Description |
|---|---|---|
id | int | Order ID |
branch_id | int | Branch ID |
branch_name | string | Branch Name |
supplier_id | int | Supplier ID |
supplier_name | string | Supplier Name |
order_date | string (YYYY-MM-DD HH:MM:SS) | Order Date |
supply_date | string (yyyy-mm-dd) | Supply Date |
order_status | string | Order Status |
notes | string, nullable | Notes |
create_by | string | Created By |
created_at | string (YYYY-MM-DD HH:MM:SS) | Creation Date |
items | array | Items |
items.sku | string | SKU |
items.product_name | string | Product Name |
items.quantity | int | Quantity |
items.price | double | Unit Price (excl. VAT, incl. discounts/taxes) |
items.sum | double | Total Price (price × quantity) |
items.package_items | int | Units Per Package |
items.scale | string | Unit of Measurement |
Response:
{
"data": [
{
{
"id": 1650114,
"branch_id": 1193,
"branch_name": "Ein Kerem",
"supplier_id": 8978,
"supplier_name": "Gad – Shimi Dery",
"order_date": "2025-01-03 15:36:48",
"supply_date": "2025-01-05",
"order_status": "Pending Approval",
"notes": null,
"create_by": "Tamir Hiltoa",
"created_at": "2025-01-03T13:35:04.000000Z",
"items": [
{
"sku": "91303",
"product_name": "Milk Carton 3%",
"quantity": 5,
"price": 62.76,
"sum": 313.8,
"package_items": 12,
"scale": "Liter"
}
]
}
"sku": "",
[
{
"sku": "60507",
"product_name": "Special Product",
"quantity": 1,
"price": 237.56,
"sum": 237.56,
"package_items": 3,
"scale": "kg"
},
{
"sku": "71303",
"product_name": "Yogurt 3L",
"quantity": 2,
"price": 22.72,
"sum": 45.44,
"package_items": null,
"scale": null
},
{
"product_name": "Natural Cottage Cheese",
"quantity": 1,
"price": 29.95,
"sum": 29.95,
"package_items": 2,
"scale": "kg"
}
]
"package_items": 1,
[
{
"sku": "71308",
"product_name": "Sweet Cream 2L",
"quantity": 1,
"price": 259.32,
"sum": 259.32,
"package_items": 6,
"scale": "liter"
},
{
"sku": "91115",
"product_name": "French Brie 130g",
"quantity": 1,
"price": 10.98,
"sum": 10.98,
"package_items": 1,
"scale": "gram"
}
]
}
]
}
Purpose: This interface allows reading new received orders from the Restigo system (supplier delivery receipts).
Method: GET
URL:
https://api.restigo.co.il/api/thirdParty/newReceivedOrder
Headers:
RESTIGO-API-KEY
Required params:
start_date
end_date
Optional params:
status
The API key must be linked to a specific supplier and is provided privately.
All dates should be formatted as string: yyyy-mm-dd.
Response:
Returns a list (array) of documents. Each document contains the following fields (described below):
json
Copy
Edit
{
"id": int, // db row
"doc_number": string, // Document number
"doc_type": int, // Document type
"doc_date": string, // Document date
"sent_at": string, // Document creation date
"supplier_id": int, // Supplier ID
"supplier_name": string, // Supplier name
"branch_id": int, // Branch ID
"branch_name": string, // Branch name
"status": int // Status: open or closed
"notes": string, // Comments
"total_with_vat": double, // Total amount including VAT
"total_without_vat": double, // Total amount excluding VAT
"customer_code": string, // Customer code
"Assigned_number": string, // Assignment number
"items": [ // Items
{
"catalog_number": string, // Catalog number
"name": string, // Name
"package_items": double, // Quantity in packages
"amount": double, // Quantity in units
"total_amount": double, // Total amount (units * packages)
"scale": string, // Unit of measure
"price": double, // Price
"has_vat": boolean, // Subject to VAT
"debit_account": string, // Debit account for the product
"is_weighted": boolean // Was it received by weight
The status field:
Indicates whether the document is closed (2) or open (1).
A document is considered closed (2) if it matches one of the following 3 cases:
The document is paid in the system
The document is exported to accounting
The document is marked as known by the user
Any document that does not meet one of these 3 conditions will return with open status (1).
The doc_type field explanation:
There are 9 types of documents in the system, and each one has a specific number:
Tax invoice (1)
Delivery note (2)
Tax invoice + purchase order (3)
Tax invoice + credit card purchase (6)
Credit invoice (7)
Return note (8)
Business invoice (9)
Price quote (10)
Receipt (11)
Invoice / Receipt (12)
Additional field customer_code:
Customer code – Empty and does not exist when it's a supplier document (usually from the supplier's Restigo system) returning only purchase orders.
}
]}
Purpose: This interface allows reading new received orders from the Restigo system (supplier delivery receipts).
Method: GET
URL:
https://api.restigo.co.il/api/thirdParty/newReceivedOrder
Headers:
RESTIGO-API-KEY
Required params:
start_date
end_date
Optional params:
status
The API key must be linked to a specific supplier and is provided privately.
All dates should be formatted as string: yyyy-mm-dd.
Response:
Returns a list (array) of documents. Each document contains the following fields (described below):
json
Copy
Edit
{
"id": int, // db row
"doc_number": string, // Document number
"doc_type": int, // Document type
"doc_date": string, // Document date
"sent_at": string, // Document creation date
"supplier_id": int, // Supplier ID
"supplier_name": string, // Supplier name
"branch_id": int, // Branch ID
"branch_name": string, // Branch name
"status": int // Status: open or closed
"notes": string, // Comments
"total_with_vat": double, // Total amount including VAT
"total_without_vat": double, // Total amount excluding VAT
"customer_code": string, // Customer code
"Assigned_number": string, // Assignment number
"items": [ // Items
{
"catalog_number": string, // Catalog number
"name": string, // Name
"package_items": double, // Quantity in packages
"amount": double, // Quantity in units
"total_amount": double, // Total amount (units * packages)
"scale": string, // Unit of measure
"price": double, // Price
"has_vat": boolean, // Subject to VAT
"debit_account": string, // Debit account for the product
"is_weighted": boolean // Was it received by weight
The status field:
Indicates whether the document is closed (2) or open (1).
A document is considered closed (2) if it matches one of the following 3 cases:
The document is paid in the system
The document is exported to accounting
The document is marked as known by the user
Any document that does not meet one of these 3 conditions will return with open status (1).
The doc_type field explanation:
There are 9 types of documents in the system, and each one has a specific number:
Tax invoice (1)
Delivery note (2)
Tax invoice + purchase order (3)
Tax invoice + credit card purchase (6)
Credit invoice (7)
Return note (8)
Business invoice (9)
Price quote (10)
Receipt (11)
Invoice / Receipt (12)
Additional field customer_code:
Customer code – Empty and does not exist when it's a supplier document (usually from the supplier's Restigo system) returning only purchase orders.
}
]}
📘 Purpose
This interface allows you to retrieve sales cost data based on a specified start and end date.
🔗 Method
GET
🌐 URLs
Production:
https://api.restigo.co.il/api/thirdParty/salesCostDevelopment:
https://dev.restigo.co.il/api/thirdParty/salesCost
🧾 Headers
RESTIGO-API-KEY (header)
The key must be linked to a specific supplier and is provided privately.
📥 Request Parameters
| Key | Type | Description |
|---|---|---|
start_date | Required | date | Start date (format: YYYY-MM-DD) |
end_date | Required | date | End date (format: YYYY-MM-DD) |
The request range must not exceed 3 days per request.
📦 Example Request Payload
Response
Success Response
Status Code: 200 OK
Example Response
[
{
{
"date": "2025-03-01", // Sale date (YYYY-MM-DD)
"branch_id": "7445", // Branch ID
"product_code": "101", // Product code from POS
"product_name": "Coffee Beans", // Product name from POS
"restigo_id": 17967, // Product ID in Restigo
"restigo_name": "Bulk Coffee Beans",// Product name in Restigo
"type": "product", // Entry type: "product" or "item"
"amount": 22, // Quantity sold
"total": 404, // Total sales amount (including VAT)
"worth": 91.43 // Raw cost of goods sold
},
{
"date": "2025-03-01",
"branch_id": "7445",
"product_code": "105",
"product_name": "Milk 1L",
"restigo_id": 18040,
"restigo_name": "Organic Milk 1L",
"type": "item",
"amount": 10,
"total": 234,
"worth": 58.22
}
},
]
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "Unauthorized"
}
🔍 Client Lookup API
This API allows retrieving information about an existing client, including branch name and number, pricing schemes (if any), and associated users. The query is based on the client code.
📡 Endpoint
Method: GET
Production URL:https://suppliers.restigo.co.il/api/departments/thirdParty/clients
Development URL:https://suppliers-dev.restigo.co.il/api/departments/thirdParty/clients
🧾 Headers
| key | value |
|---|---|
| token | Provided separately |
📥 Request Parameters
| key | value |
|---|---|
| customer_number | Required | string |
💡 The API key must be linked to a specific supplier and is provided privately.
🛒 Get Active Supplier Items API
This API allows retrieving a list of the supplier’s active products.
📡 Endpoint
Method: GET
Production URL:https://suppliers.restigo.co.il/api/departments/thirdParty/items
Development URL:https://suppliers-dev.restigo.co.il/api/departments/thirdParty/items
🧾 Headers
| key | value |
|---|---|
| token | Provided separately |
📥 Request Parameters
| key | value |
|---|---|
| item_name | Nullable | string |
💡 The API key must be linked to a specific supplier and is provided privately.
✅ Response
Status Code: 200 OK
Success Response Example:
{
{
"item_id": 2,
"item_name": "Product 2"
},
{
"item_id": 3,
"item_name": "Product 3"
},
{
"item_id": 4,
"item_name": "Product 4"
}
]
❌ Error Response
Type: Unauthorized Request
Status Code: 401
json
Copy
Edit
{
"message": "token not found"
}
📘 Get Pricing Lists
Purpose:
This endpoint allows retrieving the supplier's pricing lists, including the associated customers and products for each pricing.
🔗 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
📥 Headers
| key | value |
|---|---|
| token | Provided separately |
📤 Request Parameters
| key | type | description |
|---|---|---|
| pricing_name | Nullable string | Filter by pricing name (optional) |
🔐 The token must be associated with a specific supplier and is provided privately.
✅ Success Response
Status Code: 200 OK
{
"client_id": 1,
"client_name": "client name 1"
},
{
"client_id": 2,
"client_name": "Client name 2"
}
],
"catalog_items": [
{
"item_name": "Product name 1",
"item_id": 435,
"price_after_discount": 112
},
{
"item_name": "Product name 2",
"item_id": 436,
"price_after_discount": 159
},
]
}
]
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "token not found"
}
📘 Get Branches in Network
Purpose:
This endpoint allows retrieving a list of branches in a network.
🔗 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
📥 Headers
| key | value |
|---|---|
| RESTIGO-API-KEY | Provided separately |
🔐 The API key must be associated with a specific customer network and is provided privately.
✅ Success Response
Status Code: 200 OK
Example Response:
[
{
"id": 6942,
"name": "Complex",
"city": "Kedemta",
"address": "Kedemta"
},
{
"id": 6874,
"name": "Efrat Aderzi",
"city": "Ma'ale",
"address": "Ma'ale"
},
{
"id": 6424,
"name": "A.G.R.I Madina Ltd.",
"city": "Petah Tikva",
"address": "65 HaAtzmaut"
},
{
"id": 6425,
"name": "Kilo Market",
"city": "Pardes Hanna-Karkur",
"address": "31 Derech Beit Lechem"
}
]
Error Response
Unauthorized Request
Status Code: 401 Unauthorized
Example Response:
{
"message": "Unauthorized"
}
👥 Get Branch Users
Purpose:
This endpoint allows retrieving a list of employees for a specific branch.
Method: GET
Production URL:https://api.restigo.co.il/api/customer/branches/{branch_id}/users
Development URL:https://dev.restigo.co.il/api/customer/branches/{branch_id}/users
🔐 Headers
| key | value |
|---|---|
| RESTIGO-API-KEY | Provided separately |
The API key must be linked to a specific customer network and is provided privately.
✅ Response
Status Code: 200 OK
Example Response:
"email_address": "Mosheoshe7766@gmail.coml",
"mobile_number": "054-2232701"
},
{
"id": 255099,
"first_name": "john",
"last_name": "doe",
"email_address": "ddoe@restigo.biz",
"mobile_number": "0540000000"
},
{
"id": 255100,
"first_name": "mike",
"last_name": "mike",
"email_address": "mike@restigo.biz",
"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"
}
📦 Get Product Inventory Movement
Purpose:
This endpoint allows retrieving the fill-in movements of products linked to a specific inventory count.
Method: GET
Production URL:https://api.restigo.co.il/api/thirdParty/productItemInventories
Development URL:https://dev.restigo.co.il/api/thirdParty/productItemInventories
🔐 Headers
| key | value |
|---|---|
| RESTIGO-API-KEY | Provided separately |
The API key must be associated with a specific supplier and is provided privately.
📥 Request Parameters
| key | value type & requirement |
|---|---|
date | Required | date (Format: YYYY-MM-DD) |
product_id | Required | integer (Product reference ID) |
count_type | Required | 'weight' | 'unit' | 'package' |
📤 Request Example
Response
Success Response
Status Code: 200 OK
Example Response
{
{
"date": "2025-03-04", // Request date
"branch_id": "xxxx", // Branch ID
"product_id": "xxxx", // Product ID
"count_type": "weight", // Count type (weight, unit, or package)
"base_items": [
{
"name": "Lemonade",
"part_number": "3324", // Catalog number
"supplier_name": "Yitzhar Import & Marketing", // Supplier name
"price": 525.2625, // Product price
"inventories": [
{
"new_inventory_id": 259008, // Movement ID
"inventory_type": "Addition", // Movement type
"date": "2025-03-04", // Movement date
"amount": 23, // Quantity
"worth": 33, // Value
"creator": "System Admin" // Movement creator
},
{
"new_inventory_id": 259008,
"inventory_type": "Addition",
"date": "2025-03-04",
"amount": 1.3,
"worth": 21.3,
"creator": "System Admin"
}
]
}
]
Error Response
Unauthorized Request
Status Code: 401
Example Response
{
"message": "Unauthorized"
}
// Web Report Products – RESTIGO API Documentation
Endpoint:
https://app.restigo.co.il/api/pos/{provider}/receive/products
Purpose:
The `products` endpoint is used to submit sales data of items sold during the day.
Structure:
{
"restigo": {
"branch_id": int, // Branch ID assigned by RESTIGO
"key": int, // Branch key assigned by RESTIGO
"start_date": string, // Opening date of Z report (format: yyyy-mm-dd)
"end_date": string, // Closing date of Z report (format: yyyy-mm-dd)
"transactions_date": string, // Value date for the Z report (format: yyyy-mm-dd)
"products": [
{
"id": int, // Product ID
"name": string, // Product name
"Type": float, // 0 = Sold Dish, 1 = Waste
"Waste": float | null, // Quantity wasted (if Type = 1), null otherwise
"catalog_price": float, // Product catalog price
"sold": float | null, // Quantity sold (if Type = 0), null otherwise
"total": float, // Total sales sum
"items": [ // List of nested items in dish
{
"id": int,
"name": string,
"Type": float,
"Waste": float | null,
"catalog_price": float,
"sold": float,
"total": float
}
]
}
]
}
}
—
Example: Sold Item
"3 Express Meals 1" sold today at the branch, which includes:
– 3 Hamburgers (2 with fried onions)
– 3 Soft drinks
– 2 Chips
– 1 Onion rings
{
"restigo": {
"branch_id": 1,
"key": 123,
"start_date": "2025-03-01",
"end_date": "2025-03-01",
"transactions_date": "2025-03-01",
"products": [
{
"id": 123,
"name": "Express Meal 1",
"Type": 0,
"Waste": null,
"catalog_price": 55,
"sold": 3,
"total": 175,
"items": [
{
"id": 444,
"name": "Express Burger 1",
"Type": 0,
"Waste": null,
"catalog_price": 30,
"sold": 3,
"total": 0
},
{
"id": 555,
"name": "Fried Onion",
"Type": 0,
"Waste": null,
"catalog_price": 5,
"sold": 2,
"total": 10
},
{
"id": 666,
"name": "Chips",
"Type": 0,
"Waste": null,
"catalog_price": 15,
"sold": 2,
"total": 0
},
{
"id": 777,
"name": "Onion Rings",
"Type": 0,
"Waste": null,
"catalog_price": 18,
"sold": 1,
"total": 0
},
{
"id": 888,
"name": "Soft Drink",
"Type": 0,
"Waste": null,
"catalog_price": 12,
"sold": 3,
"total": 0
}
]
}
]
}
}
—
Example: Wasted Item
"2 Coffee & Pastry" meals were thrown away during the day.
{
"restigo": {
"branch_id": 1,
"key": 123,
"start_date": "2025-03-01",
"end_date": "2025-03-01",
"transactions_date": "2025-03-01",
"products": [
{
"id": 123,
"name": "Coffee & Pastry",
"Type": 1,
"Waste": 2,
"catalog_price": 0,
"sold": null,
"total": 0,
"items": [
{
"id": 444,
"name": "Cappuccino",
"Type": 2,
"Waste": 2,
"catalog_price": 0,
"sold": null,
"total": 0
},
{
"id": 555,
"name": "Croissant",
"Type": 1,
"Waste": 2,
"catalog_price": 0,
"sold": null,
"total": 0
}
]
}
]
}
}
Real-Time Employees API
Purpose:
This interface is used to send real-time employee clock-in and clock-out data to the system every 3 minutes. It should contain data for employees who entered and/or exited within the last 2 hours.
Endpoint:
Data to include:
Employee number
Employee name
Entry date
Entry time
Exit date
Exit time
Identifier (optional – internal ID)
Email address (optional)
