Getting Started
Catalog Update
Order Management
Total Sales
Suppliers Details
Buyers Details
POS API Documentation
1. Environments
- Production: https://api.zester.co.il/api
- Test: https://test-api.zester.co.il/api
2. Login
Logs the user into the system and retrieves an authentication token needed for other API calls.
This method uses Basic Authentication. The username and password are sent as one String with a column
between them, encoded in Base64 format.
Method: Post
URL: https://test-api.zester.co.il/Token
Header Parameters: Content-Type : application/x-www-form-urlencoded
Body:
Parameter | Type | Description | Required |
grant_type | String | Should always be the mention: “password” | Y |
username | String | Your zester login username | Y |
password | String | Your zester login password | Y |
Sample request
Method:Post
Url: https://test-api.zester.co.il/Token
HEADER: Content-Type: application/x-www-form-urlencoded
Body:
grant_type: password
username: login username
password: login password
3. Z-Total from POS register
Import total sales amount (Z total) from register
Method: Post
Url: {{base_url}}api/v1/POSIncome/ZTotals
Header Parameters: Authorization – TOKEN BEARER
Body: Object: allBranchZ – zBranch[];
zBranch Parameters description:
| Required | Description | Type | Parameter |
| TRUE | Branch ID | string | branchId |
| TRUE | Date ISO FORMAT – (yyyy-MM-ddTHH:mm:ss.SSST) | date | date |
| FALSE | Z Description | string | description |
| TRUE | Z identification number | string | zNum |
| TRUE | Total Income without VAT | decimal | zTotal |
| FALSE | Total Orders number | int | zNumberOfOrders |
| FALSE | Total sales “Dine in” | decimal | zPriceTables |
| FALSE | Total orders “Dine in” | int | zNumTables |
| FALSE | Total TAKE AWAY sales | decimal | zPriceTakeAway |
| FALSE | Total TAKE AWAY orders | int | zNumTakeAway |
| TRUE | Total Tips | decimal | tips |
| FALSE | Total Checks | decimal | zChequeTotal |
| FALSE | Total Cash | decimal | zCashTotal |
| FALSE | Total credit/debit cards | decimal | zCreditTotal |
| FALSE | Total discounts | decimal | reductions |
Sample token header:
Authorization: Bearer 8W_0Lamq7iUlhCJ5gGTW4fYLnL99xTe42LLrLPDQ9Qzc80xItQcZaPY0Y7tMbNQVIoqxXFC0pYiWyqOzHqJ9HuDyOEdGN0WZYMYVBt_kU5nYkhZgnswsvQaPBOlJVEztSl5_H8A3n89qZh0otYEeRR1W72GEDCVfutj1Qmu5TUzqx8Kn95XTOaHs2jD7KfvPJuHnuSCVnYY08WutkOOFbAk6S09EIGFqUwC1IBHjU9lk0rN22IoZP0kTjRZ1BEnbqcbmkF5Dla5mUZUNO1p_HIAppgX3YiUjA5FV084TcpkbCQ2Mo76JEIbz4bdo1E4LC1X17ILeV1b_ZsNNe7Za1a1I6lonVvamXAkM5lPpyxxnrjPCMvwEyb9pXARbILkyvvtxpLWBd4oIzh1fMzq6Y72S5ApqNAqFdDDizPSAKdVHyPuwr9jOCLh7Es1GhHVZHbrBxmcg3a8u-sIqDnG0D9vfNPrjs-KQ8mOkZIeePrpJJ8LwQZhE5WNrBg1E4aTUyrO6jki-Ym57JTVL9_oPt770YCFsP3WYK0ud4bAhQGZghlHgfISLdGSyqEfW3v-WimsTOCnVu2MgulBQrWwdY1u95jrL93XjtOtCMOyEJOVwesGpaGy3J6f8TFLx4jlbMsh7XWy5GlfEMtBcnVLzH5dvE7XUysNzInXFDymUVokKPSVZj9KK7z7qSSBbWy
Sample Body:
Success response: 200
4. Sales details by items
Get sales update sorted by items
Method: Post
URL: {{base_url}}api/v1/POSIncome/SalesDetails
Header Parameters: Authorization – TOKEN BEARER
Body: Object: allBranchSale – BranchSale[]
BranchSale Parameters description:
| Parameter | Description | Type | Required |
| branchId | Branch ID | string | TRUE |
| zNum | Z identification number | string | TRUE |
| itemCode | Item identification number | string | TRUE |
| itemName | Product/item name | string | TRUE |
| itemCount | Total items ordered amount | string | TRUE |
| itemTotal | Total items ordered price | string | TRUE |
| itemLine | Order line number | number | FALSE |
| itemKind | Main category | number | FALSE |
| itemClass | Secondary category | string | FALSE |
| itemPrice | Item price per unit | string | TRUE |
| valueDate | Date in which the transaction is considered effective ISO FORMAT – (yyyy-MM-ddTHH:mm:ss.SSST) | string | TRUE |
Sample Body:
{
“allBranchSale”: [
{
“branchId”: “8070556632s“,
“zNum”: “1”,
“valueDate”: “2023-03-01T12:00:00.000Z”,
“itemCode”: “1”,
“itemName”: “1”,
“itemCount”: 1,
“itemTotal”: 1.25,
“itemPrice”: 20,
“itemLine”: 1,
“itemKind”: “1”,
“itemClass”: “1”
}
]
}
Success Response:
200