Getting Started

Catalog Update

Order Management

Total Sales

Suppliers Details

Introduction

The Zester API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the Zester API in test mode, which does not affect your live data or interact with other networks. 

The API key you use to authenticate the request determines whether the request is live mode (production environment) or test mode (test environment).

The Zester API differs for every account as we release new versions and tailor functionality. 

The following document is customized to your API version, with your test key and data including the following functionalities:

Create New User

Basic information requested to create a new costumer in the Zester system then redirecting him to a “personal information registration form”

Product Update

Customers are exposed to products catalog updatable in the Zester system. Either create, update or delete a product from the catalog with all its specifications.

Product price

Customers are exposed to updatable products price lists and minimum order required in the Zester system.

Product Removal

Remove a product from customer’s catalog in the zester system with its SKU (stock keeping unit), price and quantity.

Price list removal

Remove a price list from a specific customer in the zester system

Order Reception

Receive an order document submitted by the customer from the zester system.

Order Validation

Validate a received order document and update the customer in the zester system

Order Schedule

Update customer’s order due day and hour in the zester system

Delivery Documents

Create a delivery certificate or an invoice in the zester system

Environments

The environments have different databases & API keys – which means that data generated on one environment won’t be available on another.

To log in first request a username and password by sending an e-mail to [email protected] with the subject: API user and password request.

  • Test: This environment is used for testing, so that you can do whatever you want without destroying your own data. This environment includes the latest updates for our system. In order to use this environment you have to create a new user (just like in the regular / production site) in the environment at: https://test-api.zester.co.il/