Get Warehouses Group 1

Returns the (paginated) catalog of enabled Warehouses Group 1 classifications for the caller's company, with an optional filter by id.

Required add-on

General use — no specific add-on required.

GET https://app.fracttal.com/api/warehouses_groups_1

Input parameters — Required

None.

Input parameters — Optional

Sent as query params.

ParameterTypeRequiredDescription
idbigintNoFilters by the id of a specific classification.
only_enabledbooleanNoIf sent as false, also includes disabled classifications. By default, only enabled = true is returned.
startintegerNoPagination offset. Default 0.
limitintegerNoPage size. Default 100, maximum 100 per page.

Output parameters

ParameterTypeDescription
successbooleantrue if the query was successful.
messagestring"200" on success; error code/message otherwise.
dataarrayList of classifications { id, id_company, description, enabled }.
totalintegerTotal count of classifications matching the filter for the company — not the returned page size. Use it to calculate the number of pages.

Errors

CodeCause
401Invalid or missing token.
500Unhandled internal server error.

No results is not an error

If the company has no classifications (or the filter matches nothing), the response is success=true, total=0, data=null — this is not an error.


Example

Request

GET https://app.fracttal.com/api/warehouses_groups_1?id=744

Response 200

{
  "success": true,
  "message": "200",
  "data": [
    { "id": 744, "id_company": 4344, "description": "Accessories", "enabled": true }
  ],
  "total": 1
}

Response — full catalog, no filters (200)

{
  "success": true,
  "message": "200",
  "data": [
    { "id": 744, "id_company": 4344, "description": "Accessories", "enabled": true },
    { "id": 745, "id_company": 4344, "description": "Consumables", "enabled": true }
  ],
  "total": 7
}
Response
200
Language
LoadingLoading…