Try it · Sandbox

Use a sandbox key. It is kept only for this browser tab and sent only to https://sandbox-api.zester.co.il/v2.

Response
Send the request to see the response.

Sales

Z-reports and item-level sales from the point of sale (POS). Send them from the POS system and list them.

The endpoints in this group are not yet available. This page documents the contract as currently defined.

The Zreport object

Attributes

branch_idstringRequired
z_numberstringRequired
closed_atstring · date-timeRequired
descriptionstring
total_before_vatstring · moneyRequired

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

orders_countinteger
dine_in_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

dine_in_countinteger
take_away_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

take_away_countinteger
tipsstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

cash_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

card_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

cheque_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

discounts_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

idstringRequired
created_atstring · date-time
updated_atstring · date-timeRequired
The Zreport object
{
  "id": "zr_58113",
  "branch_id": "71148-1",
  "z_number": "1204",
  "closed_at": "2026-09-13T23:05:00+03:00",
  "description": "Z 1204 שניצי קפה – ראשי",
  "total_before_vat": "12450.00",
  "orders_count": 414,
  "dine_in_total": "8715.00",
  "dine_in_count": 238,
  "take_away_total": "3735.00",
  "take_away_count": 176,
  "tips": "1164.00",
  "cash_total": "1902.00",
  "card_total": "12789.00",
  "cheque_total": "0.00",
  "discounts_total": "386.50",
  "created_at": "2026-09-13T23:07:18+03:00",
  "updated_at": "2026-09-13T23:07:18+03:00"
}

List Z-reports

GET/sales/z-reports
  • Scopebuyer.sales:read
  • Pro plan or higher
  • Not yet available

Query parameters

cursorstring

Opaque cursor returned as next_cursor in a previous response. Pass it to fetch the next page.

limitinteger

Default 50 · Min 1 · Max 200

fromstring · date

Start of the date range, inclusive, matched against the document date or the order date.

tostring · date

End of the date range, inclusive.

branch_idstring

Responses

200A page of Z-reports.
dataarray of ZReportRequired
Show 18 child attributesHide child attributes
branch_idstringRequired
z_numberstringRequired
closed_atstring · date-timeRequired
descriptionstring
total_before_vatstring · moneyRequired

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

orders_countinteger
dine_in_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

dine_in_countinteger
take_away_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

take_away_countinteger
tipsstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

cash_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

card_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

cheque_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

discounts_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

idstringRequired
created_atstring · date-time
updated_atstring · date-timeRequired
next_cursorstringNullable
has_morebooleanRequired
GET /sales/z-reports
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/sales/z-reports?from=2026-09-12&to=2026-09-13&branch_id=71148-1" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
Response
{
  "data": [
    {
      "id": "zr_58113",
      "branch_id": "71148-1",
      "z_number": "1204",
      "closed_at": "2026-09-13T23:05:00+03:00",
      "description": "Z 1204 שניצי קפה – ראשי",
      "total_before_vat": "12450.00",
      "orders_count": 414,
      "dine_in_total": "8715.00",
      "dine_in_count": 238,
      "take_away_total": "3735.00",
      "take_away_count": 176,
      "tips": "1164.00",
      "cash_total": "1902.00",
      "card_total": "12789.00",
      "cheque_total": "0.00",
      "discounts_total": "386.50",
      "created_at": "2026-09-13T23:07:18+03:00",
      "updated_at": "2026-09-13T23:07:18+03:00"
    },
    {
      "id": "zr_58097",
      "branch_id": "71148-1",
      "z_number": "1203",
      "closed_at": "2026-09-12T23:21:00+03:00",
      "description": "Z 1203 שניצי קפה – ראשי",
      "total_before_vat": "13980.00",
      "orders_count": 451,
      "dine_in_total": "9870.00",
      "dine_in_count": 262,
      "take_away_total": "4110.00",
      "take_away_count": 189,
      "tips": "1312.00",
      "cash_total": "2116.40",
      "card_total": "14380.00",
      "cheque_total": "0.00",
      "discounts_total": "412.00",
      "created_at": "2026-09-12T23:22:47+03:00",
      "updated_at": "2026-09-12T23:22:47+03:00"
    }
  ],
  "next_cursor": null,
  "has_more": false
}
POST/sales/z-reports
  • Scopebuyer.sales:write
  • Not yet available

