Purchases
Orders and purchase documents, such as delivery notes, invoices and credit notes, across all of the account's suppliers. Documents include their lines and export status.
The endpoints in this group are not yet available. This page documents the contract as currently defined.
The Order object
Attributes
Possible values
draftpending_approvalapprovedpartially_approvedrejectedcancelledcancelled_after_approvalwaiting_to_sendBusiness line of the order, such as FC, MK, EV or OC. Set only when the buyer uses purchase types.
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Line items of the order. Included by default. Pass expand=-lines to leave them out.
Show 14 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal quantity as a string, with up to 3 fraction digits.
The supplier's ERP sales order number. Set by the supplier when it acknowledges the order.
Change history of the order. Present only when the request includes expand=history.
{
"id": "2335619",
"number": "71148-80",
"status": "pending_approval",
"buyer": {
"id": "71148",
"name": "שניצי קפה",
"customer_number": "777077070"
},
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": null,
"sent_at": "2026-09-11T08:15:00+03:00",
"delivery_date": "2026-09-14",
"delivery_window": {
"from": "06:00",
"to": "09:00"
},
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"id": "l1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"package_quantity": "24",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "80.00",
"quantity_confirmed": null,
"substitute_sku": null
},
{
"id": "l2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"package_quantity": "40",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "416.40",
"quantity_confirmed": null,
"substitute_sku": null
}
],
"notes": "נא לפרוק ליד דלת השירות, הכניסה מהחניה האחורית.",
"external_ref": null,
"acknowledged_at": null,
"related_document_ids": [],
"files": [],
"created_at": "2026-09-11T08:02:31+03:00",
"updated_at": "2026-09-11T08:15:00+03:00",
"deleted_at": null,
"history": [
{
"at": "2026-09-11T08:02:31+03:00",
"action": "created",
"actor": {
"type": "user",
"id": "usr_58213",
"name": "דנה כהן"
},
"changes": {
"status": {
"from": null,
"to": "draft"
}
}
},
{
"at": "2026-09-11T08:15:00+03:00",
"action": "sent",
"actor": {
"type": "user",
"id": "usr_58213",
"name": "דנה כהן"
},
"changes": {
"status": {
"from": "draft",
"to": "pending_approval"
}
}
}
]
}GET
/ordersQuery parameters
Opaque cursor returned as next_cursor in a previous response. Pass it to fetch the next page.
Return only items whose updated_at is strictly after this timestamp. Use it for incremental sync.
Start of the date range, inclusive, matched against the document date or the order date.
Comma-separated list of order statuses to filter by.
Possible values
draftpending_approvalapprovedpartially_approvedrejectedcancelledcancelled_after_approvalwaiting_to_sendResponses
200A page of orders.
Show 22 child attributesHide child attributes
Possible values
draftpending_approvalapprovedpartially_approvedrejectedcancelledcancelled_after_approvalwaiting_to_sendBusiness line of the order, such as FC, MK, EV or OC. Set only when the buyer uses purchase types.
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Line items of the order. Included by default. Pass expand=-lines to leave them out.
Show 14 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal quantity as a string, with up to 3 fraction digits.
The supplier's ERP sales order number. Set by the supplier when it acknowledges the order.
Change history of the order. Present only when the request includes expand=history.
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.
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/orders?updated_since=2026-09-13T00:00:00%2B03:00&limit=200" \
-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/orders?updated_since=2026-09-13T00:00:00%2B03:00&limit=200", {
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/orders?updated_since=2026-09-13T00:00:00%2B03:00&limit=200",
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/orders?updated_since=2026-09-13T00:00:00%2B03:00&limit=200");
var data = await res.Content.ReadAsStringAsync();{
"data": [
{
"id": "2335731",
"number": "71148-82",
"status": "pending_approval",
"buyer": {
"id": "71148",
"name": "שניצי קפה",
"customer_number": "777077070"
},
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"branch": {
"id": "71148-2",
"name": "שניצי קפה – חיפה",
"tax_id": "000000000"
},
"purchase_type": "FC",
"delivery_date": "2026-09-15",
"currency": "ILS",
"totals": {
"before_vat": "194.70",
"vat": "35.05",
"with_vat": "229.75"
},
"lines": [
{
"id": "l1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "2",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "160.00",
"quantity_confirmed": null,
"substitute_sku": null,
"product_group": "לחמים",
"expense_account": "5100"
},
{
"id": "l2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "1",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "34.70",
"quantity_confirmed": null,
"substitute_sku": null,
"product_group": "לחמים",
"expense_account": "5100"
}
],
"notes": "הזמנה מה-ERP של הרשת",
"external_ref": "PO-2026-0917",
"acknowledged_at": null,
"related_document_ids": [],
"created_at": "2026-09-13T08:05:00+03:00",
"updated_at": "2026-09-13T08:05:00+03:00",
"deleted_at": null
},
{
"id": "2335702",
"number": "71148-81",
"status": "approved",
"buyer": {
"id": "71148",
"name": "שניצי קפה",
"customer_number": "SH-1148"
},
"supplier": {
"id": "72310",
"name": "הירקן של השכונה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": "FC",
"sent_at": "2026-09-11T08:25:00+03:00",
"delivery_date": "2026-09-14",
"delivery_window": {
"from": "06:00",
"to": "08:00"
},
"currency": "ILS",
"totals": {
"before_vat": "107.70",
"vat": "0.00",
"with_vat": "107.70"
},
"lines": [
{
"id": "l1",
"sku": "1045",
"name": "עגבניות שרי",
"quantity": "5.000",
"unit": "kg",
"package_quantity": "1",
"unit_price": "12.90",
"discount_pct": null,
"vat_exempt": true,
"total": "64.50",
"quantity_confirmed": "5.000",
"substitute_sku": null,
"product_group": "ירקות",
"expense_account": "5100"
},
{
"id": "l2",
"sku": "1012",
"name": "מלפפונים",
"quantity": "8.000",
"unit": "kg",
"package_quantity": "1",
"unit_price": "5.40",
"discount_pct": null,
"vat_exempt": true,
"total": "43.20",
"quantity_confirmed": "8.000",
"substitute_sku": null,
"product_group": "ירקות",
"expense_account": "5100"
}
],
"notes": null,
"external_ref": null,
"acknowledged_at": null,
"related_document_ids": [
"5521004"
],
"created_at": "2026-09-11T08:20:00+03:00",
"updated_at": "2026-09-14T08:15:00+03:00",
"deleted_at": null
},
{
"id": "2335619",
"number": "71148-80",
"status": "approved",
"buyer": {
"id": "71148",
"name": "שניצי קפה",
"customer_number": "777077070"
},
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": "FC",
"sent_at": "2026-09-11T08:15:00+03:00",
"delivery_date": "2026-09-14",
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"id": "l1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "80.00",
"quantity_confirmed": "1",
"substitute_sku": null,
"product_group": "לחמים",
"expense_account": "5100"
},
{
"id": "l2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "416.40",
"quantity_confirmed": "12",
"substitute_sku": null,
"product_group": "לחמים",
"expense_account": "5100"
}
],
"notes": null,
"external_ref": "SO-88412",
"acknowledged_at": "2026-09-11T09:05:00+03:00",
"related_document_ids": [
"5520931",
"5520987"
],
"created_at": "2026-09-11T07:50:00+03:00",
"updated_at": "2026-09-14T11:10:00+03:00",
"deleted_at": null
}
],
"next_cursor": "eyJ1IjoiMjAyNi0wOS0xNFQxMToxMDowMCswMzowMCIsImlkIjoiMjMzNTYxOSJ9",
"has_more": true
}{
"type": "https://developers.zester.co.il/errors/plan_required",
"title": "Plan upgrade required",
"status": 403,
"code": "plan_required",
"detail": "The buyer API requires the Pro plan or above. Account 71148 is on the Basic plan.",
"request_id": "req_01J9KS4H7B",
"upgrade_url": "https://app.zester.co.il/billing"
}POST
/ordersHeaders
Required key for safely retrying the request. Use a stable business key, such as the document number. Sending the same key with the same body within 24 hours returns the original response. Reusing the key with a different body returns 409 with code idempotency_conflict.
Up to 128 characters
Request body application/json
Responses
201The created order. Its status follows the buyer's approval rules.
Possible values
draftpending_approvalapprovedpartially_approvedrejectedcancelledcancelled_after_approvalwaiting_to_sendBusiness line of the order, such as FC, MK, EV or OC. Set only when the buyer uses purchase types.
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Line items of the order. Included by default. Pass expand=-lines to leave them out.
Show 14 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal quantity as a string, with up to 3 fraction digits.
The supplier's ERP sales order number. Set by the supplier when it acknowledges the order.
Change history of the order. Present only when the request includes expand=history.
422The request body or query parameters failed validation. See errors[] for each invalid field.
curl -X POST "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/orders" \
-H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: PO-2026-0917" \
-d '{
"supplier_id": "72223",
"branch_id": "71148-2",
"purchase_type": "FC",
"delivery_date": "2026-09-15",
"notes": "הזמנה מה-ERP של הרשת",
"external_ref": "PO-2026-0917",
"lines": [
{
"sku": "300",
"quantity": "2"
},
{
"sku": "412",
"quantity": "1"
}
]
}'const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/orders", {
method: "POST",
headers: {
Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Content-Type": "application/json",
"Idempotency-Key": "PO-2026-0917",
},
body: JSON.stringify({
"supplier_id": "72223",
"branch_id": "71148-2",
"purchase_type": "FC",
"delivery_date": "2026-09-15",
"notes": "הזמנה מה-ERP של הרשת",
"external_ref": "PO-2026-0917",
"lines": [
{
"sku": "300",
"quantity": "2"
},
{
"sku": "412",
"quantity": "1"
}
]
}),
});
const data = await res.json();import requests
res = requests.post(
"https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/orders",
headers={
"Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Idempotency-Key": "PO-2026-0917",
},
json={
"supplier_id": "72223",
"branch_id": "71148-2",
"purchase_type": "FC",
"delivery_date": "2026-09-15",
"notes": "הזמנה מה-ERP של הרשת",
"external_ref": "PO-2026-0917",
"lines": [
{
"sku": "300",
"quantity": "2"
},
{
"sku": "412",
"quantity": "1"
}
]
},
)
data = res.json()using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", "zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…");
http.DefaultRequestHeaders.Add("Idempotency-Key", "PO-2026-0917");
var body = new StringContent("""
{
"supplier_id": "72223",
"branch_id": "71148-2",
"purchase_type": "FC",
"delivery_date": "2026-09-15",
"notes": "הזמנה מה-ERP של הרשת",
"external_ref": "PO-2026-0917",
"lines": [
{
"sku": "300",
"quantity": "2"
},
{
"sku": "412",
"quantity": "1"
}
]
}
""", Encoding.UTF8, "application/json");
var res = await http.PostAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/orders", body);
var data = await res.Content.ReadAsStringAsync();{
"id": "2335731",
"number": "71148-82",
"status": "pending_approval",
"buyer": {
"id": "71148",
"name": "שניצי קפה",
"customer_number": "777077070"
},
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"branch": {
"id": "71148-2",
"name": "שניצי קפה – חיפה",
"tax_id": "000000000"
},
"purchase_type": "FC",
"delivery_date": "2026-09-15",
"currency": "ILS",
"totals": {
"before_vat": "194.70",
"vat": "35.05",
"with_vat": "229.75"
},
"lines": [
{
"id": "l1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "2",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "160.00",
"quantity_confirmed": null,
"substitute_sku": null,
"product_group": "לחמים",
"expense_account": "5100"
},
{
"id": "l2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "1",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "34.70",
"quantity_confirmed": null,
"substitute_sku": null,
"product_group": "לחמים",
"expense_account": "5100"
}
],
"notes": "הזמנה מה-ERP של הרשת",
"external_ref": "PO-2026-0917",
"acknowledged_at": null,
"related_document_ids": [],
"created_at": "2026-09-13T08:05:00+03:00",
"updated_at": "2026-09-13T08:05:00+03:00",
"deleted_at": null
}{
"type": "https://developers.zester.co.il/errors/validation_error",
"title": "Validation failed",
"status": 422,
"code": "validation_error",
"detail": "2 fields are invalid",
"request_id": "req_01J9KT1M3E",
"errors": [
{
"field": "lines[1].sku",
"code": "product_unavailable",
"message": "SKU 412 is marked unavailable by supplier 72223 until 2026-09-16"
},
{
"field": "delivery_date",
"code": "after_cutoff",
"message": "Supplier 72223 closes orders for 2026-09-15 at 12:00 on 2026-09-14"
}
]
}GET
/orders/{order_id}Path parameters
Query parameters
Responses
200The order.
Possible values
draftpending_approvalapprovedpartially_approvedrejectedcancelledcancelled_after_approvalwaiting_to_sendBusiness line of the order, such as FC, MK, EV or OC. Set only when the buyer uses purchase types.
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Line items of the order. Included by default. Pass expand=-lines to leave them out.
Show 14 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal quantity as a string, with up to 3 fraction digits.
The supplier's ERP sales order number. Set by the supplier when it acknowledges the order.
Change history of the order. Present only when the request includes expand=history.
404The resource does not exist or belongs to another account.
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/orders/2335619?expand=history" \
-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/orders/2335619?expand=history", {
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/orders/2335619?expand=history",
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/orders/2335619?expand=history");
var data = await res.Content.ReadAsStringAsync();{
"id": "2335619",
"number": "71148-80",
"status": "approved",
"buyer": {
"id": "71148",
"name": "שניצי קפה",
"customer_number": "777077070"
},
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": "FC",
"sent_at": "2026-09-11T08:15:00+03:00",
"delivery_date": "2026-09-14",
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"id": "l1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "80.00",
"quantity_confirmed": "1",
"substitute_sku": null,
"product_group": "לחמים",
"expense_account": "5100"
},
{
"id": "l2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "416.40",
"quantity_confirmed": "12",
"substitute_sku": null,
"product_group": "לחמים",
"expense_account": "5100"
}
],
"notes": null,
"external_ref": "SO-88412",
"acknowledged_at": "2026-09-11T09:05:00+03:00",
"related_document_ids": [
"5520931",
"5520987"
],
"created_at": "2026-09-11T07:50:00+03:00",
"updated_at": "2026-09-14T11:10:00+03:00",
"deleted_at": null,
"history": [
{
"at": "2026-09-11T07:50:00+03:00",
"action": "created",
"actor": {
"type": "user",
"id": "usr_5531",
"name": "דנה לוי"
},
"changes": {
"status": {
"from": null,
"to": "pending_approval"
}
}
},
{
"at": "2026-09-11T08:10:00+03:00",
"action": "approved",
"actor": {
"type": "user",
"id": "usr_5502",
"name": "יוסי כהן"
},
"changes": {
"status": {
"from": "pending_approval",
"to": "approved"
}
}
},
{
"at": "2026-09-11T08:15:00+03:00",
"action": "sent",
"actor": {
"type": "system",
"id": "system",
"name": "Zestt"
},
"changes": {
"sent_at": {
"from": null,
"to": "2026-09-11T08:15:00+03:00"
}
}
},
{
"at": "2026-09-11T09:02:00+03:00",
"action": "confirmed",
"actor": {
"type": "api_client",
"id": "cl_01J9KQ7X4M",
"name": "ERP מאפייה אחת עשרה"
},
"changes": {
"lines[0].quantity_confirmed": {
"from": null,
"to": "1"
},
"lines[1].quantity_confirmed": {
"from": null,
"to": "12"
}
}
},
{
"at": "2026-09-11T09:05:00+03:00",
"action": "acknowledged",
"actor": {
"type": "api_client",
"id": "cl_01J9KQ7X4M",
"name": "ERP מאפייה אחת עשרה"
},
"changes": {
"external_ref": {
"from": null,
"to": "SO-88412"
}
}
},
{
"at": "2026-09-14T07:42:00+03:00",
"action": "document_linked",
"actor": {
"type": "user",
"id": "usr_5531",
"name": "דנה לוי"
},
"changes": {
"related_document_ids": {
"added": [
"5520931"
]
}
}
},
{
"at": "2026-09-14T11:10:00+03:00",
"action": "document_linked",
"actor": {
"type": "system",
"id": "system",
"name": "Zestt"
},
"changes": {
"related_document_ids": {
"added": [
"5520987"
]
}
}
}
]
}{
"type": "https://developers.zester.co.il/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "Order 2335619 does not exist or belongs to another account.",
"request_id": "req_01J9KT8R2W"
}GET
/documentsQuery parameters
Opaque cursor returned as next_cursor in a previous response. Pass it to fetch the next page.
Return only items whose updated_at is strictly after this timestamp. Use it for incremental sync.
Start of the date range, inclusive, matched against the document date or the order date.
Comma-separated list of document types to filter by.
Possible values
delivery_noteinvoicecredit_noteconsolidated_invoiceResponses
200A page of documents.
Show 28 child attributesHide child attributes
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Israeli invoice allocation number. Mandatory for amounts above 5,000 ILS.
Show 14 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
What the buyer has done with the document, such as receiving, disputing or exporting it.
Possible values
pendingreceivedreceived_with_differencesdisputedapproved_for_exportexportedcurl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/documents?updated_since=2026-09-14T00:00:00%2B03:00&limit=200&type=delivery_note,invoice&expand=lines" \
-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/documents?updated_since=2026-09-14T00:00:00%2B03:00&limit=200&type=delivery_note,invoice&expand=lines", {
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/documents?updated_since=2026-09-14T00:00:00%2B03:00&limit=200&type=delivery_note,invoice&expand=lines",
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/documents?updated_since=2026-09-14T00:00:00%2B03:00&limit=200&type=delivery_note,invoice&expand=lines");
var data = await res.Content.ReadAsStringAsync();{
"data": [
{
"id": "5520931",
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"accounting_period": "2026-09",
"due_date": null,
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"buyer": {
"id": "71148",
"name": "שניצי קפה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": "FC",
"source": "purchase",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"allocation_number": null,
"lines": [
{
"id": "dl1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "80.00",
"order_id": "2335619",
"order_line_id": "l1",
"quantity_received": "1",
"purchase_type": "FC",
"expense_account": "5100"
},
{
"id": "dl2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "416.40",
"order_id": "2335619",
"order_line_id": "l2",
"quantity_received": "10",
"purchase_type": "FC",
"expense_account": "5100"
}
],
"buyer_status": "received_with_differences",
"differences": [
{
"line_id": "dl2",
"sku": "412",
"field": "quantity",
"issued": "12",
"received": "10",
"note": "התקבלו 10 קרטונים מתוך 12"
}
],
"export_status": "not_ready",
"exported_at": null,
"files": [
{
"id": "file_01J9KR0A6T",
"name": "tm-2026-4471.pdf",
"content_type": "application/pdf",
"size_bytes": 184320
}
],
"external_ref": "SO-88412",
"created_at": "2026-09-14T06:06:00+03:00",
"updated_at": "2026-09-14T07:42:00+03:00",
"deleted_at": null
},
{
"id": "5521004",
"type": "delivery_note",
"number": "18830",
"date": "2026-09-14",
"accounting_period": "2026-09",
"due_date": null,
"supplier": {
"id": "72310",
"name": "הירקן של השכונה"
},
"buyer": {
"id": "71148",
"name": "שניצי קפה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": "FC",
"source": "purchase",
"order_ids": [
"2335702"
],
"currency": "ILS",
"totals": {
"before_vat": "107.70",
"vat": "0.00",
"with_vat": "107.70"
},
"allocation_number": null,
"lines": [
{
"id": "dl1",
"sku": "1045",
"name": "עגבניות שרי",
"quantity": "5.000",
"unit": "kg",
"unit_price": "12.90",
"discount_pct": null,
"vat_exempt": true,
"total": "64.50",
"order_id": "2335702",
"order_line_id": "l1",
"quantity_received": "4.500",
"purchase_type": "FC",
"expense_account": "5100"
},
{
"id": "dl2",
"sku": "1012",
"name": "מלפפונים",
"quantity": "8.000",
"unit": "kg",
"unit_price": "5.40",
"discount_pct": null,
"vat_exempt": true,
"total": "43.20",
"order_id": "2335702",
"order_line_id": "l2",
"quantity_received": "8.000",
"purchase_type": "FC",
"expense_account": "5100"
}
],
"buyer_status": "received_with_differences",
"differences": [
{
"line_id": "dl1",
"sku": "1045",
"field": "quantity",
"issued": "5.000",
"received": "4.500",
"note": "חסרה סלסלה אחת של חצי קילו"
}
],
"export_status": "not_ready",
"exported_at": null,
"files": [
{
"id": "file_01J9MA7C2V",
"name": "teuda-18830.jpg",
"content_type": "image/jpeg",
"size_bytes": 412904
}
],
"external_ref": null,
"created_at": "2026-09-14T05:50:00+03:00",
"updated_at": "2026-09-14T08:15:00+03:00",
"deleted_at": null
},
{
"id": "5520987",
"type": "invoice",
"number": "INV-2026-1188",
"date": "2026-09-14",
"accounting_period": "2026-09",
"due_date": "2026-10-30",
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"buyer": {
"id": "71148",
"name": "שניצי קפה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": "FC",
"source": "purchase",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "427.00",
"vat": "76.86",
"with_vat": "503.86"
},
"allocation_number": null,
"lines": [
{
"id": "il1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "80.00",
"order_id": "2335619",
"order_line_id": "l1",
"quantity_received": null,
"purchase_type": "FC",
"expense_account": "5100"
},
{
"id": "il2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "10",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "347.00",
"order_id": "2335619",
"order_line_id": "l2",
"quantity_received": null,
"purchase_type": "FC",
"expense_account": "5100"
}
],
"buyer_status": "approved_for_export",
"differences": [],
"payment_status": "unpaid",
"paid_at": null,
"export_status": "approved_for_export",
"exported_at": null,
"files": [
{
"id": "file_01J9MB3Q8H",
"name": "inv-2026-1188.pdf",
"content_type": "application/pdf",
"size_bytes": 201472
}
],
"external_ref": "SO-88412",
"created_at": "2026-09-14T11:10:00+03:00",
"updated_at": "2026-09-14T12:25:00+03:00",
"deleted_at": null
}
],
"next_cursor": "eyJ1IjoiMjAyNi0wOS0xNFQxMjoyNTowMCswMzowMCIsImlkIjoiNTUyMDk4NyJ9",
"has_more": true
}GET
/documents/{document_id}Path parameters
Query parameters
Responses
200The document.
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Israeli invoice allocation number. Mandatory for amounts above 5,000 ILS.
Show 14 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
What the buyer has done with the document, such as receiving, disputing or exporting it.
Possible values
pendingreceivedreceived_with_differencesdisputedapproved_for_exportexported404The resource does not exist or belongs to another account.
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/documents/5520931?expand=lines,files,history" \
-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/documents/5520931?expand=lines,files,history", {
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/documents/5520931?expand=lines,files,history",
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/documents/5520931?expand=lines,files,history");
var data = await res.Content.ReadAsStringAsync();{
"id": "5520931",
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"accounting_period": "2026-09",
"due_date": null,
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"buyer": {
"id": "71148",
"name": "שניצי קפה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": "FC",
"source": "purchase",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"allocation_number": null,
"lines": [
{
"id": "dl1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "80.00",
"order_id": "2335619",
"order_line_id": "l1",
"quantity_received": "1",
"purchase_type": "FC",
"expense_account": "5100"
},
{
"id": "dl2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "416.40",
"order_id": "2335619",
"order_line_id": "l2",
"quantity_received": "10",
"purchase_type": "FC",
"expense_account": "5100"
}
],
"buyer_status": "received_with_differences",
"differences": [
{
"line_id": "dl2",
"sku": "412",
"field": "quantity",
"issued": "12",
"received": "10",
"note": "התקבלו 10 קרטונים מתוך 12"
}
],
"export_status": "not_ready",
"exported_at": null,
"files": [
{
"id": "file_01J9KR0A6T",
"name": "tm-2026-4471.pdf",
"content_type": "application/pdf",
"size_bytes": 184320,
"download_url": "https://files.zester.co.il/d/file_01J9KR0A6T?expires=1789369200&sig=demo"
}
],
"external_ref": "SO-88412",
"created_at": "2026-09-14T06:06:00+03:00",
"updated_at": "2026-09-14T07:42:00+03:00",
"deleted_at": null,
"history": [
{
"at": "2026-09-14T06:06:00+03:00",
"action": "created",
"actor": {
"type": "api_client",
"id": "cl_01J9KQ7X4M",
"name": "ERP מאפייה אחת עשרה"
},
"changes": {
"buyer_status": {
"from": null,
"to": "pending"
}
}
},
{
"at": "2026-09-14T07:42:00+03:00",
"action": "received",
"actor": {
"type": "user",
"id": "usr_5531",
"name": "דנה לוי"
},
"changes": {
"buyer_status": {
"from": "pending",
"to": "received_with_differences"
},
"lines[1].quantity_received": {
"from": null,
"to": "10"
}
}
}
]
}{
"type": "https://developers.zester.co.il/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "Document 5520931 does not exist or belongs to another account.",
"request_id": "req_01J9KV0B6Y"
}