Inventory

Inventory counts taken at the account's branches. List counts, or retrieve a single count with its lines.

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

Endpoints

GET/inventory-countsSoon
GET/inventory-counts/{count_id}Soon

The Inventory count object

Attributes

idstringRequired

branch_idstringRequired

counted_atstring · date-timeRequired

statusstringRequired

Possible valuesopencompleted

total_valuestring · money

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

linesarray of object

Counted items. Present when the request includes expand=lines, and when you retrieve a single count by ID.

Show 7 child attributesHide child attributes

product_idstring

skustring

namestring

quantitystring · quantity

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

unitstring

unit_coststring · money

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

valuestring · money

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

updated_atstring · date-timeRequired

The Inventory count object

{
  "id": "ic_2291",
  "branch_id": "71148-1",
  "counted_at": "2026-09-13T07:15:00+03:00",
  "status": "completed",
  "total_value": "203.34",
  "lines": [
    {
      "product_id": "884213",
      "sku": "BK-1104",
      "name": "בייבי ג׳בטה לבן",
      "quantity": "64",
      "unit": "unit",
      "unit_cost": "1.85",
      "value": "118.40"
    },
    {
      "product_id": "884377",
      "sku": "VG-2031",
      "name": "עגבניות שרי",
      "quantity": "6.850",
      "unit": "kg",
      "unit_cost": "12.40",
      "value": "84.94"
    }
  ],
  "updated_at": "2026-09-13T08:02:44+03:00"
}

List inventory counts

GET/inventory-counts

Scopebuyer.inventory: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

expandarray of string

Comma-separated list of related objects to embed in the response, for example lines,supplier,files,history. By default, responses are kept compact.

Responses

200A page of inventory counts.

dataarray of InventoryCountRequired

Show 7 child attributesHide child attributes

idstringRequired

branch_idstringRequired

counted_atstring · date-timeRequired

statusstringRequired

Possible valuesopencompleted

total_valuestring · money

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

linesarray of object

Counted items. Present when the request includes expand=lines, and when you retrieve a single count by ID.

Show 7 child attributesHide child attributes

product_idstring

skustring

namestring

quantitystring · quantity

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

unitstring

unit_coststring · money

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

valuestring · money

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

updated_atstring · date-timeRequired

next_cursorstringNullable

has_morebooleanRequired

GET /inventory-counts

curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/inventory-counts?from=2026-09-01&to=2026-09-13&branch_id=71148-1" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"

const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/inventory-counts?from=2026-09-01&to=2026-09-13&branch_id=71148-1", {
  method: "GET",
  headers: {
    Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
  },
});
const data = await res.json();

import requests

res = requests.get(
    "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/inventory-counts?from=2026-09-01&to=2026-09-13&branch_id=71148-1",
    headers={
        "Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
    },
)
data = res.json()

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…");
var res = await http.GetAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/inventory-counts?from=2026-09-01&to=2026-09-13&branch_id=71148-1");
var data = await res.Content.ReadAsStringAsync();

Response

{
  "data": [
    {
      "id": "ic_2291",
      "branch_id": "71148-1",
      "counted_at": "2026-09-13T07:15:00+03:00",
      "status": "completed",
      "total_value": "203.34",
      "updated_at": "2026-09-13T08:02:44+03:00"
    },
    {
      "id": "ic_2264",
      "branch_id": "71148-1",
      "counted_at": "2026-09-06T07:10:00+03:00",
      "status": "completed",
      "total_value": "187.62",
      "updated_at": "2026-09-06T07:58:10+03:00"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Retrieve an inventory count

GET/inventory-counts/{count_id}

Scopebuyer.inventory:read
Pro plan or higher
Not yet available

Path parameters

count_idstringRequired

Responses

200The inventory count, including its lines.

idstringRequired

branch_idstringRequired

counted_atstring · date-timeRequired

statusstringRequired

Possible valuesopencompleted

total_valuestring · money

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

linesarray of object

Counted items. Present when the request includes expand=lines, and when you retrieve a single count by ID.

Show 7 child attributesHide child attributes

product_idstring

skustring

namestring

quantitystring · quantity

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

unitstring

unit_coststring · money

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

valuestring · money

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

updated_atstring · date-timeRequired

404The resource does not exist or belongs to another account.

GET /inventory-counts/{count_id}

curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/inventory-counts/ic_2291" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"

const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/inventory-counts/ic_2291", {
  method: "GET",
  headers: {
    Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
  },
});
const data = await res.json();

import requests

res = requests.get(
    "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/inventory-counts/ic_2291",
    headers={
        "Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
    },
)
data = res.json()

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…");
var res = await http.GetAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/inventory-counts/ic_2291");
var data = await res.Content.ReadAsStringAsync();

Response

{
  "id": "ic_2291",
  "branch_id": "71148-1",
  "counted_at": "2026-09-13T07:15:00+03:00",
  "status": "completed",
  "total_value": "203.34",
  "lines": [
    {
      "product_id": "884213",
      "sku": "BK-1104",
      "name": "בייבי ג׳בטה לבן",
      "quantity": "64",
      "unit": "unit",
      "unit_cost": "1.85",
      "value": "118.40"
    },
    {
      "product_id": "884377",
      "sku": "VG-2031",
      "name": "עגבניות שרי",
      "quantity": "6.850",
      "unit": "kg",
      "unit_cost": "12.40",
      "value": "84.94"
    }
  ],
  "updated_at": "2026-09-13T08:02:44+03:00"
}

{
  "type": "https://developers.zester.co.il/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Inventory count ic_2291 does not exist or belongs to another account.",
  "instance": "/v2/inventory-counts/ic_2291",
  "request_id": "req_01J9KT6F4R"
}