Category

Overview

The category module synchronizes POS product category master data for a company. This module depends on company. The referenced company_id must already exist. Categories can represent parent and child categories using is_parent and parent_id.

Request

• Method: POST
• Path: {{base_url}}/api/sync-master-data

Request Envelope

The Category module uses the standard Open API request envelope with category as the module and an array of category objects as data.

{
  "module": "category",
  "data": [
    {}
  ],
  "chunk_metadata": {}
}

Request Body Fields

Field	Type	Required	Description	Example
id	string	Yes	Category identifier.	CAT-01
company_id	string	Yes	Identifier of the company the category belongs to. The company must already exist.	HTL-001
name	string	Yes	Category name.	Beverage
parent_id	string	Optional	Identifier of the parent category, when applicable.	CAT-01
description	string	Optional	Optional description of the category.	—
is_parent	boolean	Optional	Indicates whether the category is a parent category.	true

Request Example

{
  "module": "category",
  "data": [
    {
      "id": "CAT-01",
      "company_id": "HTL-001",
      "name": "Beverage",
      "is_parent": true
    },
    {
      "id": "CAT-02",
      "company_id": "HTL-001",
      "name": "Soft Drink",
      "parent_id": "CAT-01",
      "is_parent": false
    }
  ],
  "chunk_metadata": {
    "process_id": "sync-htl001-2026-08-30",
    "chunk_sequence": 1,
    "is_last_chunk": true,
    "total_records_in_chunk": 2
  }
}