{ "info": { "name": "Zestt API v2", "description": "Integrate suppliers, buyers, accounting systems and BI tools with Zestt.\n\nSet the apiKey collection variable to a sandbox key (zk_test_…). Docs: https://docs.zestt.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "version": "2.0.0-draft.1" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://sandbox-api.zester.co.il/v2" }, { "key": "apiKey", "value": "zk_test_XXXXXXXX" } ], "item": [ { "name": "Getting started", "item": [ { "name": "Auth", "description": "Exchange an API key for a short-lived access token. This step is optional: the API also accepts the API key directly as a Bearer token.", "item": [ { "name": "Create an access token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/oauth/token", "host": [ "{{baseUrl}}" ], "path": [ "oauth", "token" ], "query": [], "variable": [] }, "description": "Exchange an API key for a JWT that is valid for 60 minutes and carries the client's scopes, using the OAuth 2.0 `client_credentials` grant. Send the API client ID as `client_id` and the API key (`zk_live_…` or `zk_test_…`) as `client_secret`, in either `application/x-www-form-urlencoded` (RFC 6749) or `application/json`. This step is optional: the API also accepts the API key directly as a Bearer token.\n\nDocs: https://docs.zestt.io/reference/auth#createAccessToken", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"cl_01J9KQ7X4M\",\n \"client_secret\": \"zk_test_XXXXXXXX_…\",\n \"scope\": \"supplier.orders:read supplier.orders:write supplier.documents:write\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Account", "description": "The account, API client, plan, scopes and limits behind the credential that makes a request. Call `GET /me` first to confirm what your integration can do.", "item": [ { "name": "Retrieve the authenticated client", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/me", "host": [ "{{baseUrl}}" ], "path": [ "me" ], "query": [], "variable": [] }, "description": "Retrieve the account, account type, plan, effective scopes, branch restriction, rate limits and enabled features for the credential that makes the request. Make this the first call of every integration, and include its output when you contact support.\n\nDocs: https://docs.zestt.io/reference/account#getMe" } } ] } ] }, { "name": "Supplier API", "item": [ { "name": "Buyers", "description": "Buyers linked to your supplier account. List and retrieve them, set your customer number and ERP reference for each, and invite new buyers to Zestt.", "item": [ { "name": "List linked buyers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/supplier/buyers?limit=100&updated_since=2026-09-01T00:00:00+03:00", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "buyers" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "100", "disabled": false }, { "key": "updated_since", "value": "2026-09-01T00:00:00+03:00", "disabled": false } ], "variable": [] }, "description": "Docs: https://docs.zestt.io/reference/supplier-buyers#listSupplierBuyers" } }, { "name": "Retrieve a linked buyer", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/supplier/buyers/:buyer_id", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "buyers", ":buyer_id" ], "query": [], "variable": [ { "key": "buyer_id", "value": "71148" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-buyers#getSupplierBuyer" } }, { "name": "Update a linked buyer", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "If-Match", "value": "\"b71148-v7\"", "disabled": false } ], "url": { "raw": "{{baseUrl}}/supplier/buyers/:buyer_id", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "buyers", ":buyer_id" ], "query": [], "variable": [ { "key": "buyer_id", "value": "71148" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-buyers#updateSupplierBuyer", "body": { "mode": "raw", "raw": "{\n \"customer_number\": \"777077070\",\n \"erp_ref\": \"PRI-C-10482\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Invite a buyer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "invite-777081230", "disabled": false } ], "url": { "raw": "{{baseUrl}}/supplier/buyer-invitations", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "buyer-invitations" ], "query": [], "variable": [] }, "description": "Invite a new buyer to Zestt. This does not create a user. The response includes an onboarding link.\n\nDocs: https://docs.zestt.io/reference/supplier-buyers#createBuyerInvitation", "body": { "mode": "raw", "raw": "{\n \"business_name\": \"קפה הגפן\",\n \"tax_id\": \"000000000\",\n \"contact_name\": \"מיכל לוי\",\n \"contact_email\": \"orders@cafe-hagefen.example\",\n \"contact_phone\": \"050-0000000\",\n \"customer_number\": \"777081230\",\n \"price_list_id\": \"pl_1\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Orders", "description": "Orders that buyers place with your supplier account. List and retrieve them, then confirm, reject, schedule or acknowledge each one.", "item": [ { "name": "List orders", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/supplier/orders?limit=50&updated_since=2026-09-11T08:00:00+03:00&status=pending_approval", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "orders" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "50", "disabled": false }, { "key": "updated_since", "value": "2026-09-11T08:00:00+03:00", "disabled": false }, { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true }, { "key": "status", "value": "pending_approval", "disabled": false }, { "key": "buyer_id", "value": "", "disabled": true }, { "key": "expand", "value": "", "disabled": true } ], "variable": [] }, "description": "List 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.\n\nDocs: https://docs.zestt.io/reference/supplier-orders#listSupplierOrders" } }, { "name": "Retrieve an order", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/supplier/orders/:order_id?expand=history", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "orders", ":order_id" ], "query": [ { "key": "expand", "value": "history", "disabled": false } ], "variable": [ { "key": "order_id", "value": "2335619" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-orders#getSupplierOrder" } }, { "name": "Confirm an order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "confirm-2335619", "disabled": false } ], "url": { "raw": "{{baseUrl}}/supplier/orders/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "orders", ":order_id", "confirm" ], "query": [], "variable": [ { "key": "order_id", "value": "2335619" } ] }, "description": "Confirm 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.\n\nDocs: https://docs.zestt.io/reference/supplier-orders#confirmSupplierOrder", "body": { "mode": "raw", "raw": "{\n \"note\": \"חסרים 2 קרטונים של לחמניית חיטה מלאה, יסופקו ביום שלישי.\",\n \"lines\": [\n {\n \"id\": \"l2\",\n \"quantity_confirmed\": \"10\",\n \"reason\": \"חוסר במלאי, 2 הקרטונים הנותרים יסופקו ביום שלישי\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject an order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "reject-2335619", "disabled": false } ], "url": { "raw": "{{baseUrl}}/supplier/orders/:order_id/reject", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "orders", ":order_id", "reject" ], "query": [], "variable": [ { "key": "order_id", "value": "2335619" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-orders#rejectSupplierOrder", "body": { "mode": "raw", "raw": "{\n \"reason\": \"תנור הלחמניות בתיקון ולא נוכל לספק את ההזמנה ליום שני 14/09. נא להזמין מחדש לאספקה ביום שלישי 15/09.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Schedule a delivery", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/supplier/orders/:order_id/schedule", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "orders", ":order_id", "schedule" ], "query": [], "variable": [ { "key": "order_id", "value": "2335619" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-orders#scheduleSupplierOrder", "body": { "mode": "raw", "raw": "{\n \"delivery_date\": \"2026-09-14\",\n \"delivery_window\": {\n \"from\": \"06:30\",\n \"to\": \"08:00\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Acknowledge an order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/supplier/orders/:order_id/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "orders", ":order_id", "acknowledge" ], "query": [], "variable": [ { "key": "order_id", "value": "2335619" } ] }, "description": "Mark the order as received in your ERP. Send your ERP sales order number as `external_ref` to show it to the buyer.\n\nDocs: https://docs.zestt.io/reference/supplier-orders#acknowledgeSupplierOrder", "body": { "mode": "raw", "raw": "{\n \"external_ref\": \"SO-88412\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Documents", "description": "Delivery notes, invoices, credit notes and consolidated invoices that you issue to buyers. Create them one at a time or in bulk, and see what each buyer actually received.", "item": [ { "name": "List issued documents", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/supplier/documents?limit=50&updated_since=2026-09-14T00:00:00+03:00&type=delivery_note&buyer_status=received_with_differences&expand=lines", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "documents" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "50", "disabled": false }, { "key": "updated_since", "value": "2026-09-14T00:00:00+03:00", "disabled": false }, { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true }, { "key": "type", "value": "delivery_note", "disabled": false }, { "key": "buyer_status", "value": "received_with_differences", "disabled": false }, { "key": "expand", "value": "lines", "disabled": false } ], "variable": [] }, "description": "Docs: https://docs.zestt.io/reference/supplier-documents#listSupplierDocuments" } }, { "name": "Create a document", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "tm-2026-4471", "disabled": false } ], "url": { "raw": "{{baseUrl}}/supplier/documents", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "documents" ], "query": [], "variable": [] }, "description": "Create a delivery note, invoice, credit note or consolidated invoice. Upload attachments first with `POST /files` and reference them in `file_ids`. The `Idempotency-Key` header is required: use the document number as its value.\n\nDocs: https://docs.zestt.io/reference/supplier-documents#createSupplierDocument", "body": { "mode": "raw", "raw": "{\n \"type\": \"delivery_note\",\n \"number\": \"4471\",\n \"date\": \"2026-09-14\",\n \"buyer_id\": \"71148\",\n \"branch_id\": \"71148-1\",\n \"order_ids\": [\n \"2335619\"\n ],\n \"currency\": \"ILS\",\n \"totals\": {\n \"before_vat\": \"496.40\",\n \"vat\": \"89.35\",\n \"with_vat\": \"585.75\"\n },\n \"lines\": [\n {\n \"sku\": \"300\",\n \"name\": \"בייבי ג׳בטה לבן\",\n \"quantity\": \"1\",\n \"unit\": \"carton\",\n \"unit_price\": \"80.00\",\n \"vat_exempt\": false,\n \"order_id\": \"2335619\",\n \"order_line_id\": \"l1\"\n },\n {\n \"sku\": \"412\",\n \"name\": \"לחמניית חיטה מלאה\",\n \"quantity\": \"12\",\n \"unit\": \"carton\",\n \"unit_price\": \"34.70\",\n \"vat_exempt\": false,\n \"order_id\": \"2335619\",\n \"order_line_id\": \"l2\"\n }\n ],\n \"file_ids\": [\n \"file_01J9KQ7X4M\"\n ],\n \"external_ref\": \"DN-2026-4471\",\n \"notes\": \"לפרוק בכניסה האחורית עד 07:00\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create documents in bulk", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "tm-batch-2026-09-14", "disabled": false } ], "url": { "raw": "{{baseUrl}}/supplier/documents/batch", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "documents", "batch" ], "query": [], "variable": [] }, "description": "Create up to 500 documents in one request. The response reports a result for each item, and the request returns 422 only when every item fails.\n\nDocs: https://docs.zestt.io/reference/supplier-documents#createSupplierDocumentsBatch", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"type\": \"delivery_note\",\n \"number\": \"4471\",\n \"date\": \"2026-09-14\",\n \"buyer_id\": \"71148\",\n \"branch_id\": \"71148-1\",\n \"order_ids\": [\n \"2335619\"\n ],\n \"currency\": \"ILS\",\n \"totals\": {\n \"before_vat\": \"496.40\",\n \"vat\": \"89.35\",\n \"with_vat\": \"585.75\"\n },\n \"lines\": [\n {\n \"sku\": \"300\",\n \"name\": \"בייבי ג׳בטה לבן\",\n \"quantity\": \"1\",\n \"unit\": \"carton\",\n \"unit_price\": \"80.00\",\n \"vat_exempt\": false,\n \"order_id\": \"2335619\",\n \"order_line_id\": \"l1\"\n },\n {\n \"sku\": \"412\",\n \"name\": \"לחמניית חיטה מלאה\",\n \"quantity\": \"12\",\n \"unit\": \"carton\",\n \"unit_price\": \"34.70\",\n \"vat_exempt\": false,\n \"order_id\": \"2335619\",\n \"order_line_id\": \"l2\"\n }\n ],\n \"file_ids\": [\n \"file_01J9KQ7X4M\"\n ],\n \"external_ref\": \"DN-2026-4471\"\n },\n {\n \"type\": \"invoice\",\n \"number\": \"INV-2026-1188\",\n \"date\": \"2026-09-14\",\n \"due_date\": \"2026-10-30\",\n \"buyer_id\": \"71202\",\n \"branch_id\": \"71202-1\",\n \"currency\": \"ILS\",\n \"totals\": {\n \"before_vat\": \"5610.00\",\n \"vat\": \"1009.80\",\n \"with_vat\": \"6619.80\"\n },\n \"lines\": [\n {\n \"sku\": \"518\",\n \"name\": \"קרואסון חמאה\",\n \"quantity\": \"45\",\n \"unit\": \"carton\",\n \"unit_price\": \"96.00\",\n \"vat_exempt\": false\n },\n {\n \"sku\": \"604\",\n \"name\": \"לחם שיפון פרוס\",\n \"quantity\": \"100\",\n \"unit\": \"unit\",\n \"unit_price\": \"12.90\",\n \"vat_exempt\": false\n }\n ],\n \"external_ref\": \"AR-2026-1188\",\n \"notes\": \"אספקה לאירוע סוף הקיץ, תנאי תשלום שוטף + 30\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve an issued document", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/supplier/documents/:document_id?expand=lines,files,history", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "documents", ":document_id" ], "query": [ { "key": "expand", "value": "lines,files,history", "disabled": false } ], "variable": [ { "key": "document_id", "value": "5520931" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-documents#getSupplierDocument" } } ] }, { "name": "Catalog", "description": "Your product catalog, product availability and price lists. Create, update and remove products, set availability, and manage prices and the buyers assigned to each price list.", "item": [ { "name": "Create or update a product", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/supplier/products/:sku", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "products", ":sku" ], "query": [], "variable": [ { "key": "sku", "value": "412" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-catalog#upsertSupplierProduct", "body": { "mode": "raw", "raw": "{\n \"name\": \"לחמניית חיטה מלאה\",\n \"unit\": \"carton\",\n \"package_quantity\": \"24\",\n \"category\": \"לחמניות\",\n \"barcode\": \"7290000000412\",\n \"vat_exempt\": false,\n \"image_file_id\": \"file_01J9KR6F3S\",\n \"external_ref\": \"ITM-412\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a product", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/supplier/products/:sku", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "products", ":sku" ], "query": [], "variable": [ { "key": "sku", "value": "604" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-catalog#deleteSupplierProduct" } }, { "name": "Create or update products in bulk", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/supplier/products/batch", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "products", "batch" ], "query": [], "variable": [] }, "description": "Docs: https://docs.zestt.io/reference/supplier-catalog#upsertSupplierProductsBatch", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"sku\": \"518\",\n \"name\": \"קרואסון חמאה\",\n \"unit\": \"carton\",\n \"package_quantity\": \"40\",\n \"category\": \"מאפים\",\n \"barcode\": \"7290000000518\",\n \"vat_exempt\": false,\n \"external_ref\": \"ITM-518\"\n },\n {\n \"sku\": \"604\",\n \"name\": \"לחם שיפון פרוס\",\n \"unit\": \"unit\",\n \"package_quantity\": \"1\",\n \"category\": \"לחמים\",\n \"barcode\": \"7290000000604\",\n \"vat_exempt\": false,\n \"image_file_id\": \"file_01J9KR8W3N\",\n \"external_ref\": \"ITM-604\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update product availability", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/supplier/products/:sku/availability", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "products", ":sku", "availability" ], "query": [], "variable": [ { "key": "sku", "value": "518" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-catalog#setSupplierProductAvailability", "body": { "mode": "raw", "raw": "{\n \"available\": false,\n \"until\": \"2026-09-20\",\n \"reason\": \"מחסור זמני בחמאה\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List price lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/supplier/price-lists?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "price-lists" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "50", "disabled": false } ], "variable": [] }, "description": "Docs: https://docs.zestt.io/reference/supplier-catalog#listSupplierPriceLists" } }, { "name": "Create or update prices in bulk", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/supplier/price-lists/:price_list_id/prices", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "price-lists", ":price_list_id", "prices" ], "query": [], "variable": [ { "key": "price_list_id", "value": "pl_1" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-catalog#upsertSupplierPrices", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"sku\": \"412\",\n \"price\": \"33.90\",\n \"min_quantity\": \"20\",\n \"valid_from\": \"2026-10-01\"\n },\n {\n \"sku\": \"518\",\n \"price\": \"0.00\",\n \"valid_from\": \"2026-10-01\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Assign a price list to a buyer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/supplier/price-lists/:price_list_id/buyers", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "price-lists", ":price_list_id", "buyers" ], "query": [], "variable": [ { "key": "price_list_id", "value": "pl_1" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-catalog#assignPriceListToBuyer", "body": { "mode": "raw", "raw": "{\n \"buyer_id\": \"71202\",\n \"valid_from\": \"2026-10-01\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a price list from a buyer", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/supplier/price-lists/:price_list_id/buyers/:buyer_id", "host": [ "{{baseUrl}}" ], "path": [ "supplier", "price-lists", ":price_list_id", "buyers", ":buyer_id" ], "query": [], "variable": [ { "key": "price_list_id", "value": "pl_1" }, { "key": "buyer_id", "value": "71202" } ] }, "description": "Docs: https://docs.zestt.io/reference/supplier-catalog#unassignPriceListFromBuyer" } } ] } ] }, { "name": "Buyer API", "item": [ { "name": "Reference", "description": "Read-only reference data for a buyer account: branches, purchase types, suppliers, catalog products, expense categories, expense accounts and account mappings.", "item": [ { "name": "[Soon] List branches", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/branches?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "branches" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "50", "disabled": false } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-reference#listBranches" } }, { "name": "[Soon] List purchase types", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/purchase-types", "host": [ "{{baseUrl}}" ], "path": [ "purchase-types" ], "query": [], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-reference#listPurchaseTypes" } }, { "name": "[Soon] List suppliers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/suppliers?limit=200&updated_since=2026-09-01T00:00:00+03:00", "host": [ "{{baseUrl}}" ], "path": [ "suppliers" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "200", "disabled": false }, { "key": "updated_since", "value": "2026-09-01T00:00:00+03:00", "disabled": false }, { "key": "vendor_type", "value": "", "disabled": true } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-reference#listSuppliers" } }, { "name": "[Soon] Retrieve a supplier", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/suppliers/:supplier_id", "host": [ "{{baseUrl}}" ], "path": [ "suppliers", ":supplier_id" ], "query": [], "variable": [ { "key": "supplier_id", "value": "72223" } ] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-reference#getSupplier" } }, { "name": "[Soon] List catalog products", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/products?limit=200&updated_since=2026-09-01T00:00:00+03:00", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "200", "disabled": false }, { "key": "updated_since", "value": "2026-09-01T00:00:00+03:00", "disabled": false }, { "key": "supplier_id", "value": "", "disabled": true }, { "key": "product_group", "value": "", "disabled": true } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-reference#listBuyerProducts" } }, { "name": "[Soon] List expense categories", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/expense-categories", "host": [ "{{baseUrl}}" ], "path": [ "expense-categories" ], "query": [], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-reference#listExpenseCategories" } }, { "name": "[Soon] List expense accounts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/expense-accounts", "host": [ "{{baseUrl}}" ], "path": [ "expense-accounts" ], "query": [], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-reference#listExpenseAccounts" } }, { "name": "[Soon] List account mappings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/account-mappings", "host": [ "{{baseUrl}}" ], "path": [ "account-mappings" ], "query": [], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-reference#listAccountMappings" } } ] }, { "name": "Purchases", "description": "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.", "item": [ { "name": "[Soon] List orders across all suppliers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders?limit=200&updated_since=2026-09-13T00:00:00+03:00", "host": [ "{{baseUrl}}" ], "path": [ "orders" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "200", "disabled": false }, { "key": "updated_since", "value": "2026-09-13T00:00:00+03:00", "disabled": false }, { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true }, { "key": "branch_id", "value": "", "disabled": true }, { "key": "supplier_id", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "expand", "value": "", "disabled": true } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-purchases#listOrders" } }, { "name": "[Soon] Create an order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "PO-2026-0917", "disabled": false } ], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ], "query": [], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-purchases#createOrder", "body": { "mode": "raw", "raw": "{\n \"supplier_id\": \"72223\",\n \"branch_id\": \"71148-2\",\n \"purchase_type\": \"FC\",\n \"delivery_date\": \"2026-09-15\",\n \"notes\": \"הזמנה מה-ERP של הרשת\",\n \"external_ref\": \"PO-2026-0917\",\n \"lines\": [\n {\n \"sku\": \"300\",\n \"quantity\": \"2\"\n },\n {\n \"sku\": \"412\",\n \"quantity\": \"1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "[Soon] Retrieve an order", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:order_id?expand=history", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id" ], "query": [ { "key": "expand", "value": "history", "disabled": false } ], "variable": [ { "key": "order_id", "value": "2335619" } ] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-purchases#getOrder" } }, { "name": "[Soon] List purchase documents", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents?limit=200&updated_since=2026-09-14T00:00:00+03:00&type=delivery_note,invoice&expand=lines", "host": [ "{{baseUrl}}" ], "path": [ "documents" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "200", "disabled": false }, { "key": "updated_since", "value": "2026-09-14T00:00:00+03:00", "disabled": false }, { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true }, { "key": "branch_id", "value": "", "disabled": true }, { "key": "supplier_id", "value": "", "disabled": true }, { "key": "type", "value": "delivery_note,invoice", "disabled": false }, { "key": "source", "value": "", "disabled": true }, { "key": "export_status", "value": "", "disabled": true }, { "key": "expand", "value": "lines", "disabled": false } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-purchases#listDocuments" } }, { "name": "[Soon] Retrieve a purchase document", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/documents/:document_id?expand=lines,files,history", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":document_id" ], "query": [ { "key": "expand", "value": "lines,files,history", "disabled": false } ], "variable": [ { "key": "document_id", "value": "5520931" } ] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-purchases#getDocument" } } ] }, { "name": "Expenses", "description": "Expense documents, which have no products, and card transactions. List, create and update expenses, and import card transactions.", "item": [ { "name": "[Soon] List expenses", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/expenses?limit=200&updated_since=2026-09-10T00:00:00+03:00&expand=files", "host": [ "{{baseUrl}}" ], "path": [ "expenses" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "200", "disabled": false }, { "key": "updated_since", "value": "2026-09-10T00:00:00+03:00", "disabled": false }, { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true }, { "key": "branch_id", "value": "", "disabled": true }, { "key": "category_id", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "expand", "value": "files", "disabled": false } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-expenses#listExpenses" } }, { "name": "[Soon] Create an expense", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "exp-72455-NP-20931", "disabled": false } ], "url": { "raw": "{{baseUrl}}/expenses", "host": [ "{{baseUrl}}" ], "path": [ "expenses" ], "query": [], "variable": [] }, "description": "Create an expense document from an external system. The buyer's blocking rules apply, covering mandatory attachments, allocation numbers above 5,000 ILS and missing account mappings.\n\nNot yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-expenses#createExpense", "body": { "mode": "raw", "raw": "{\n \"vendor_id\": \"72455\",\n \"doc_type\": \"tax_invoice\",\n \"doc_number\": \"NP-20931\",\n \"doc_date\": \"2026-09-10\",\n \"due_date\": \"2026-10-30\",\n \"accounting_period\": \"2026-09\",\n \"branch_id\": \"71148-1\",\n \"purchase_type\": \"OC\",\n \"vat_mode\": \"with_vat\",\n \"totals\": {\n \"before_vat\": \"845.00\",\n \"vat\": \"152.10\",\n \"with_vat\": \"997.10\",\n \"deductible_vat\": \"152.10\"\n },\n \"payment_method\": \"bank_transfer\",\n \"lines\": [\n {\n \"category_id\": \"912\",\n \"purchase_type\": \"OC\",\n \"branch_id\": \"71148-1\",\n \"amount_before_vat\": \"620.00\",\n \"vat_amount\": \"111.60\",\n \"description\": \"חומרי ניקוי ומסירי שומנים למטבח\"\n },\n {\n \"category_id\": \"912\",\n \"purchase_type\": \"OC\",\n \"branch_id\": \"71148-1\",\n \"amount_before_vat\": \"225.00\",\n \"vat_amount\": \"40.50\",\n \"description\": \"שקיות אשפה ומגבות נייר\"\n }\n ],\n \"file_ids\": [\n \"file_01J9KW5T2D\"\n ],\n \"notes\": \"חשבונית חודשית, סניף ראשי\",\n \"external_ref\": \"ERP-EXP-55120\",\n \"submit\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "[Soon] Retrieve an expense", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/expenses/:expense_id", "host": [ "{{baseUrl}}" ], "path": [ "expenses", ":expense_id" ], "query": [], "variable": [ { "key": "expense_id", "value": "8830412" } ] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-expenses#getExpense" } }, { "name": "[Soon] Update a draft expense", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "If-Match", "value": "\"8830477-v1\"", "disabled": false } ], "url": { "raw": "{{baseUrl}}/expenses/:expense_id", "host": [ "{{baseUrl}}" ], "path": [ "expenses", ":expense_id" ], "query": [], "variable": [ { "key": "expense_id", "value": "8830477" } ] }, "description": "Update an expense in `draft` status. Expenses in any other status cannot be edited. After an expense is exported, create a counter document instead.\n\nNot yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-expenses#updateExpense", "body": { "mode": "raw", "raw": "{\n \"vendor_id\": \"72950\",\n \"merchant_name\": \"תחנת דלק\",\n \"doc_type\": \"card_txn\",\n \"doc_date\": \"2026-09-11\",\n \"accounting_period\": \"2026-09\",\n \"branch_id\": \"71148-1\",\n \"purchase_type\": \"OC\",\n \"vat_mode\": \"with_vat\",\n \"totals\": {\n \"before_vat\": \"296.61\",\n \"vat\": \"53.39\",\n \"with_vat\": \"350.00\",\n \"deductible_vat\": \"35.59\"\n },\n \"payment_method\": \"credit_card\",\n \"lines\": [\n {\n \"category_id\": \"915\",\n \"purchase_type\": \"OC\",\n \"branch_id\": \"71148-1\",\n \"amount_before_vat\": \"296.61\",\n \"vat_amount\": \"53.39\",\n \"description\": \"תדלוק רכב החלוקה\"\n }\n ],\n \"file_ids\": [\n \"file_01J9MC9K4P\"\n ],\n \"notes\": \"קבלה מצורפת\",\n \"external_ref\": \"MESH-TX-20260911-00417\",\n \"submit\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "[Soon] List card transactions", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/card-transactions?limit=200&updated_since=2026-09-11T00:00:00+03:00", "host": [ "{{baseUrl}}" ], "path": [ "card-transactions" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "200", "disabled": false }, { "key": "updated_since", "value": "2026-09-11T00:00:00+03:00", "disabled": false }, { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true }, { "key": "matched", "value": "", "disabled": true } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-expenses#listCardTransactions" } }, { "name": "[Soon] Import card transactions", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "mesh-feed-2026-09-13", "disabled": false } ], "url": { "raw": "{{baseUrl}}/card-transactions/batch", "host": [ "{{baseUrl}}" ], "path": [ "card-transactions", "batch" ], "query": [], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-expenses#importCardTransactions", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"external_id\": \"MESH-TX-20260911-00417\",\n \"card_last4\": \"4417\",\n \"txn_date\": \"2026-09-11\",\n \"merchant\": \"תחנת דלק\",\n \"amount\": \"350.00\",\n \"currency\": \"ILS\",\n \"vendor_id\": \"72950\"\n },\n {\n \"external_id\": \"MESH-TX-20260911-00452\",\n \"card_last4\": \"4417\",\n \"txn_date\": \"2026-09-11\",\n \"merchant\": \"חניון עירוני\",\n \"amount\": \"24.00\",\n \"currency\": \"ILS\",\n \"vendor_id\": \"72950\"\n },\n {\n \"external_id\": \"MESH-TX-20260910-00388\",\n \"card_last4\": \"4417\",\n \"txn_date\": \"2026-09-10\",\n \"merchant\": \"חניון עירוני\",\n \"amount\": \"18.00\",\n \"currency\": \"ILS\",\n \"vendor_id\": \"72950\"\n },\n {\n \"external_id\": \"MESH-TX-20260911-00460\",\n \"card_last4\": \"4417\",\n \"txn_date\": \"2026-09-11\",\n \"merchant\": \"נקי פלוס\",\n \"amount\": \"129.00\",\n \"currency\": \"ILS\",\n \"vendor_id\": \"72455\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Accounting", "description": "Journal lines from ZesttBox, ready for your ERP. Pull the lines approved for export, then mark them as exported.", "item": [ { "name": "[Soon] List journal lines", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/accounting/journal-lines?limit=200&period=2026-09&status=approved_for_export&branch_id=71148-1", "host": [ "{{baseUrl}}" ], "path": [ "accounting", "journal-lines" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "200", "disabled": false }, { "key": "updated_since", "value": "", "disabled": true }, { "key": "period", "value": "2026-09", "disabled": false }, { "key": "status", "value": "approved_for_export", "disabled": false }, { "key": "branch_id", "value": "71148-1", "disabled": false }, { "key": "source", "value": "", "disabled": true } ], "variable": [] }, "description": "List ZesttBox journal lines (debit, credit and VAT) ready for your ERP, one row per line. Set `status` to `approved_for_export` to pull the lines that are ready, then mark them with `POST /accounting/exports`.\n\nNot yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-accounting#listJournalLines" } }, { "name": "[Soon] Mark journal lines as exported", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "meshek-export-2026-09-15-01", "disabled": false } ], "url": { "raw": "{{baseUrl}}/accounting/exports", "host": [ "{{baseUrl}}" ], "path": [ "accounting", "exports" ], "query": [], "variable": [] }, "description": "Set the given journal lines to `exported` and record the calling client as `exported_by`. The response returns the export batch with its `export_batch_id`.\n\nNot yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-accounting#createAccountingExport", "body": { "mode": "raw", "raw": "{\n \"journal_line_ids\": [\n \"jl_90311\",\n \"jl_90312\",\n \"jl_90313\"\n ],\n \"target\": \"meshek\",\n \"external_ref\": \"MSK-2026-09-013\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "[Soon] Retrieve an export batch", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/accounting/exports/:export_batch_id", "host": [ "{{baseUrl}}" ], "path": [ "accounting", "exports", ":export_batch_id" ], "query": [], "variable": [ { "key": "export_batch_id", "value": "aex_01J9KQ7X4M" } ] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-accounting#getAccountingExport" } } ] }, { "name": "Sales", "description": "Z-reports and item-level sales from the point of sale (POS). Send them from the POS system and list them.", "item": [ { "name": "[Soon] List Z-reports", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sales/z-reports?from=2026-09-12&to=2026-09-13&branch_id=71148-1", "host": [ "{{baseUrl}}" ], "path": [ "sales", "z-reports" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "from", "value": "2026-09-12", "disabled": false }, { "key": "to", "value": "2026-09-13", "disabled": false }, { "key": "branch_id", "value": "71148-1", "disabled": false } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-sales#listZReports" } }, { "name": "[Soon] Create or update Z-reports in bulk", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sales/z-reports", "host": [ "{{baseUrl}}" ], "path": [ "sales", "z-reports" ], "query": [], "variable": [] }, "description": "Send Z-reports from the POS. Each Z-report is identified by its `branch_id` and `z_number`, so sending the same Z-report again updates it.\n\nNot yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-sales#createZReports", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"branch_id\": \"71148-1\",\n \"z_number\": \"1204\",\n \"closed_at\": \"2026-09-13T23:05:00+03:00\",\n \"description\": \"Z 1204 שניצי קפה – ראשי\",\n \"total_before_vat\": \"12450.00\",\n \"orders_count\": 414,\n \"dine_in_total\": \"8715.00\",\n \"dine_in_count\": 238,\n \"take_away_total\": \"3735.00\",\n \"take_away_count\": 176,\n \"tips\": \"1164.00\",\n \"cash_total\": \"1902.00\",\n \"card_total\": \"12789.00\",\n \"cheque_total\": \"0.00\",\n \"discounts_total\": \"386.50\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "[Soon] List item sales", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sales/item-sales?limit=3&from=2026-09-13&to=2026-09-13&branch_id=71148-1&z_number=1204", "host": [ "{{baseUrl}}" ], "path": [ "sales", "item-sales" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "3", "disabled": false }, { "key": "from", "value": "2026-09-13", "disabled": false }, { "key": "to", "value": "2026-09-13", "disabled": false }, { "key": "branch_id", "value": "71148-1", "disabled": false }, { "key": "z_number", "value": "1204", "disabled": false } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-sales#listItemSales" } }, { "name": "[Soon] Create item sales in bulk", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sales/item-sales", "host": [ "{{baseUrl}}" ], "path": [ "sales", "item-sales" ], "query": [], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-sales#createItemSales", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"branch_id\": \"71148-1\",\n \"z_number\": \"1204\",\n \"value_date\": \"2026-09-13T00:00:00+03:00\",\n \"item_code\": \"P-101\",\n \"item_name\": \"שניצל בלחמניה\",\n \"quantity\": \"96\",\n \"unit_price\": \"41.53\",\n \"total\": \"3986.88\",\n \"line_number\": 1,\n \"main_category\": \"מזון\",\n \"sub_category\": \"כריכים\"\n },\n {\n \"branch_id\": \"71148-1\",\n \"z_number\": \"1204\",\n \"value_date\": \"2026-09-13T00:00:00+03:00\",\n \"item_code\": \"P-205\",\n \"item_name\": \"סלט ישראלי\",\n \"quantity\": \"41\",\n \"unit_price\": \"32.20\",\n \"total\": \"1320.20\",\n \"line_number\": 2,\n \"main_category\": \"מזון\",\n \"sub_category\": \"סלטים\"\n },\n {\n \"branch_id\": \"71148-1\",\n \"z_number\": \"1204\",\n \"value_date\": \"2026-09-13T00:00:00+03:00\",\n \"item_code\": \"D-310\",\n \"item_name\": \"קפה הפוך\",\n \"quantity\": \"212\",\n \"unit_price\": \"11.86\",\n \"total\": \"2514.32\",\n \"line_number\": 3,\n \"main_category\": \"משקאות\",\n \"sub_category\": \"קפה חם\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Inventory", "description": "Inventory counts taken at the account's branches. List counts, or retrieve a single count with its lines.", "item": [ { "name": "[Soon] List inventory counts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory-counts?from=2026-09-01&to=2026-09-13&branch_id=71148-1", "host": [ "{{baseUrl}}" ], "path": [ "inventory-counts" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "", "disabled": true }, { "key": "from", "value": "2026-09-01", "disabled": false }, { "key": "to", "value": "2026-09-13", "disabled": false }, { "key": "branch_id", "value": "71148-1", "disabled": false }, { "key": "expand", "value": "", "disabled": true } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-inventory#listInventoryCounts" } }, { "name": "[Soon] Retrieve an inventory count", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory-counts/:count_id", "host": [ "{{baseUrl}}" ], "path": [ "inventory-counts", ":count_id" ], "query": [], "variable": [ { "key": "count_id", "value": "ic_2291" } ] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/buyer-inventory#getInventoryCount" } } ] }, { "name": "Reports", "description": "Computed reports for food cost, purchases, expenses and profit and loss (P&L). To load data into a BI tool, use the list endpoints for the underlying records instead.", "item": [ { "name": "[Soon] Retrieve the food cost report", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/reports/food-cost?from=2026-09-01&to=2026-09-13&purchase_type=FC", "host": [ "{{baseUrl}}" ], "path": [ "reports", "food-cost" ], "query": [ { "key": "from", "value": "2026-09-01", "disabled": false }, { "key": "to", "value": "2026-09-13", "disabled": false }, { "key": "branch_id", "value": "", "disabled": true }, { "key": "purchase_type", "value": "FC", "disabled": false } ], "variable": [] }, "description": "Calculate food cost by branch and purchase type, with the same numbers as the in-app report. Only records whose `source` is `purchase` and whose `vendor_type` is `goods` are included.\n\nNot yet available.\n\nDocs: https://docs.zestt.io/reference/reports#getFoodCostReport" } }, { "name": "[Soon] Retrieve the purchases report", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/reports/purchases?from=2026-09-01&to=2026-09-13&group_by=supplier", "host": [ "{{baseUrl}}" ], "path": [ "reports", "purchases" ], "query": [ { "key": "from", "value": "2026-09-01", "disabled": false }, { "key": "to", "value": "2026-09-13", "disabled": false }, { "key": "group_by", "value": "supplier", "disabled": false } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/reports#getPurchasesReport" } }, { "name": "[Soon] Retrieve the expenses report", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/reports/expenses?from=2026-09-01&to=2026-09-13&group_by=category,branch", "host": [ "{{baseUrl}}" ], "path": [ "reports", "expenses" ], "query": [ { "key": "from", "value": "2026-09-01", "disabled": false }, { "key": "to", "value": "2026-09-13", "disabled": false }, { "key": "group_by", "value": "category,branch", "disabled": false } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/reports#getExpensesReport" } }, { "name": "[Soon] Retrieve the profit and loss report", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/reports/pnl?period=2026-09&branch_id=71148-1", "host": [ "{{baseUrl}}" ], "path": [ "reports", "pnl" ], "query": [ { "key": "period", "value": "2026-09", "disabled": false }, { "key": "branch_id", "value": "71148-1", "disabled": false } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/reports#getPnlReport" } } ] } ] }, { "name": "Platform", "item": [ { "name": "Events", "description": "A change feed of account events that you pull. It uses the same event catalog as webhooks.", "item": [ { "name": "[Soon] List events", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/events?limit=3&type=order.created,order.updated,document.received&since=2026-09-11T00:00:00+03:00", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "3", "disabled": false }, { "key": "type", "value": "order.created,order.updated,document.received", "disabled": false }, { "key": "since", "value": "2026-09-11T00:00:00+03:00", "disabled": false } ], "variable": [] }, "description": "List events from the change feed in `occurred_at` order, using the same event catalog as webhooks. Store `next_cursor` and resume from it on your next call. Events are kept for 30 days on the Pro plan and 90 days on the Enterprise plan.\n\nNot yet available.\n\nDocs: https://docs.zestt.io/reference/events#listEvents" } } ] }, { "name": "Webhooks", "description": "Signed notifications that Zestt pushes to your HTTPS endpoints when events occur. Manage endpoints, send test events and redeliver past deliveries.", "item": [ { "name": "List webhook endpoints", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ], "query": [], "variable": [] }, "description": "Docs: https://docs.zestt.io/reference/webhooks#listWebhooks" } }, { "name": "Create a webhook endpoint", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ], "query": [], "variable": [] }, "description": "Create an endpoint that receives signed event notifications. The response includes the signing `secret`, which is shown only once. The number of endpoints you can create depends on your plan.\n\nDocs: https://docs.zestt.io/reference/webhooks#createWebhook", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://erp.example.com/zestt/webhooks\",\n \"events\": [\n \"order.created\",\n \"order.updated\",\n \"document.received\"\n ],\n \"description\": \"Priority ERP: orders and documents\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve a webhook endpoint", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:webhook_id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhook_id" ], "query": [], "variable": [ { "key": "webhook_id", "value": "wh_01J9KR2B7N" } ] }, "description": "Docs: https://docs.zestt.io/reference/webhooks#getWebhook" } }, { "name": "Update a webhook endpoint", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhooks/:webhook_id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhook_id" ], "query": [], "variable": [ { "key": "webhook_id", "value": "wh_01J9KR2B7N" } ] }, "description": "Docs: https://docs.zestt.io/reference/webhooks#updateWebhook", "body": { "mode": "raw", "raw": "{\n \"events\": [\n \"order.created\",\n \"order.updated\",\n \"order.cancelled\",\n \"document.received\",\n \"document.disputed\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a webhook endpoint", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:webhook_id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhook_id" ], "query": [], "variable": [ { "key": "webhook_id", "value": "wh_01J9KR2B7N" } ] }, "description": "Docs: https://docs.zestt.io/reference/webhooks#deleteWebhook" } }, { "name": "Test a webhook endpoint", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:webhook_id/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhook_id", "test" ], "query": [], "variable": [ { "key": "webhook_id", "value": "wh_01J9KR2B7N" } ] }, "description": "Docs: https://docs.zestt.io/reference/webhooks#testWebhook" } }, { "name": "List delivery attempts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:webhook_id/deliveries?limit=3", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhook_id", "deliveries" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "3", "disabled": false }, { "key": "status", "value": "", "disabled": true } ], "variable": [ { "key": "webhook_id", "value": "wh_01J9KR2B7N" } ] }, "description": "Docs: https://docs.zestt.io/reference/webhooks#listWebhookDeliveries" } }, { "name": "Redeliver a webhook event", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:webhook_id/deliveries/:delivery_id/redeliver", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhook_id", "deliveries", ":delivery_id", "redeliver" ], "query": [], "variable": [ { "key": "webhook_id", "value": "wh_01J9KR2B7N" }, { "key": "delivery_id", "value": "whd_01J9KS9D2F" } ] }, "description": "Docs: https://docs.zestt.io/reference/webhooks#redeliverWebhookDelivery" } } ] }, { "name": "Files", "description": "Upload attachments, then reference them from other resources by `file_id`. Retrieve a file's metadata and a signed download URL.", "item": [ { "name": "Upload a file", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/files", "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [], "variable": [] }, "description": "Upload a file as `multipart/form-data`, up to 25 MB. The response returns a `file_id` to reference from documents and expenses. Files that are not referenced within 24 hours are deleted.\n\nDocs: https://docs.zestt.io/reference/files#uploadFile", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] }, { "key": "purpose", "value": "document_attachment", "type": "text" } ] } } }, { "name": "Retrieve a file", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/files/:file_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [], "variable": [ { "key": "file_id", "value": "file_01J9KQ7X4M" } ] }, "description": "Docs: https://docs.zestt.io/reference/files#getFile" } } ] }, { "name": "Exports", "description": "Asynchronous bulk exports of account data, available on the Enterprise plan. Create an export job, then poll it until the download links are ready.", "item": [ { "name": "[Soon] Create a bulk export", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/exports", "host": [ "{{baseUrl}}" ], "path": [ "exports" ], "query": [], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/exports#createExport", "body": { "mode": "raw", "raw": "{\n \"resources\": [\n \"documents\",\n \"orders\"\n ],\n \"from\": \"2025-01-01\",\n \"to\": \"2026-09-12\",\n \"format\": \"ndjson\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "[Soon] Retrieve a bulk export", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/exports/:export_id", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":export_id" ], "query": [], "variable": [ { "key": "export_id", "value": "job_01J9KT3H6W" } ] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/exports#getExport" } } ] }, { "name": "Audit", "description": "The account's API request log, available on the Enterprise plan. Filter requests by date, API client and HTTP status code.", "item": [ { "name": "[Soon] List request log entries", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/audit/requests?limit=3&from=2026-09-13&to=2026-09-13&client_id=cl_01J9KQ7X4M", "host": [ "{{baseUrl}}" ], "path": [ "audit", "requests" ], "query": [ { "key": "cursor", "value": "", "disabled": true }, { "key": "limit", "value": "3", "disabled": false }, { "key": "from", "value": "2026-09-13", "disabled": false }, { "key": "to", "value": "2026-09-13", "disabled": false }, { "key": "client_id", "value": "cl_01J9KQ7X4M", "disabled": false }, { "key": "status", "value": "", "disabled": true } ], "variable": [] }, "description": "Not yet available.\n\nDocs: https://docs.zestt.io/reference/audit#listAuditRequests" } } ] } ] } ] }