Send Z-reports from the POS. Each Z-report is identified by its branch_id and z_number, so sending the same Z-report again updates it.

Request body application/json

itemsarray of ZReportCreateRequired

Up to 500 items

Show 15 child attributesHide child attributes
branch_idstringRequired
z_numberstringRequired
closed_atstring · date-timeRequired
descriptionstring
total_before_vatstring · moneyRequired

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

orders_countinteger
dine_in_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

dine_in_countinteger
take_away_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

take_away_countinteger
tipsstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

cash_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

card_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

cheque_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

discounts_totalstring · money

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

Responses

200A result for each item.
summaryobjectRequired
Show 4 child attributesHide child attributes
totalinteger
succeededinteger
failedinteger
skippedinteger
itemsarray of BatchItemResultRequired
Show 5 child attributesHide child attributes
indexintegerRequired

Position of the item in the request's items[] array.

keystring

Business key of the item, such as a document number, SKU or external_id.

statusstringRequired
Possible valuescreatedupdatedskippedfailed
idstring

ID of the resource that was created or updated.

errorsarray of ValidationErrorItem
Show 3 child attributesHide child attributes
fieldstringRequired

JSON path of the field that failed validation.

codestringRequired
messagestring
POST /sales/z-reports
curl -X POST "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/sales/z-reports" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "branch_id": "71148-1",
        "z_number": "1204",
        "closed_at": "2026-09-13T23:05:00+03:00",
        "description": "Z 1204 שניצי קפה – ראשי",
        "total_before_vat": "12450.00",
        "orders_count": 414,
        "dine_in_total": "8715.00",
        "dine_in_count": 238,
        "take_away_total": "3735.00",
        "take_away_count": 176,
        "tips": "1164.00",
        "cash_total": "1902.00",
        "card_total": "12789.00",
        "cheque_total": "0.00",
        "discounts_total": "386.50"
      }
    ]
  }'
Response
{
  "summary": {
    "total": 1,
    "succeeded": 1,
    "failed": 0,
    "skipped": 0
  },
  "items": [
    {
      "index": 0,
      "key": "71148-1/1204",
      "status": "created",
      "id": "zr_58113"
    }
  ]
}

List item sales

GET/sales/item-sales
  • Scopebuyer.sales:read
  • Pro plan or higher
  • Not yet available

Query parameters

cursorstring

Opaque cursor returned as next_cursor in a previous response. Pass it to fetch the next page.

limitinteger

Default 50 · Min 1 · Max 200

fromstring · date

Start of the date range, inclusive, matched against the document date or the order date.

tostring · date

End of the date range, inclusive.

branch_idstring
z_numberstring

Responses

200A page of item sales.
dataarray of ItemSaleRequired
Show 13 child attributesHide child attributes
branch_idstringRequired
z_numberstringRequired
value_datestring · date-timeRequired
item_codestringRequired
item_namestringRequired
quantitystring · quantityRequired

Decimal quantity as a string, with up to 3 fraction digits.

unit_pricestring · moneyRequired

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

totalstring · moneyRequired

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

