Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ti-infinite/GSMApplication/llms.txt

Use this file to discover all available pages before exploring further.

The master data endpoints provide read-only access to the foundational reference tables that drive the GSM Operations workflows. These include global and parameterised configuration attributes, the master herb/product catalog with variety breakdowns, employee and supplier directories (both supporting optional filter criteria in the request body), the hierarchical product category tree, and SKU definitions. All endpoints are scoped to the authenticated user’s tenant via the gateway-injected X-Company-Id header.

Get Global Parameters

Retrieve all global and parameterised attribute configurations for the current tenant.

Endpoint

GET /api/operations/v1/operations/parameters

Authentication

Authorization
string
required
Bearer token. Format: Bearer <token>

Response

data
array
List of global parameter objects.

HTTP Status Codes

CodeMeaning
200 OKParameters returned.
401 UnauthorizedToken missing or invalid.
404 Not FoundNo parameters found for the tenant.

Example

curl --request GET \
  --url 'https://your-gateway.example.com/api/operations/v1/operations/parameters' \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Parameters retrieved successfully.",
  "data": [
    {
      "idParameter": 1,
      "paramCategory": "MEASUREMENT_UNITS",
      "shortName": "WEIGHT",
      "descr": "Weight measurement units",
      "paramAttributes": [
        { "idParamAttribute": 1, "idParameter": 1, "shortName": "KG", "code": "KG", "descr": "Kilograms", "globalParameter": null },
        { "idParamAttribute": 2, "idParameter": 1, "shortName": "GR", "code": "GR", "descr": "Grams", "globalParameter": null }
      ]
    }
  ],
  "errorType": null,
  "traceId": null,
  "details": null
}

Get Master Products

Retrieve the full herb and product catalog, including product varieties.

Endpoint

GET /api/operations/v1/operations/master-products

Authentication

Authorization
string
required
Bearer token. Format: Bearer <token>

Response

data
array
List of master product entries.

HTTP Status Codes

CodeMeaning
200 OKProducts returned.
401 UnauthorizedToken missing or invalid.
404 Not FoundNo products found for the tenant.

Example

curl --request GET \
  --url 'https://your-gateway.example.com/api/operations/v1/operations/master-products' \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Master products retrieved.",
  "data": [
    {
      "masterProductName": "Lavender",
      "sku": "LAV-001",
      "measurementUnit": "KG",
      "measurementUnitValue": 1.0,
      "mv": [
        { "idVariety": 10, "name": "Lavender Fine", "qty": 1.0, "isActive": true },
        { "idVariety": 11, "name": "Lavender Gross", "qty": 1.0, "isActive": true }
      ]
    }
  ],
  "errorType": null,
  "traceId": null,
  "details": null
}

Get Filtered Employees

Retrieve the employee directory with optional filtering criteria supplied in the request body. All filter fields are optional — omitting the body or sending {} returns all employees.

Endpoint

GET /api/operations/v1/operations/filtered-employees

Authentication

Authorization
string
required
Bearer token. Format: Bearer <token>

Request Body (optional)

fullName
string
Filter by full name (partial match supported).
location
string
Filter by the employee’s assigned location.

Response

data
array
List of employee records matching the filter criteria.

HTTP Status Codes

CodeMeaning
200 OKEmployees returned (may be empty list).
401 UnauthorizedToken missing or invalid.

Example

curl --request GET \
  --url 'https://your-gateway.example.com/api/operations/v1/operations/filtered-employees' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "fullName": "Maria",
    "location": "Farm A"
  }'

Get Filtered Suppliers

Retrieve the supplier directory with optional filtering criteria supplied in the request body. All filter fields are optional.

Endpoint

GET /api/operations/v1/operations/filtered-suppliers

Authentication

Authorization
string
required
Bearer token. Format: Bearer <token>

Request Body (optional)

nameSupplier
string
Filter by supplier name (partial match supported).
categorySupplier
string
Filter by the supplier’s category classification.
region
string
Filter by region.
country
string
Filter by country code or name.

Response

data
array
List of supplier records matching the filter criteria.

HTTP Status Codes

CodeMeaning
200 OKSuppliers returned (may be empty list).
401 UnauthorizedToken missing or invalid.

Example

curl --request GET \
  --url 'https://your-gateway.example.com/api/operations/v1/operations/filtered-suppliers' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "categorySupplier": "HERB",
    "country": "France"
  }'

Get Categories

Retrieve the hierarchical product category tree used for classifying SKUs and transactions.

Endpoint

GET /api/operations/v1/operations/categories

Authentication

Authorization
string
required
Bearer token. Format: Bearer <token>

Response

data
array
List of top-level category nodes. Each category may contain nested children.

HTTP Status Codes

CodeMeaning
200 OKCategories returned.
401 UnauthorizedToken missing or invalid.

Example

curl --request GET \
  --url 'https://your-gateway.example.com/api/operations/v1/operations/categories' \
  --header 'Authorization: Bearer <token>'

Get SKU Definitions

Retrieve the SKU definition templates that govern how SKUs are structured and validated.

Endpoint

GET /api/operations/v1/operations/sku-definitions

Authentication

Authorization
string
required
Bearer token. Format: Bearer <token>

Response

Returns ApiResponse<object> — the structure of the data field is determined by the SKU definition templates configured for the tenant. The response is a flexible payload representing all active SKU definition records.

HTTP Status Codes

CodeMeaning
200 OKSKU definitions returned.
401 UnauthorizedToken missing or invalid.

Example

curl --request GET \
  --url 'https://your-gateway.example.com/api/operations/v1/operations/sku-definitions' \
  --header 'Authorization: Bearer <token>'

Build docs developers (and LLMs) love