List Stock

Read what is currently on hand. Each row is a product in one storage, with quantity on hand and reserved held by open receipts.

HTTP Request

GET https://integrations.clopos.com/open-api/v2/stock

This endpoint requires authentication. Include your JWT in the x-token header. See Authentication for how to obtain a token and Errors for error responses.

Access

Requirement	Value
Integrator scope	`stock:read`
User ability	`STOCK_VIEW`

The integration user must hold the ability as well as the scope — the scope alone is not enough.

Request Example

curl --location "https://integrations.clopos.com/open-api/v2/stock" \
  -H "x-token: oauth_example_token"

const response = await fetch('https://integrations.clopos.com/open-api/v2/stock', {
  headers: { 'x-token': 'oauth_example_token' }
});
const data = await response.json();

import requests

response = requests.get(
    "https://integrations.clopos.com/open-api/v2/stock",
    headers={"x-token": "oauth_example_token"},
)
data = response.json()

Notes

Use /v2/stock/total for the aggregate, and /v2/storages to resolve storage_id.

Overview

Auth

Venues

Users

Customers

Categories

Station

Products

Price Lists

Sales

Orders

Receipts

Inventory

Finance

Tables

HTTP Request

Access

Request Example

Notes

​HTTP Request

​Access

​Request Example

​Notes

HTTP Request

Access

Request Example

Notes