Product APIs

🚧

NOTICE: Changes to Product API behavior with Treez Catalog

With the introduction of Treez Catalog, the Product API is read only. The following operations must be done using the Catalog APIs instead:

• Create & Update products
• Create & Update variants
• Upload product images

INTRODUCTION

Using the Product API you can easily create new products in the POS system. The Product API also allows you to update the details of an existing product, search for a specific product, and download a list of all existing products.

Here is a postman collection you can use to start making calls to the Product API.

AUTHORIZATION

In order to access the Product API, please use the client_id and API key provided to your organization to generate an access_token with the Authorization API.

LIMITATIONS

• You can’t create an additional data field for the product.
• You can’t set a field as required.
• You can’t adjust the inventory for a product when you create or update a product.
• You can’t add a product image when you create or update a product.
• Rate limit is 10TPS per Treez location
• Each product_id corresponds to a variant in Treez catalog. See details on the Catalog page.

Page_count and total_count explained

Page_count attribute provides the count of items on the current page. In order to know how many pages are available use total_count attribute and divide by page_count.

Most pages will show the same page_count with exception of the last page if there is a remainder.

Calling a page out of range with return page_count and total_count as zero