Point of Sale

Create POS Session

A single pos.config can only have one active session at a time. Before starting a new session, always check whether the pos.config record already has an active session linked to it

Get pos.config

{
  "id": "839dj3ud9829302jd",
  "action": "search_read",
  "model_id": "pos.config",
  "keyword": {
    "fields": [
      "name",
      "company_id",
      "active",
      "has_active_session"
    ],
    "context": {
      "allowed_company_ids": [
        1
      ],
      "default_company_id": 1,
      "tz": "Asia/Singapore"
    }
  },
  "params": [
    [
      [
        "active",
        "=",
        true
      ]
    ]
  ],
  "odoo_instance": {
    "url": "YOUR_ODOO_INSTANCE_URL",
    "user_id": INT(YOUR_USER_ID),
    "db": "YOUR_ODOO_DB",
    "api_key": "YOUR_ODOO_API_KEY"
  }
}

Create POS Session

{
  "id": "839dj3ud9829302jd",
  "action": "create",
  "model_id": "pos.session",
  "keyword": {
    "context": {
      "allowed_company_ids": [
        1
      ],
      "default_company_id": 1,
      "tz": "Asia/Singapore"
    }
  },
  "params": [
    [
      {
        "config_id": 1,
        "name": "Start a POS Session with ODXProxy",
        "opening_notes": "some note here (optionals)",
        "state": "opened"
      }
    ]
  ],
  "odoo_instance": {
    "url": "YOUR_ODOO_INSTANCE_URL",
    "user_id": INT(YOUR_USER_ID),
    "db": "YOUR_ODOO_DB",
    "api_key": "YOUR_ODOO_API_KEY"
  }
}

Add Order to POS Session

To fetch products, you can navigate to this endpoint

Important: Avoid repeatedly fetching products directly from Odoo in real time. Instead, cache the product data in a separate system such as Redis, Elasticsearch, vector database or local storage to improve performance and reduce load on your Odoo instance.

{
  "id": "839dj3ud9829302jd",
  "action": "create",
  "model_id": "pos.order",
  "keyword": {
    "context": {
      "allowed_company_ids": [
        1
      ],
      "default_company_id": 1,
      "tz": "Asia/Singapore"
    }
  },
  "params": [
    [
      {
        "session_id": 1,
        "name": "Start a POS Session with ODXProxy",
        "general_note": "some note here (optionals)",
        "amount_tax": 0,
        "amount_total": 150,
        "amount_paid": 150,
        "amount_return": 0,
        "state": "paid",
        "lines": [
          [0,0,
            {
              "name": "order_line_name_1",
              "product_id": 5,
              "price_unit": 10,
              "qty": 10,
              "price_subtotal": 100,
              "price_subtotal_incl": 100
            }
          ],
          [0,0,
            {
              "name": "order_line_name_2",
              "product_id": 6,
              "price_unit": 5,
              "qty": 10,
              "price_subtotal": 50,
              "price_subtotal_incl": 50
            }
          ]
        ],
        "payment_ids": [
          [
            0,
            0,
            {
              "amount": 150,
              "payment_method_id": 1
            }
          ]
        ]
      }
    ]
  ],
  "odoo_instance": {
    "url": "YOUR_ODOO_INSTANCE_URL",
    "user_id": INT(YOUR_USER_ID),
    "db": "YOUR_ODOO_DB",
    "api_key": "YOUR_ODOO_API_KEY"
  }
}

Update POS Session into "Closing Control"

{
  "id": "839dj3ud9829302jd",
  "action": "write",
  "model_id": "pos.session",
  "keyword": {
    "context": {
      "allowed_company_ids": [
        1
      ],
      "default_company_id": 1,
      "tz": "Asia/Singapore"
    }
  },
  "params": [
    [
      1
    ],
    {
      "state": "closing_control"
    }
  ],
  "odoo_instance": {
    "url": "YOUR_ODOO_INSTANCE_URL",
    "user_id": INT(YOUR_USER_ID),
    "db": "YOUR_ODOO_DB",
    "api_key": "YOUR_ODOO_API_KEY"
  }
}

Close Session & Post Entries

{
  "id": "839dj3ud9829302jd",
  "action": "call_method",
  "model_id": "pos.session",
  "keyword": {
    "context": {
      "allowed_company_ids": [
        1
      ],
      "default_company_id": 1,
      "tz": "Asia/Singapore"
    }
  },
  "params": [
    [
      1
    ]
  ],
  "fn_name": "action_pos_session_closing_control",
  "odoo_instance": {
    "url": "YOUR_ODOO_INSTANCE_URL",
    "user_id": INT(YOUR_USER_ID),
    "db": "YOUR_ODOO_DB",
    "api_key": "YOUR_ODOO_API_KEY"
  }
}