Orders
Orders that buyers place with your supplier account. List and retrieve them, then confirm, reject, schedule or acknowledge each one.
The Order object
Attributes
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"
}
}
}
]
}/supplier/ordersList the orders that buyers send to your supplier account. By default, orders in every status are returned. Set status to pending_approval to fetch only orders awaiting approval, or use updated_since for incremental polling.
Query 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.
draftpending_approvalapprovedpartially_approvedrejectedcancelledcancelled_after_approvalwaiting_to_sendResponses
200A page of orders.
Show 22 child attributesHide child attributes
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.
401The API key or token is missing, invalid, expired or revoked. The code is unauthorized, key_expired or key_revoked.
Headers: X-Request-Id
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.
429The rate limit was exceeded. Retry after the number of seconds given in Retry-After.
Headers: Retry-After RateLimit-Limit RateLimit-Remaining RateLimit-Reset
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders?status=pending_approval&updated_since=2026-09-11T08:00:00%2B03:00&limit=50" \
-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/supplier/orders?status=pending_approval&updated_since=2026-09-11T08:00:00%2B03:00&limit=50", {
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/supplier/orders?status=pending_approval&updated_since=2026-09-11T08:00:00%2B03:00&limit=50",
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/supplier/orders?status=pending_approval&updated_since=2026-09-11T08:00:00%2B03:00&limit=50");
var data = await res.Content.ReadAsStringAsync();{
"data": [
{
"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
},
{
"id": "2335644",
"number": "71202-213",
"status": "pending_approval",
"buyer": {
"id": "71202",
"name": "ביסטרו הנמל",
"customer_number": "777080114"
},
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"branch": {
"id": "71202-1",
"name": "ביסטרו הנמל – ראשי",
"tax_id": "000000000"
},
"purchase_type": null,
"sent_at": "2026-09-11T08:24:00+03:00",
"delivery_date": "2026-09-14",
"delivery_window": {
"from": "07:00",
"to": "10:00"
},
"currency": "ILS",
"totals": {
"before_vat": "313.10",
"vat": "56.36",
"with_vat": "369.46"
},
"lines": [
{
"id": "l1",
"sku": "604",
"name": "לחם שיפון פרוס",
"quantity": "6.500",
"unit": "kg",
"package_quantity": "1",
"unit_price": "18.40",
"discount_pct": null,
"vat_exempt": false,
"total": "119.60",
"quantity_confirmed": null,
"substitute_sku": null
},
{
"id": "l2",
"sku": "518",
"name": "קרואסון חמאה",
"quantity": "30",
"unit": "unit",
"package_quantity": "1",
"unit_price": "6.45",
"discount_pct": null,
"vat_exempt": false,
"total": "193.50",
"quantity_confirmed": null,
"substitute_sku": null
}
],
"notes": null,
"external_ref": null,
"acknowledged_at": null,
"related_document_ids": [],
"files": [],
"created_at": "2026-09-11T08:19:47+03:00",
"updated_at": "2026-09-11T08:24:00+03:00",
"deleted_at": null
}
],
"next_cursor": null,
"has_more": false
}{
"type": "https://developers.zester.co.il/errors/key_revoked",
"title": "API key revoked",
"status": 401,
"code": "key_revoked",
"detail": "The key zk_test_XXXXXXXX was revoked on 2026-09-01. Create a new key in Settings → Developers.",
"instance": "/v2/supplier/orders",
"request_id": "req_01J9KQDS2W"
}{
"type": "https://developers.zester.co.il/errors/scope_missing",
"title": "Scope missing",
"status": 403,
"code": "scope_missing",
"detail": "Client cl_01J9KQ7X4M does not have the supplier.orders:read scope.",
"instance": "/v2/supplier/orders",
"request_id": "req_01J9KQDT5X"
}{
"type": "https://developers.zester.co.il/errors/rate_limited",
"title": "Too many requests",
"status": 429,
"code": "rate_limited",
"detail": "Client cl_01J9KQ7X4M exceeded 1200 requests per minute. Poll every 60 seconds or subscribe to the order.created webhook. Retry after 21 seconds.",
"instance": "/v2/supplier/orders",
"request_id": "req_01J9KQDV7Y"
}/supplier/orders/{order_id}Path parameters
Query parameters
Responses
200The order.
Headers: ETag
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/supplier/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/supplier/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/supplier/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/supplier/orders/2335619?expand=history");
var data = await res.Content.ReadAsStringAsync();{
"id": "2335619",
"number": "71148-80",
"status": "partially_approved",
"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:30",
"to": "08: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": "1",
"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": "10",
"substitute_sku": null
}
],
"notes": "נא לפרוק ליד דלת השירות, הכניסה מהחניה האחורית.",
"external_ref": "SO-88412",
"acknowledged_at": "2026-09-11T09:41:05+03:00",
"related_document_ids": [],
"files": [],
"created_at": "2026-09-11T08:02:31+03:00",
"updated_at": "2026-09-11T09:41:05+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"
}
}
},
{
"at": "2026-09-11T09:40:12+03:00",
"action": "confirmed",
"actor": {
"type": "api_client",
"id": "cl_01J9KQ7X4M",
"name": "ERP פריוריטי"
},
"changes": {
"status": {
"from": "pending_approval",
"to": "partially_approved"
},
"lines.l2.quantity_confirmed": {
"from": null,
"to": "10"
},
"reason": "חוסר במלאי, 2 הקרטונים הנותרים יסופקו ביום שלישי"
}
},
{
"at": "2026-09-11T09:40:31+03:00",
"action": "scheduled",
"actor": {
"type": "api_client",
"id": "cl_01J9KQ7X4M",
"name": "ERP פריוריטי"
},
"changes": {
"delivery_window": {
"from": {
"from": "06:00",
"to": "09:00"
},
"to": {
"from": "06:30",
"to": "08:00"
}
}
}
},
{
"at": "2026-09-11T09:41:05+03:00",
"action": "acknowledged",
"actor": {
"type": "api_client",
"id": "cl_01J9KQ7X4M",
"name": "ERP פריוריטי"
},
"changes": {
"external_ref": {
"from": null,
"to": "SO-88412"
}
}
}
]
}{
"type": "https://developers.zester.co.il/errors/not_found",
"title": "Order not found",
"status": 404,
"code": "not_found",
"detail": "Order 2335619 does not exist or was not sent to supplier 72223.",
"instance": "/v2/supplier/orders/2335619",
"request_id": "req_01J9KQEW3Z"
}/supplier/orders/{order_id}/confirmConfirm an order in full or with line changes. An empty body confirms the whole order. Send lines to confirm part of the order, substitute items, or adjust prices if the buyer allows it.
Path parameters
Headers
Request body application/json
Confirmation details for the order. An empty object confirms the whole order.
Lines that differ from the order. You need to send only those lines.
Show 5 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Responses
200The order after confirmation.
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.
409The request conflicts with the current state. The code is conflict, or idempotency_conflict when an Idempotency-Key is reused with a different body.
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/supplier/orders/2335619/confirm" \
-H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: confirm-2335619" \
-d '{
"note": "חסרים 2 קרטונים של לחמניית חיטה מלאה, יסופקו ביום שלישי.",
"lines": [
{
"id": "l2",
"quantity_confirmed": "10",
"reason": "חוסר במלאי, 2 הקרטונים הנותרים יסופקו ביום שלישי"
}
]
}'const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/confirm", {
method: "POST",
headers: {
Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Content-Type": "application/json",
"Idempotency-Key": "confirm-2335619",
},
body: JSON.stringify({
"note": "חסרים 2 קרטונים של לחמניית חיטה מלאה, יסופקו ביום שלישי.",
"lines": [
{
"id": "l2",
"quantity_confirmed": "10",
"reason": "חוסר במלאי, 2 הקרטונים הנותרים יסופקו ביום שלישי"
}
]
}),
});
const data = await res.json();import requests
res = requests.post(
"https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/confirm",
headers={
"Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Idempotency-Key": "confirm-2335619",
},
json={
"note": "חסרים 2 קרטונים של לחמניית חיטה מלאה, יסופקו ביום שלישי.",
"lines": [
{
"id": "l2",
"quantity_confirmed": "10",
"reason": "חוסר במלאי, 2 הקרטונים הנותרים יסופקו ביום שלישי"
}
]
},
)
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", "confirm-2335619");
var body = new StringContent("""
{
"note": "חסרים 2 קרטונים של לחמניית חיטה מלאה, יסופקו ביום שלישי.",
"lines": [
{
"id": "l2",
"quantity_confirmed": "10",
"reason": "חוסר במלאי, 2 הקרטונים הנותרים יסופקו ביום שלישי"
}
]
}
""", Encoding.UTF8, "application/json");
var res = await http.PostAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/confirm", body);
var data = await res.Content.ReadAsStringAsync();{
"id": "2335619",
"number": "71148-80",
"status": "partially_approved",
"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": "1",
"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": "10",
"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-11T09:40:12+03:00",
"deleted_at": null
}{
"type": "https://developers.zester.co.il/errors/not_found",
"title": "Order not found",
"status": 404,
"code": "not_found",
"detail": "Order 2335619 does not exist or was not sent to supplier 72223.",
"instance": "/v2/supplier/orders/2335619/confirm",
"request_id": "req_01J9KQFX5A"
}{
"type": "https://developers.zester.co.il/errors/conflict",
"title": "Order cannot be confirmed",
"status": 409,
"code": "conflict",
"detail": "Order 2335619 was cancelled by the buyer and cannot be confirmed.",
"instance": "/v2/supplier/orders/2335619/confirm",
"request_id": "req_01J9KQFY8B"
}{
"type": "https://developers.zester.co.il/errors/validation_error",
"title": "Validation failed",
"status": 422,
"code": "validation_error",
"detail": "1 field is invalid",
"instance": "/v2/supplier/orders/2335619/confirm",
"request_id": "req_01J9KQFZ2C",
"errors": [
{
"field": "lines[0].quantity_confirmed",
"code": "exceeds_ordered_quantity",
"message": "Confirmed quantity cannot be greater than the ordered quantity (12)"
}
]
}/supplier/orders/{order_id}/rejectPath parameters
Headers
Request body application/json
Responses
200The order after rejection.
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.
409The request conflicts with the current state. The code is conflict, or idempotency_conflict when an Idempotency-Key is reused with a different body.
curl -X POST "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/reject" \
-H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: reject-2335619" \
-d '{
"reason": "תנור הלחמניות בתיקון ולא נוכל לספק את ההזמנה ליום שני 14/09. נא להזמין מחדש לאספקה ביום שלישי 15/09."
}'const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/reject", {
method: "POST",
headers: {
Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Content-Type": "application/json",
"Idempotency-Key": "reject-2335619",
},
body: JSON.stringify({
"reason": "תנור הלחמניות בתיקון ולא נוכל לספק את ההזמנה ליום שני 14/09. נא להזמין מחדש לאספקה ביום שלישי 15/09."
}),
});
const data = await res.json();import requests
res = requests.post(
"https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/reject",
headers={
"Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Idempotency-Key": "reject-2335619",
},
json={
"reason": "תנור הלחמניות בתיקון ולא נוכל לספק את ההזמנה ליום שני 14/09. נא להזמין מחדש לאספקה ביום שלישי 15/09."
},
)
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", "reject-2335619");
var body = new StringContent("""
{
"reason": "תנור הלחמניות בתיקון ולא נוכל לספק את ההזמנה ליום שני 14/09. נא להזמין מחדש לאספקה ביום שלישי 15/09."
}
""", Encoding.UTF8, "application/json");
var res = await http.PostAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/reject", body);
var data = await res.Content.ReadAsStringAsync();{
"id": "2335619",
"number": "71148-80",
"status": "rejected",
"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-11T09:22:48+03:00",
"deleted_at": null
}{
"type": "https://developers.zester.co.il/errors/not_found",
"title": "Order not found",
"status": 404,
"code": "not_found",
"detail": "Order 2335619 does not exist or was not sent to supplier 72223.",
"instance": "/v2/supplier/orders/2335619/reject",
"request_id": "req_01J9KQGA4D"
}{
"type": "https://developers.zester.co.il/errors/conflict",
"title": "Order cannot be rejected",
"status": 409,
"code": "conflict",
"detail": "Order 2335619 was already partially approved on 2026-09-11 at 09:40 and can no longer be rejected.",
"instance": "/v2/supplier/orders/2335619/reject",
"request_id": "req_01J9KQGB6E"
}/supplier/orders/{order_id}/schedulePath parameters
Request body application/json
Responses
200The order with its new delivery date and window.
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.
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/supplier/orders/2335619/schedule" \
-H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…" \
-H "Content-Type: application/json" \
-d '{
"delivery_date": "2026-09-14",
"delivery_window": {
"from": "06:30",
"to": "08:00"
}
}'const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/schedule", {
method: "POST",
headers: {
Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Content-Type": "application/json",
},
body: JSON.stringify({
"delivery_date": "2026-09-14",
"delivery_window": {
"from": "06:30",
"to": "08:00"
}
}),
});
const data = await res.json();import requests
res = requests.post(
"https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/schedule",
headers={
"Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
},
json={
"delivery_date": "2026-09-14",
"delivery_window": {
"from": "06:30",
"to": "08:00"
}
},
)
data = res.json()using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", "zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…");
var body = new StringContent("""
{
"delivery_date": "2026-09-14",
"delivery_window": {
"from": "06:30",
"to": "08:00"
}
}
""", Encoding.UTF8, "application/json");
var res = await http.PostAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/schedule", body);
var data = await res.Content.ReadAsStringAsync();{
"id": "2335619",
"number": "71148-80",
"status": "partially_approved",
"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:30",
"to": "08: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": "1",
"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": "10",
"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-11T09:40:31+03:00",
"deleted_at": null
}{
"type": "https://developers.zester.co.il/errors/not_found",
"title": "Order not found",
"status": 404,
"code": "not_found",
"detail": "Order 2335619 does not exist or was not sent to supplier 72223.",
"instance": "/v2/supplier/orders/2335619/schedule",
"request_id": "req_01J9KQHC8F"
}{
"type": "https://developers.zester.co.il/errors/validation_error",
"title": "Validation failed",
"status": 422,
"code": "validation_error",
"detail": "1 field is invalid",
"instance": "/v2/supplier/orders/2335619/schedule",
"request_id": "req_01J9KQHD2G",
"errors": [
{
"field": "delivery_date",
"code": "not_a_delivery_day",
"message": "Branch 71148-1 does not receive deliveries on Saturday"
}
]
}/supplier/orders/{order_id}/acknowledgeMark the order as received in your ERP. Send your ERP sales order number as external_ref to show it to the buyer.
Path parameters
Request body application/json
Responses
200The order after acknowledgment.
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 -X POST "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/acknowledge" \
-H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…" \
-H "Content-Type: application/json" \
-d '{
"external_ref": "SO-88412"
}'const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/acknowledge", {
method: "POST",
headers: {
Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Content-Type": "application/json",
},
body: JSON.stringify({
"external_ref": "SO-88412"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/acknowledge",
headers={
"Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
},
json={
"external_ref": "SO-88412"
},
)
data = res.json()using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", "zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…");
var body = new StringContent("""
{
"external_ref": "SO-88412"
}
""", Encoding.UTF8, "application/json");
var res = await http.PostAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/orders/2335619/acknowledge", body);
var data = await res.Content.ReadAsStringAsync();{
"id": "2335619",
"number": "71148-80",
"status": "partially_approved",
"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:30",
"to": "08: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": "1",
"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": "10",
"substitute_sku": null
}
],
"notes": "נא לפרוק ליד דלת השירות, הכניסה מהחניה האחורית.",
"external_ref": "SO-88412",
"acknowledged_at": "2026-09-11T09:41:05+03:00",
"related_document_ids": [],
"files": [],
"created_at": "2026-09-11T08:02:31+03:00",
"updated_at": "2026-09-11T09:41:05+03:00",
"deleted_at": null
}{
"type": "https://developers.zester.co.il/errors/not_found",
"title": "Order not found",
"status": 404,
"code": "not_found",
"detail": "Order 2335619 does not exist or was not sent to supplier 72223.",
"instance": "/v2/supplier/orders/2335619/acknowledge",
"request_id": "req_01J9KQJE4H"
}