Pos

Overview

The pos module synchronizes point-of-sale outlet master data for a company. A POS represents a point-of-sale outlet and depends on company. The referenced company_id must already exist.

Request

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

Request Envelope

The Pos module uses the standard Open API request envelope with pos as the module and an array of POS objects as data.

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

Request Body Fields

Field	Type	Required	Description	Example
id	string	Yes	POS outlet identifier.	POS-01
company_id	string	Yes	Identifier of the company the POS outlet belongs to. The company must already exist.	HTL-001
name	string	Yes	POS outlet name.	Main Restaurant
description	string	Optional	Optional description of the POS outlet.	—
type	string	Yes	Type of POS outlet.	RESTAURANT
use_shift	boolean	Optional	Indicates whether the POS outlet uses shifts.	true

Request Example

{
  "module": "pos",
  "data": [
    {
      "id": "POS-01",
      "company_id": "HTL-001",
      "name": "Main Restaurant",
      "type": "RESTAURANT",
      "use_shift": true
    }
  ],
  "chunk_metadata": {
    "process_id": "sync-htl001-2026-08-30",
    "chunk_sequence": 1,
    "is_last_chunk": true,
    "total_records_in_chunk": 1
  }
}