List all products of a center
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 use 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.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.
Endpoint
GET /v1/centers/{center_id}/products
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| center_id | string | Yes | Mandatory Unique 32-character identifier of the center. |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| page | integer (int32) | No | 1 | Optional Number of the display page. Default value is 1. |
| size | integer (int32) | No | 10 | Optional Number of records per page. Default value is 10. |
| show_in_catalog | boolean | No | — | Optional Indicates whether the product is displayed on the Catalog tab. |
Response
Success (200 OK)
{
"products": [
{
"...": "..."
}
],
"page_info": {
"total": 27,
"page": 1,
"size": 10
}
}
Response fields
| Field | Type | Description |
|---|---|---|
| products | object[] | |
| products[].id | string | |
| products[].code | string | |
| products[].name | string | |
| products[].description | string | |
| products[].html_description | string | |
| products[].category_id | string | |
| products[].sub_category_id | string | |
| products[].bussiness_unit_id | string | |
| products[].quantity | object | |
| products[].commission | object | |
| products[].preferences | object | |
| products[].barcodes | object[] | |
| products[].tags | string[] | |
| products[].catalog_info | object | |
| products[].centers | object[] | |
| page_info | object | |
| page_info.total | integer | |
| page_info.page | integer | |
| page_info.size | integer |
Example
curl --request GET \
--url 'https://api.zenoti.com/v1/centers/{center_id}/products' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/centers/{center_id}/products', {
method: 'GET',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.get(
'https://api.zenoti.com/v1/centers/{center_id}/products',
headers={
'Authorization': 'bearer {{access_token}}',
},
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.GetAsync(
"https://api.zenoti.com/v1/centers/{center_id}/products");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/centers/{center_id}/products')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)
Error codes
| Status | Description |
|---|---|
| 400 | 400 |
| 401 | Unauthorized -- invalid or expired access token |
| 429 | Too many requests -- rate limit exceeded |