Get all product groups
Get a list of all product groups.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
Search record by name or a part of the name.
The unique ID of the store in CareCloud. GET /stores
Code of the product group.
The ID from other system than CareCloud. It is usually used for the synchronization or identification of the record in between CareCloud and other system. The ID doesn't need to be necessary unique. Usage of other parameter could be required to return more specific results.
Unique ID of the partner from the resource GET /partners.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"product_groups": [
{
"product_group_id": "8fd73167342d06899c4c015320",
"name": "Accessories",
"parent_product_group_id": "83d1d11ea3884a5d33253fe214",
"parent_external_id": "678",
"code": "567829",
"external_id": "953",
"store_id": "83d1d11ea3884a5d33253fe214",
"partner_id": "86e05affc7a7abefcd513ab400",
"last_change": "2021-04-16 15:55:44.33538",
"state": 1
}
],
"total_items": 1
}
}