Product Groups

Product group data set by each company is useful for clear trade grouping, statistics and product classification.

API Endpoint

URL	{base url}/api/Product/ProductGroups
Method	POST
Authorization	Bearer Token
Content-Type	application/json

Request Headers

Parameter	Type	Required	Description
APIKEY	string	true	System key code

Request Parameters

Parameter	Type	Required	Description
Limit	integer	true	Number of records to retrieve
LoadIndex	integer	true	The starting index for the data to retrieve
Active	boolean	false	Status of the records (True = active, False = inactive)
Sortby	string	false	Field to sort by (e.g., createdate)
SortType	string	false	Sorting direction (asc = ascending, desc = descending)
FilterBy	string	false	Filter criteria for records (leave blank for no filter)

Request JSON Example

{
    "Limit": 10,
    "LoadIndex": 1,
    "Active": true,
    "Sortby": "createdate",
    "SortType": "asc",
    "FilterBy": ""
}
    

Response Parameters

Parameter	Type	Description
Id	integer	Error status (0 = no error)
Success	boolean	Status of the request
Message	string	Response message
RequestId	string	Reference ID for the request
Size	integer	Number of records returned
Data	object	Product group data

Data

Parameter	Type	Description
Id	string	Group ID
Code	string	Code of the product group
Name	string	Name of the product group
Active	boolean	Status of the product group
UpdateDate	datetime	When the product group was last updated
CreateDate	datetime	When the product group was created

Response JSON Example

{
    "Id": 0,
    "Success": true,
    "Message": "SUCCESS",
    "RequestId": "7AA455F5-EEC3-439C-A0CF-68A6E96C2439",
    "Size": 7,
    "Data": [
        {
            "Id": "9928AD4D-24FA-4581-9547-412DB606E85C",
            "Code": "BL-IT",
            "Name": "IT Equipment",
            "Active": true,
            "UpdateDate": null,
            "CreateDate": "2024-10-03T13:15:57.2215469"
        },
        {
            "Id": "EB8256F0-F79B-4273-8B7D-BEB0A647E822",
            "Code": "BL-FASHIONS",
            "Name": "Clothing and Accessories",
            "Active": true,
            "UpdateDate": null,
            "CreateDate": "2024-10-01T12:01:28.555809"
        }
        //... More Data
    ]
}