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.

Reference

Read-only reference data for a buyer account: branches, purchase types, suppliers, catalog products, expense categories, expense accounts and account mappings.

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

The Supplier object

Attributes

idstringRequired
namestringRequired
tax_idstringNullable
vendor_typestringRequired

Type of vendor. Only vendors of type goods count toward food cost. Vendors of type service, card or internal never do.

Possible valuesgoodsservicecardinternal
counts_in_food_costbooleanRequired
vat_statusstring
Possible valuesstandardexemptzero
payment_termsstringNullable
payment_methodstringNullable
default_category_idstringNullable
default_purchase_typestringNullable
credit_accountstringNullable
merged_into_vendor_idstringNullable
activeboolean
created_atstring · date-time
updated_atstring · date-timeRequired
The Supplier object
{
  "id": "72223",
  "name": "מאפייה אחת עשרה",
  "tax_id": "000000000",
  "vendor_type": "goods",
  "counts_in_food_cost": true,
  "vat_status": "standard",
  "payment_terms": "שוטף + 30",
  "payment_method": "bank_transfer",
  "default_category_id": null,
  "default_purchase_type": "FC",
  "credit_account": "400223",
  "merged_into_vendor_id": null,
  "active": true,
  "created_at": "2024-03-18T10:22:00+03:00",
  "updated_at": "2026-09-02T09:14:00+03:00"
}

List branches

GET/branches
  • Scopebuyer.purchases: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

Responses