line_numberinteger
main_categorystring
sub_categorystring
idstringRequired
updated_atstring · date-time
next_cursorstringNullable
has_morebooleanRequired
GET /sales/item-sales
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/sales/item-sales?from=2026-09-13&to=2026-09-13&branch_id=71148-1&z_number=1204&limit=3" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
Response
{
  "data": [
    {
      "id": "is_7700431",
      "branch_id": "71148-1",
      "z_number": "1204",
      "value_date": "2026-09-13T00:00:00+03:00",
      "item_code": "P-101",
      "item_name": "שניצל בלחמניה",
      "quantity": "96",
      "unit_price": "41.53",
      "total": "3986.88",
      "line_number": 1,
      "main_category": "מזון",
      "sub_category": "כריכים",
      "updated_at": "2026-09-13T23:07:19+03:00"
    },
    {
      "id": "is_7700432",
      "branch_id": "71148-1",
      "z_number": "1204",
      "value_date": "2026-09-13T00:00:00+03:00",
      "item_code": "P-205",
      "item_name": "סלט ישראלי",
      "quantity": "41",
      "unit_price": "32.20",
      "total": "1320.20",
      "line_number": 2,
      "main_category": "מזון",
      "sub_category": "סלטים",
      "updated_at": "2026-09-13T23:07:19+03:00"
    },
    {
      "id": "is_7700433",
      "branch_id": "71148-1",
      "z_number": "1204",
      "value_date": "2026-09-13T00:00:00+03:00",
      "item_code": "D-310",
      "item_name": "קפה הפוך",
      "quantity": "212",
      "unit_price": "11.86",
      "total": "2514.32",
      "line_number": 3,
      "main_category": "משקאות",
      "sub_category": "קפה חם",
      "updated_at": "2026-09-13T23:07:19+03:00"
    }
  ],
  "next_cursor": "cur_is_7700433_01J9KT1C9E",
  "has_more": true
}

Create item sales in bulk

POST/sales/item-sales
  • Scopebuyer.sales:write
  • Not yet available

Request body application/json

itemsarray of ItemSaleCreateRequired

Up to 5000 items

Show 11 child attributesHide child attributes
branch_idstringRequired
z_numberstringRequired
value_datestring · date-timeRequired
item_codestringRequired
item_namestringRequired
quantitystring · quantityRequired

Decimal quantity as a string, with up to 3 fraction digits.

unit_pricestring · moneyRequired

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

totalstring · moneyRequired

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

line_numberinteger
main_categorystring
sub_categorystring

Responses

200A result for each item.
summaryobjectRequired
Show 4 child attributesHide child attributes
totalinteger
succeededinteger
failedinteger
skippedinteger
itemsarray of BatchItemResultRequired
Show 5 child attributesHide child attributes
indexintegerRequired

Position of the item in the request's items[] array.

keystring

Business key of the item, such as a document number, SKU or external_id.

statusstringRequired
Possible valuescreatedupdatedskippedfailed
idstring

ID of the resource that was created or updated.

errorsarray of ValidationErrorItem
Show 3 child attributesHide child attributes
fieldstringRequired

JSON path of the field that failed validation.

codestringRequired
messagestring
POST /sales/item-sales
curl -X POST "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/sales/item-sales" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "branch_id": "71148-1",
        "z_number": "1204",
        "value_date": "2026-09-13T00:00:00+03:00",
        "item_code": "P-101",
        "item_name": "שניצל בלחמניה",
        "quantity": "96",
        "unit_price": "41.53",
        "total": "3986.88",
        "line_number": 1,
        "main_category": "מזון",
        "sub_category": "כריכים"
      },
      {
        "branch_id": "71148-1",
        "z_number": "1204",
        "value_date": "2026-09-13T00:00:00+03:00",
        "item_code": "P-205",
        "item_name": "סלט ישראלי",
        "quantity": "41",
        "unit_price": "32.20",
        "total": "1320.20",
        "line_number": 2,
        "main_category": "מזון",
        "sub_category": "סלטים"
      },
      {
        "branch_id": "71148-1",
        "z_number": "1204",
        "value_date": "2026-09-13T00:00:00+03:00",
        "item_code": "D-310",
        "item_name": "קפה הפוך",
        "quantity": "212",
        "unit_price": "11.86",
        "total": "2514.32",
        "line_number": 3,
        "main_category": "משקאות",
        "sub_category": "קפה חם"
      }
    ]
  }'
Response
{
  "summary": {
    "total": 3,
    "succeeded": 3,
    "failed": 0,
    "skipped": 0
  },
  "items": [
    {
      "index": 0,
      "key": "71148-1/1204/1",
      "status": "created",
      "id": "is_7700431"
    },
    {
      "index": 1,
      "key": "71148-1/1204/2",
      "status": "created",
      "id": "is_7700432"
    },
    {
      "index": 2,
      "key": "71148-1/1204/3",
      "status": "created",
      "id": "is_7700433"
    }
  ]
}