v1
latestOpenAPI 3.1.02026-07-2438302.6 MBGet all Products
get/product
Query parameters
pageinteger
Page
countinteger
Count
sort'ASC' | 'DESC'
Sort
sort_bystring
Sort By Value
priceliststring
Pricelist UID
filter.from_datestring date-time
From Date
filter.to_datestring date-time
To Date
filter.keywordstring
Keyword
filter.location_uidstring
Location UID
filter.is_availablestring
filter.product_categorystring
Product Category UID
filter.product_typestring
filter.custom_fieldstring
filter.brandstring
filter.specificationstring
filter.product_uidstring
filter.product_idstring
filter.updated_at_fromstring date-time
filter.updated_at_tostring date-time
filter.min_quantityinteger
filter.is_deletedboolean
filter.serial_nostring
filter.pricing_levelstring
filter.is_billableboolean
filter.low_stockboolean
filter.scan_codestring
Scan code
filter.associated_product_uidstring
Associated Product UID
filter.business_unitstring
Response
200
Example response
{
"type": "success",
"data": [
{
"_id": "6618d5eb65b1bbb161a6930d",
"product_uid": "b13f69d0-f896-11ee-b23b-b9743bfe06c8",
"prefix": "PT",
"product_id": "PART005",
"product_category": {
"category_name": "Plumbing Tool",
"category_uid": "9e264c70-4813-11ea-85e2-91cf2fb0b4bb"
},
"product_barcode": "16",
"product_files": [
{
"attachment_uid": "cce94303-3153-497c-9f3a-4a9693a4f8f2",
"file_name": "10 mb .jpg",
"url": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/03b4ac7c-e0b0-4be5-b977-ed8862d196d3.jpg",
"created_by": 1,
"file_url": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/03b4ac7c-e0b0-4be5-b977-ed8862d196d3.jpg"
}
],
"brand": "GLB",
"product_name": "#GLB-50-985 - Oxy-Brite® Non-Chlorine Shock Oxidizer #1",
"product_description": "<p>Some text for testing the long text so that description should be so so long and the long text should be like three lines in the mobile.\\nAkutami wrote the series with no themes to follow but wanted to write and draw cool-looking characters. They were often supported by their two editors while writing the manga. The manga was a commercial success in both Japan and North America. Critical response to the manga was generally positive; several reviewers praised Yuta's role and his relationship with Rika. Critics found Yuta more compelling than Jujutsu Kaisen's Yuji Itadori who, while having several similarities with Yuta, has different characterizations. The relationships of the main cast were also well-received and the manga's artwork was praised. Jujutsu Kaisen 0 received an anime film adaptation by MAPPA, which was directed by Sunghoo Park and premiered in Japan in December 2021. It was followed by a novelization and a new gag chapter written by Akutami.</p>",
"product_type": "PRODUCT",
"meta_data": [
{
"label": "Xero Item Account",
"type": "SINGLE_ITEM",
"module_name": "PRODUCT",
"_id": "6763de60eaf9e660fc7d82ee"
}
],
"location_availability": [
{
"location": {
"location_uid": "4c90d230-87e6-11ec-a0b1-1bc079724999",
"location_name": "W1 Warehouse"
},
"quantity": -5,
"min_quantity": 1,
"_id": "6763de60eaf9e660fc7d8309",
"created_at": "2024-12-19T08:50:40.784Z"
}
],
"track_quantity": true,
"quantity": 143,
"min_quantity": 16,
"price": 5.6,
"is_available": true,
"created_by": {
"user_uid": "06aaed4d-80de-41f2-a977-c32d67cce739",
"first_name": "def",
"last_name": "B",
"email": "def@def.co",
"designation": "Admin",
"emp_code": "Z168",
"profile_picture": "https://s3.ap-south-1.amazonaws.com/prod.app.zuperpro/assets/profile_picture.jpg",
"hourly_labor_charge": 20,
"is_active": true,
"created_at": "2023-06-15T11:56:58.000Z",
"updated_at": "2025-01-06T07:02:58.000Z"
},
"created_at": "2024-04-12T06:34:19.760Z",
"updated_at": "2025-01-06T06:50:07.367Z",
"product_no": 814,
"markdown_description": "Some text for testing the long text so that description should be so so long and the long text should be like three lines in the mobile.\\\\nAkutami wrote the series with no themes to follow but wanted to write and draw cool-looking characters. They were often supported by their two editors while writing the manga. The manga was a commercial success in both Japan and North America. Critical response to the manga was generally positive; several reviewers praised Yuta's role and his relationship with Rika. Critics found Yuta more compelling than Jujutsu Kaisen's Yuji Itadori who, while having several similarities with Yuta, has different characterizations. The relationships of the main cast were also well-received and the manga's artwork was praised. Jujutsu Kaisen 0 received an anime film adaptation by MAPPA, which was directed by Sunghoo Park and premiered in Japan in December 2021. It was followed by a novelization and a new gag chapter written by Akutami.",
"plain_text_description": "Some text for testing the long text so that description should be so so long and the long text should be like three lines in the mobile.\\nAkutami wrote the series with no themes to follow but wanted to write and draw cool-looking characters. They were often supported by their two editors while writing the manga. The manga was a commercial success in both Japan and North America. Critical response to the manga was generally positive; several reviewers praised Yuta's role and his relationship with Rika. Critics found Yuta more compelling than Jujutsu Kaisen's Yuji Itadori who, while having several similarities with Yuta, has different characterizations. The relationships of the main cast were also well-received and the manga's artwork was praised. Jujutsu Kaisen 0 received an anime film adaptation by MAPPA, which was directed by Sunghoo Park and premiered in Japan in December 2021. It was followed by a novelization and a new gag chapter written by Akutami.",
"id": "6618d5eb65b1bbb161a6930d"
}
],
"total_records": 10,
"current_page": 1,
"total_pages": 1
}