200A page of the account's branches, its physical sites.
dataarray of BranchRequired
Show 8 child attributesHide child attributes
idstringRequired
namestringRequired
tax_idstringNullable
codestring
regionstring
addressstring
activeboolean
updated_atstring · date-time
next_cursorstringNullable
has_morebooleanRequired
403The credential is valid but is not allowed to make this request. The code is scope_missing, plan_required, ip_not_allowed or client_suspended.
GET /branches
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/branches?limit=50" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
Response
{
  "data": [
    {
      "id": "71148-1",
      "name": "שניצי קפה – ראשי",
      "tax_id": "000000000",
      "code": "01",
      "region": "מרכז",
      "address": "דרך מנחם בגין 52, תל אביב",
      "active": true,
      "updated_at": "2026-05-20T10:00:00+03:00"
    },
    {
      "id": "71148-2",
      "name": "שניצי קפה – חיפה",
      "tax_id": "000000000",
      "code": "02",
      "region": "צפון",
      "address": "שדרות הנשיא 118, חיפה",
      "active": true,
      "updated_at": "2026-07-02T14:30:00+03:00"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

List purchase types

GET/purchase-types
  • Scopebuyer.purchases:read
  • Pro plan or higher
  • Not yet available

Responses

200The account's purchase types, the business lines such as FC, MK, EV and OC.
dataarray of PurchaseType
Show 3 child attributesHide child attributes
codestringRequired
namestringRequired
is_defaultboolean
GET /purchase-types
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/purchase-types" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
Response
{
  "data": [
    {
      "code": "FC",
      "name": "פוד קוסט",
      "is_default": true
    },
    {
      "code": "MK",
      "name": "שיווק",
      "is_default": false
    },
    {
      "code": "EV",
      "name": "אירועים",
      "is_default": false
    },
    {
      "code": "OC",
      "name": "הוצאות תפעול",
      "is_default": false
    }
  ]
}

List suppliers

GET/suppliers
  • Scopebuyer.suppliers: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

updated_sincestring · date-time

Return only items whose updated_at is strictly after this timestamp. Use it for incremental sync.

vendor_typestring

Type of vendor. Only vendors of type goods count toward food cost. Vendors of type service, card or internal never do.

Possible valuesgoodsservicecardinternal

Responses

200A page of the account's suppliers (vendors).
dataarray of SupplierRequired
Show 15 child attributesHide child attributes
idstringRequired
namestringRequired
tax_idstringNullable
vendor_typestringRequired

Type of vendor. Only vendors of type goods count toward food cost. Vendors of type service, card or internal never do.

Possible valuesgoodsservicecardinternal
counts_in_food_costbooleanRequired
vat_statusstring
Possible valuesstandardexemptzero
payment_termsstringNullable
payment_methodstringNullable
default_category_idstringNullable
default_purchase_typestringNullable
credit_accountstringNullable
merged_into_vendor_idstringNullable
activeboolean
created_atstring · date-time
updated_atstring · date-timeRequired
next_cursorstringNullable
has_morebooleanRequired
GET /suppliers
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/suppliers?updated_since=2026-09-01T00:00:00%2B03:00&limit=200" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
Response
{
  "data": [
    {
      "id": "72223",
      "name": "מאפייה אחת עשרה",
      "tax_id": "000000000",
      "vendor_type": "goods",
      "counts_in_food_cost": true,
      "vat_status": "standard",
      "payment_terms": "שוטף + 30",
      "payment_method": "bank_transfer",
      "default_category_id": null,
      "default_purchase_type": "FC",
      "credit_account": "400223",
      "merged_into_vendor_id": null,
      "active": true,
      "created_at": "2024-03-18T10:22:00+03:00",
      "updated_at": "2026-09-02T09:14:00+03:00"
    },
    {
      "id": "72455",
      "name": "נקי פלוס",
      "tax_id": "000000000",
      "vendor_type": "service",
      "counts_in_food_cost": false,
      "vat_status": "standard",
      "payment_terms": "שוטף + 30",
      "payment_method": "bank_transfer",
      "default_category_id": "912",
      "default_purchase_type": "OC",
      "credit_account": "400455",
      "merged_into_vendor_id": null,
      "active": true,
      "created_at": "2025-01-06T12:05:00+03:00",
      "updated_at": "2026-09-03T11:40:00+03:00"
    },
    {
      "id": "72901",
      "name": "חברת החשמל",
      "tax_id": "000000000",
      "vendor_type": "service",
      "counts_in_food_cost": false,
      "vat_status": "standard",
      "payment_terms": "לפי תאריך החשבון",
      "payment_method": "standing_order",
      "default_category_id": "931",
      "default_purchase_type": "OC",
      "credit_account": "400901",
      "merged_into_vendor_id": null,
      "active": true,
      "created_at": "2023-11-01T09:00:00+03:00",
      "updated_at": "2026-09-04T06:12:00+03:00"
    }
  ],
  "next_cursor": "eyJ1IjoiMjAyNi0wOS0wNFQwNjoxMjowMCswMzowMCIsImlkIjoiNzI5MDEifQ",
  "has_more": true
}

Retrieve a supplier

GET/suppliers/{supplier_id}
  • Scopebuyer.suppliers:read
  • Pro plan or higher
  • Not yet available

Path parameters

supplier_idstringRequired

Responses

200The supplier.
idstringRequired
namestringRequired
tax_idstringNullable
vendor_typestringRequired

Type of vendor. Only vendors of type goods count toward food cost. Vendors of type service, card or internal never do.

Possible valuesgoodsservicecardinternal
counts_in_food_costbooleanRequired
vat_statusstring
Possible valuesstandardexemptzero
payment_termsstringNullable
payment_methodstringNullable
default_category_idstringNullable
default_purchase_typestringNullable
credit_accountstringNullable
merged_into_vendor_idstringNullable
activeboolean
created_atstring · date-time
updated_atstring · date-timeRequired
404The resource does not exist or belongs to another account.
GET /suppliers/{supplier_id}
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/suppliers/72223" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
Response
{
  "id": "72223",
  "name": "מאפייה אחת עשרה",
  "tax_id": "000000000",
  "vendor_type": "goods",
  "counts_in_food_cost": true,
  "vat_status": "standard",
  "payment_terms": "שוטף + 30",
  "payment_method": "bank_transfer",
  "default_category_id": null,
  "default_purchase_type": "FC",
  "credit_account": "400223",
  "merged_into_vendor_id": null,
  "active": true,
  "created_at": "2024-03-18T10:22:00+03:00",
  "updated_at": "2026-09-02T09:14:00+03:00"
}

List catalog products

GET/products
  • Scopebuyer.catalog: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

updated_sincestring · date-time

Return only items whose updated_at is strictly after this timestamp. Use it for incremental sync.

supplier_idstring
product_groupstring

Responses

200A page of products from the buyer's catalog.
dataarray of BuyerProductRequired
Show 13 child attributesHide child attributes
idstringRequired
skustringRequired
namestringRequired
supplier_idstringRequired
product_groupstringNullable
category_idstringNullable

ID of the expense category mapped from product_group.

unitstring
package_quantitystring · quantity

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

current_pricestring · moneyNullable

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

vat_exemptboolean
inventory_itemboolean
activeboolean
updated_atstring · date-timeRequired
next_cursorstringNullable
has_morebooleanRequired
GET /products
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/products?updated_since=2026-09-01T00:00:00%2B03:00&limit=200" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
Response
{
  "data": [
    {
      "id": "8812001",
      "sku": "300",
      "name": "בייבי ג׳בטה לבן",
      "supplier_id": "72223",
      "product_group": "לחמים",
      "category_id": null,
      "unit": "carton",
      "current_price": "80.00",
      "vat_exempt": false,
      "inventory_item": true,
      "active": true,
      "updated_at": "2026-09-01T06:00:00+03:00"
    },
    {
      "id": "8812002",
      "sku": "412",
      "name": "לחמניית חיטה מלאה",
      "supplier_id": "72223",
      "product_group": "לחמים",
      "category_id": null,
      "unit": "carton",
      "current_price": "34.70",
      "vat_exempt": false,
      "inventory_item": true,
      "active": true,
      "updated_at": "2026-09-01T06:00:05+03:00"
    },
    {
      "id": "8813045",
      "sku": "1045",
      "name": "עגבניות שרי",
      "supplier_id": "72310",
      "product_group": "ירקות",
      "category_id": null,
      "unit": "kg",
      "package_quantity": "1",
      "current_price": "12.90",
      "vat_exempt": true,
      "inventory_item": true,
      "active": true,
      "updated_at": "2026-09-08T05:30:00+03:00"
    }
  ],
  "next_cursor": "eyJ1IjoiMjAyNi0wOS0wOFQwNTozMDowMCswMzowMCIsImlkIjoiODgxMzA0NSJ9",
  "has_more": true
}

List expense categories

GET/expense-categories
  • Scopebuyer.expenses:read
  • Pro plan or higher
  • Not yet available

Responses

200The expense category tree (2 levels) as a flat list. Each category references its parent in parent_id.
dataarray of ExpenseCategory
Show 7 child attributesHide child attributes
idstringRequired
parent_idstringNullable
namestringRequired
pl_groupstringRequired
Possible valuessales_marketingsalariesgeneral_adminfixeddelivery_feesotherfinancetaxes
default_vat_treatmentstring
Possible valuesfulltwo_thirdsquarternone
is_recurring_fixedboolean
is_activebooleanRequired
GET /expense-categories
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/expense-categories" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
Response
{
  "data": [
    {
      "id": "900",
      "parent_id": null,
      "name": "תפעול",
      "pl_group": "general_admin",
      "default_vat_treatment": "full",
      "is_recurring_fixed": false,
      "is_active": true
    },
    {
      "id": "912",
      "parent_id": "900",
      "name": "ניקיון וחומרי ניקוי",
      "pl_group": "general_admin",
      "default_vat_treatment": "full",
      "is_recurring_fixed": false,
      "is_active": true
    },
    {
      "id": "915",
      "parent_id": "900",
      "name": "דלק וחניה",
      "pl_group": "general_admin",
      "default_vat_treatment": "two_thirds",
      "is_recurring_fixed": false,
      "is_active": true
    },
    {
      "id": "930",
      "parent_id": null,
      "name": "הוצאות קבועות",
      "pl_group": "fixed",
      "default_vat_treatment": "full",
      "is_recurring_fixed": true,
      "is_active": true
    },
    {
      "id": "931",
      "parent_id": "930",
      "name": "חשמל",
      "pl_group": "fixed",
      "default_vat_treatment": "full",
      "is_recurring_fixed": true,
      "is_active": true
    }
  ]
}

List expense accounts

GET/expense-accounts
  • Scopebuyer.accounting:read
  • Pro plan or higher
  • Not yet available

Responses

200The ZesttBox expense account catalog.
dataarray of ExpenseAccount
Show 3 child attributesHide child attributes
codestringRequired
namestringRequired
activeboolean
GET /expense-accounts
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/expense-accounts" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
Response
{
  "data": [
    {
      "code": "5100",
      "name": "קניות מזון וחומרי גלם",
      "active": true
    },
    {
      "code": "6100",
      "name": "ניקיון וחומרי ניקוי",
      "active": true
    },
    {
      "code": "6150",
      "name": "ניקיון לאירועים",
      "active": true
    },
    {
      "code": "6190",
      "name": "חומרי ניקוי (לא בשימוש)",
      "active": false
    },
    {
      "code": "6200",
      "name": "חשמל ומים",
      "active": true
    },
    {
      "code": "6300",
      "name": "רכב, דלק וחניה",
      "active": true
    }
  ]
}

List account mappings

GET/account-mappings
  • Scopebuyer.accounting:read
  • Pro plan or higher
  • Not yet available

Responses

200The mappings from expense category and purchase type to expense account. A row with purchase_type set to null is the fallback for any purchase type.
dataarray of AccountMapping
Show 3 child attributesHide child attributes
category_idstringRequired
purchase_typestringNullable

Purchase type this mapping applies to, or null for the fallback mapping that applies to any purchase type.

expense_accountstringRequired
GET /account-mappings
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/account-mappings" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"
Response
{
  "data": [
    {
      "category_id": "912",
      "purchase_type": null,
      "expense_account": "6100"
    },
    {
      "category_id": "912",
      "purchase_type": "EV",
      "expense_account": "6150"
    },
    {
      "category_id": "915",
      "purchase_type": null,
      "expense_account": "6300"
    },
    {
      "category_id": "931",
      "purchase_type": null,
      "expense_account": "6200"
    }
  ]
}