get
https://api.zenoti.com/v1/centers//products
This API helps you to retrieve all the products that are active in the center on the specified date.
You must specify the unique identifier of the center as center_id in the API request.
API helps you to retrieve all the employees that are active in the center on the specified date.
You must specify the unique identifier of the center as center_id in the API request.
You can also leverage the pagination feature by passing page and size query parameters if you have a large number of records to be displayed. By default, page is set as 1 and size is set as 10. size cannot be more than 100: which means that the maximum records per page cannot be more than 100.
Response Details
| Name | Type | Description |
|---|---|---|
| products | object | Object that contains all the products-related info. |
| commissions | object | Object that contains commissions info of the products (if any). |
| preferences | object | Object that contains the type of product details. |
| barcodes | object | Object that contains the barcode details of the product. |
| tags | object | Object that contains the tags info of the product. |
| catalog_info | object | Object that contains the catalog details of the product. |
| centers | object | Object that contains the products and their associated centers. |
| inventory_info | object | Object that contains the inventory info of the products. |
| page_info | object | Object that contains all the page display-related elements. |
| error | object | Object that contains error message and error code details. For more information, refer to the error Object table. |
products Object
| Name | Type | Description |
|---|---|---|
| id | guid | Unique identifier of the product. |
| code | id | Code of the product. |
| name | string | Name of the product. |
| description | string | Description of the product. |
| html_description | string | Description of the product in HTML. |
| category_id | guid | Unique identifier of the category of the product. |
| sub_category_id | guid | Unique identifier of the sub-category of the product. |
| business_unit_id | guid | Unique identifier of the business unit of the product. |
| quantity | object | Object containing the quantity details of the product. |
| value | int | Quantity of the product. |
| unit | string | Unit of measurement of the quantity. |
commissions Object
| Name | Type | Description |
|---|---|---|
| eligible | bool | Denotes if the product is eligible for employee commissions. |
| type | enum | Type of commission on the product. |
| value | int | Value of the commission on the product. |
preferences Object
| Name | Type | Description |
|---|---|---|
| consumable | bool | Denotes if the product is marked as consumable. True: Consumable False: Not Consumable or Retail. |
| retail | bool | Denotes if the product is marked as retail. True: Retail False: Not Retail or Consumable. |
barcodes Object
| Name | Type | Description |
|---|---|---|
| value | string | Denotes the value of the barcode of the product. |
| is_primary | bool | Denotes if the product is a primary product. True: Is primary. False: Is not primary. |
tags Object
| Name | Type | Description |
|---|---|---|
| tags | guid | Denotes the tags associated with the product. |
catalog_info Object
| Name | Type | Description |
|---|---|---|
| show_in_catalog | bool | Denotes if the product catalog is enabled. True: Enabled. False: Disabled. |
| show_price | bool | Denotes if the price of the product is shown. True: Product price is shown. False: Product price is not shown. |
| display_name | string | Name of the product as shown in Zenoti. |
| display_price | string | Price of the product as shown in Zenoti. |
| video_url | string | Video URL of the product (if any). |
centers Object
| Name | Type | Description |
|---|---|---|
| center_id | guid | Unique identifier of the center. |
| center_code | string | Code of the center. |
| sale_info | object | Object containing the sales information of the product. |
| currency_id | int | Id of the currency in which the product is sold. |
| include_tax | bool | Denotes if the tax is included in the sale price of the product. True: Tax is included. False: Tax is not included. |
| tax_id | string | Tax identifier for the product. |
| sale_price | int | Sale price of the product at the center. |
inventory_info Object
| Name | Type | Description |
|---|---|---|
| desired_quantity | int | The desired quantity or the stock of the product. |
| alert_quantity | int | Alert quantity of the product. Zenoti will alert you if the stock of the product falls below the alert quantity. |
| transfer_price | int | Transfer price of the product if moved across centers. |
| transfer_tax_id | id | Tax id for transferring the product. |
| order | int | Purchase orders raised for the product. |
error Object
| code | message |
|---|---|
| 401 | Authorization has been denied for this request. |
| 502 | invalid center_id. |
| 400 | The request is invalid. |
| 502 | cannot access, center is not catalog enabled. |