# Clopos Open API

- [Clopos Open API Documentation](https://developer.clopos.com/docs/index.md): Secure and unified access to the Clopos ecosystem for POS, ordering, payments, and restaurant management services
- [Quick Start](https://developer.clopos.com/docs/quickstart.md): Get up and running with the Clopos Open API in minutes
- [Authentication](https://developer.clopos.com/docs/authentication.md): Authenticate with the Clopos Open API v2 using a JWT access token
- [Core concepts](https://developer.clopos.com/docs/concepts.md): How brands, venues, and integrators fit together in the Clopos Open API v2
- [Common objects](https://developer.clopos.com/docs/common-objects.md): Shared data structures that appear across multiple Clopos Open API v2 endpoints
- [Rate limits](https://developer.clopos.com/docs/rate-limits.md): Request quotas, response headers, and how to handle throttling on Clopos Open API v2
- [Errors](https://developer.clopos.com/docs/errors.md): Error response envelope, status codes, and common failure modes in Clopos Open API v2
- [Webhooks](https://developer.clopos.com/docs/webhooks.md): Event-driven notifications from the Clopos Open API
- [API Overview (v2)](https://developer.clopos.com/docs/api-reference/v2/overview.md): Base URL and authentication changes for Clopos Open API v2
- [Authenticate (v2)](https://developer.clopos.com/docs/api-reference/v2/authentication/auth.md): Exchange client credentials for a JWT access token
- [List Venues](https://developer.clopos.com/docs/api-reference/v2/venues/get-venues.md): Retrieve a list of all venues (locations).
- [List Users](https://developer.clopos.com/docs/api-reference/v2/users/get-users.md): Retrieve a list of active Clopos users
- [Get User by ID](https://developer.clopos.com/docs/api-reference/v2/users/get-user-by-id.md): Retrieve a specific user by their unique identifier.
- [List All Customers](https://developer.clopos.com/docs/api-reference/v2/customers/get-all-customers.md): Retrieve all customers with pagination, filtering, and relationship inclusion.
- [Get Customer by ID](https://developer.clopos.com/docs/api-reference/v2/customers/get-customer.md): Retrieve a specific customer by their unique identifier.
- [Create Customer](https://developer.clopos.com/docs/api-reference/v2/customers/create-customer.md): Create a new customer with contact information and group assignment
- [List Customer Groups](https://developer.clopos.com/docs/api-reference/v2/customers/get-customer-groups.md): Retrieve a list of all customer groups with pagination support.
- [List Categories](https://developer.clopos.com/docs/api-reference/v2/categories/get-categories.md): Retrieve product categories along with their hierarchical structure
- [Get Category by ID](https://developer.clopos.com/docs/api-reference/v2/categories/get-category-by-id.md): Retrieve a specific menu category with its hierarchical details
- [List Stations](https://developer.clopos.com/docs/api-reference/v2/stations/get-stations.md): Retrieve all preparation and service stations
- [Get Station by ID](https://developer.clopos.com/docs/api-reference/v2/stations/get-station-by-id.md): Retrieve a specific preparation or service station
- [List Products](https://developer.clopos.com/docs/api-reference/v2/products/get-all-products.md): Get the product catalog with advanced filtering and pagination.
- [Get Product by ID](https://developer.clopos.com/docs/api-reference/v2/products/get-product-by-id.md): Retrieve a single product with type-specific details.
- [Get Stop List](https://developer.clopos.com/docs/api-reference/v2/products/get-stop-list.md): Get stop list data for specific products
- [List Price Lists](https://developer.clopos.com/docs/api-reference/v2/price-lists/get-price-lists.md): Retrieve all price lists configured for the brand.
- [List Prices](https://developer.clopos.com/docs/api-reference/v2/price-lists/get-prices.md): Retrieve the individual product prices that belong to price lists.
- [List Sale Types](https://developer.clopos.com/docs/api-reference/v2/sales/get-sale-types.md): Retrieve a list of all available sale types.
- [List Payment Methods](https://developer.clopos.com/docs/api-reference/v2/sales/get-payment-methods.md): Retrieve a list of all configured payment methods.
- [Get Orders](https://developer.clopos.com/docs/api-reference/v2/orders/get-orders.md): Retrieve orders with replicable filters and status-based searches
- [Get Order by ID](https://developer.clopos.com/docs/api-reference/v2/orders/get-order-by-id.md): Retrieve a single order with status, customer, and line item details.
- [Create Order (v2)](https://developer.clopos.com/docs/api-reference/v2/orders/create-order.md): Submit a POS order using the streamlined v2 schema
- [Update Order](https://developer.clopos.com/docs/api-reference/v2/orders/update-order.md): Update the status of an existing order
- [List Receipts](https://developer.clopos.com/docs/api-reference/v2/receipts/get-receipts.md): Retrieve all receipts with support for filters and sorting
- [Get Receipt by ID](https://developer.clopos.com/docs/api-reference/v2/receipts/get-receipt-by-id.md): Retrieve the full details of a specific receipt
- [Get Receipt by CID](https://developer.clopos.com/docs/api-reference/v2/receipts/get-receipt-by-cid.md): Retrieve a receipt by its cid UUID.
- [Get Receipt Stock Operations](https://developer.clopos.com/docs/api-reference/v2/receipts/get-receipt-stock-operations.md): Retrieve the stock deductions ("Çıxarılan ehtiyat") generated by a receipt
- [Close Receipt](https://developer.clopos.com/docs/api-reference/v2/receipts/close-receipt.md): Close an existing receipt with payment methods and closing timestamp
- [Update Receipt (after close)](https://developer.clopos.com/docs/api-reference/v2/receipts/patch-update-receipt.md): Update specific fields of an existing receipt
- [List Stock](https://developer.clopos.com/docs/api-reference/v2/inventory/get-stock.md): Current stock levels per product and storage.
- [Stock Totals](https://developer.clopos.com/docs/api-reference/v2/inventory/get-stock-total.md): Aggregate stock value and quantity.
- [Stock Info](https://developer.clopos.com/docs/api-reference/v2/inventory/get-stock-info.md): Summary information about stock across storages.
- [Stock by Product](https://developer.clopos.com/docs/api-reference/v2/inventory/get-stock-by-product.md): Stock resolved per product.
- [Stock by Product Group](https://developer.clopos.com/docs/api-reference/v2/inventory/get-stock-by-product-group.md): Stock aggregated by product group.
- [Get Stock by ID](https://developer.clopos.com/docs/api-reference/v2/inventory/get-stock-by-id.md): Retrieve a single stock row.
- [List Stock Operations](https://developer.clopos.com/docs/api-reference/v2/inventory/get-stock-operations.md): Every stock movement.
- [Stock Operation Totals](https://developer.clopos.com/docs/api-reference/v2/inventory/get-stock-operations-total.md): Aggregate quantity and cost.
- [Stock Operations by Product](https://developer.clopos.com/docs/api-reference/v2/inventory/get-stock-operations-by-product.md): Per-product movement view.
- [Get Stock Operation by ID](https://developer.clopos.com/docs/api-reference/v2/inventory/get-stock-operation-by-id.md): Retrieve a single movement.
- [List Storages](https://developer.clopos.com/docs/api-reference/v2/inventory/get-storages.md): Storage locations.
- [Get Storage by ID](https://developer.clopos.com/docs/api-reference/v2/inventory/get-storage-by-id.md): Retrieve a single storage.
- [List Suppliers](https://developer.clopos.com/docs/api-reference/v2/inventory/get-suppliers.md): Suppliers goods are purchased from.
- [Supplier Totals](https://developer.clopos.com/docs/api-reference/v2/inventory/get-suppliers-total.md): Aggregate spend and balance.
- [Get Supplier by ID](https://developer.clopos.com/docs/api-reference/v2/inventory/get-supplier-by-id.md): Retrieve a single supplier.
- [List Operations](https://developer.clopos.com/docs/api-reference/v2/inventory/get-operations.md): Inventory documents.
- [Operation Totals](https://developer.clopos.com/docs/api-reference/v2/inventory/get-operations-total.md): Aggregate subtotal.
- [Operation Statuses](https://developer.clopos.com/docs/api-reference/v2/inventory/get-operation-statuses.md): The status vocabulary.
- [Get Operation by ID](https://developer.clopos.com/docs/api-reference/v2/inventory/get-operation-by-id.md): Retrieve a single document.
- [Get Operation Items](https://developer.clopos.com/docs/api-reference/v2/inventory/get-operation-items.md): Line items of one document.
- [List Operation Items](https://developer.clopos.com/docs/api-reference/v2/inventory/list-operation-items.md): Line items across documents.
- [Operation Item Totals](https://developer.clopos.com/docs/api-reference/v2/inventory/list-operation-items-total.md): Aggregate quantity and cost.
- [List Finance Categories](https://developer.clopos.com/docs/api-reference/v2/finance/get-finance-categories.md): Categories money movements are classified under.
- [Get Finance Category by ID](https://developer.clopos.com/docs/api-reference/v2/finance/get-finance-category-by-id.md): Retrieve a single category.
- [List Balances](https://developer.clopos.com/docs/api-reference/v2/finance/get-balances.md): Cash and bank accounts.
- [Balance List](https://developer.clopos.com/docs/api-reference/v2/finance/get-balances-list.md): Condensed account list.
- [Balance Date States](https://developer.clopos.com/docs/api-reference/v2/finance/get-balance-date-states.md): Per-date balance states.
- [Customer Balances](https://developer.clopos.com/docs/api-reference/v2/finance/get-customer-balances.md): Balances held against customers.
- [Balance Transactions](https://developer.clopos.com/docs/api-reference/v2/finance/get-balance-transactions.md): Transactions grouped by account.
- [Get Balance by ID](https://developer.clopos.com/docs/api-reference/v2/finance/get-balance-by-id.md): Retrieve a single account.
- [List Transactions](https://developer.clopos.com/docs/api-reference/v2/finance/get-transactions.md): Money movements.
- [Get Transaction by ID](https://developer.clopos.com/docs/api-reference/v2/finance/get-transaction-by-id.md): Retrieve a single transaction.
- [List Taxes](https://developer.clopos.com/docs/api-reference/v2/finance/get-taxes.md): Configured tax rates.
- [Tax Types](https://developer.clopos.com/docs/api-reference/v2/finance/get-tax-types.md): The tax type vocabulary.
- [Tax Report](https://developer.clopos.com/docs/api-reference/v2/finance/get-tax-report.md): Tax report over a period.
- [Tax Totals](https://developer.clopos.com/docs/api-reference/v2/finance/get-tax-total.md): Aggregate tax amounts.
- [Get Tax by ID](https://developer.clopos.com/docs/api-reference/v2/finance/get-tax-by-id.md): Retrieve a single tax rate.
- [List Cash Shifts](https://developer.clopos.com/docs/api-reference/v2/finance/get-cash-shifts.md): Till sessions.
- [Get Cash Shift by ID](https://developer.clopos.com/docs/api-reference/v2/finance/get-cash-shift-by-id.md): Retrieve a single shift.
- [Cash Shift Report](https://developer.clopos.com/docs/api-reference/v2/finance/get-cash-shift-report.md): Totals for one shift.
- [Waiter Call](https://developer.clopos.com/docs/api-reference/v2/waiter-call/waiter-call.md): Trigger a waiter call or a payment request for a table
- [Generate access token](https://developer.clopos.com/docs/api-reference/authentication/generate-access-token.md): Exchange client credentials for a short-lived JWT token used in the `x-token` header.
- [List Venues](https://developer.clopos.com/docs/api-reference/venues/list-venues.md): Retrieve a list of all venues (locations).
- [List Users](https://developer.clopos.com/docs/api-reference/users/list-users.md): Retrieve a list of all users.
- [Get User by ID](https://developer.clopos.com/docs/api-reference/users/get-user-by-id.md): Retrieve a specific user by their unique identifier.
- [List customers](https://developer.clopos.com/docs/api-reference/customers/list-customers.md): Retrieve all customers with pagination, filtering, and relationship inclusion
- [Create customer](https://developer.clopos.com/docs/api-reference/customers/create-customer.md): Create a new customer with contact information and group assignment
- [Get Customer by ID](https://developer.clopos.com/docs/api-reference/customers/get-customer-by-id.md): Retrieve a specific customer by their unique identifier.
- [List Customer Groups](https://developer.clopos.com/docs/api-reference/customers/list-customer-groups.md): Retrieve a list of all customer groups with pagination support.
- [List categories](https://developer.clopos.com/docs/api-reference/menu/list-categories.md): Retrieve menu categories with optional hierarchy, type and status filters
- [Get category by ID](https://developer.clopos.com/docs/api-reference/menu/get-category-by-id.md): Retrieve a single menu category with optional hierarchy metadata
- [List stations](https://developer.clopos.com/docs/api-reference/stations/list-stations.md): Retrieve all preparation and service stations for the venue
- [Get station by ID](https://developer.clopos.com/docs/api-reference/stations/get-station-by-id.md): Retrieve a single preparation or service station
- [List products](https://developer.clopos.com/docs/api-reference/products/list-products.md): Retrieve all products with optional filtering and pagination
- [Get product by ID](https://developer.clopos.com/docs/api-reference/products/get-product-by-id.md): Retrieve a single product by ID
- [Get stop list](https://developer.clopos.com/docs/api-reference/products/get-stop-list.md): Retrieve stop list data for specific products. The stop list indicates product limitations such as stock limits.
- [List Sale Types](https://developer.clopos.com/docs/api-reference/sales/list-sale-types.md): Retrieve a list of all available sale types.
- [List Payment Methods](https://developer.clopos.com/docs/api-reference/sales/list-payment-methods.md): Retrieve a list of all configured payment methods.
- [List Price Lists](https://developer.clopos.com/docs/api-reference/price-lists/list-price-lists.md): Retrieve all price lists. A price list is a named set of product prices that can be applied to specific venues or sales channels (for example, a separate menu price list for delivery).
- [List Prices](https://developer.clopos.com/docs/api-reference/price-lists/list-prices.md): Retrieve the individual product prices that belong to price lists. Each entry maps a product to its price within a given price list.
- [List orders](https://developer.clopos.com/docs/api-reference/orders/list-orders.md): Retrieve orders with optional filtering and pagination
- [Create order](https://developer.clopos.com/docs/api-reference/orders/create-order.md): Create a new order using the streamlined v2 payload with flat schema, customer object, and products array.
- [Get order by ID](https://developer.clopos.com/docs/api-reference/orders/get-order-by-id.md): Retrieve a specific order by its unique identifier
- [Update order](https://developer.clopos.com/docs/api-reference/orders/update-order.md): Update the status of an existing order (e.g. set to IGNORE to cancel)
- [List receipts](https://developer.clopos.com/docs/api-reference/receipts/list-receipts.md): Retrieve receipts with filtering, sorting, and pagination options.
- [Get receipt by ID](https://developer.clopos.com/docs/api-reference/receipts/get-receipt-by-id.md): Retrieve a single receipt by its identifier.
- [Update receipt](https://developer.clopos.com/docs/api-reference/receipts/update-receipt.md): Update specific fields of an existing receipt. Only provided fields will be updated. Can update receipts even after they are closed.
- [Close receipt](https://developer.clopos.com/docs/api-reference/receipts/close-receipt.md): Close an existing receipt by updating its payment methods and setting the closing timestamp.
- [Get receipt stock operations](https://developer.clopos.com/docs/api-reference/receipts/get-receipt-stock-operations.md): Retrieve the stock deduction operations generated by a receipt ("Çıxarılan ehtiyat"). Returns only the stock write-offs caused by the receipt itself, where `operation_id` is `null` and `receipt_product_id` is set. Each item reports the quantity and cost movement per stock and storage, together with…
- [Get Receipt by CID](https://developer.clopos.com/docs/api-reference/receipts/get-receipt-by-cid.md): Retrieve a receipt by the `cid` UUID terminals key it by. Returns the same payload as retrieving it by numeric id.
- [List Stock](https://developer.clopos.com/docs/api-reference/inventory/list-stock.md): Current stock levels, grouped by product.
- [Stock Totals](https://developer.clopos.com/docs/api-reference/inventory/stock-totals.md): Aggregate stock value and quantity for the current filters.
- [Stock Info](https://developer.clopos.com/docs/api-reference/inventory/stock-info.md): Summary information about stock across storages.
- [Stock by Product](https://developer.clopos.com/docs/api-reference/inventory/stock-by-product.md): Stock rows resolved per product rather than per storage row.
- [Stock by Product Group](https://developer.clopos.com/docs/api-reference/inventory/stock-by-product-group.md): Stock aggregated by product group. Proxies to client-api `stock/productGroup`.
- [Get Stock by ID](https://developer.clopos.com/docs/api-reference/inventory/get-stock-by-id.md): Retrieve a single stock row.
- [List Stock Operations](https://developer.clopos.com/docs/api-reference/inventory/list-stock-operations.md): Every stock movement: supplies, waste, transfers and the deductions receipts cause.
- [Stock Operation Totals](https://developer.clopos.com/docs/api-reference/inventory/stock-operation-totals.md): Aggregate quantity and cost for the current filters.
- [Stock Operations by Product](https://developer.clopos.com/docs/api-reference/inventory/stock-operations-by-product.md): Per-product view of stock movement. Proxies to client-api `stock-operations/follow/products`.
- [Get Stock Operation by ID](https://developer.clopos.com/docs/api-reference/inventory/get-stock-operation-by-id.md): Retrieve a single stock movement.
- [List Storages](https://developer.clopos.com/docs/api-reference/inventory/list-storages.md): Storage locations stock is tracked against.
- [Get Storage by ID](https://developer.clopos.com/docs/api-reference/inventory/get-storage-by-id.md): Retrieve a single storage.
- [List Suppliers](https://developer.clopos.com/docs/api-reference/inventory/list-suppliers.md): Suppliers goods are purchased from.
- [Supplier Totals](https://developer.clopos.com/docs/api-reference/inventory/supplier-totals.md): Aggregate spend and balance across suppliers.
- [Get Supplier by ID](https://developer.clopos.com/docs/api-reference/inventory/get-supplier-by-id.md): Retrieve a single supplier.
- [List Operations](https://developer.clopos.com/docs/api-reference/inventory/list-operations.md): Inventory documents: supply, waste, transfer, produce and inventory checks.
- [Operation Totals](https://developer.clopos.com/docs/api-reference/inventory/operation-totals.md): Aggregate subtotal for the current filters.
- [Operation Statuses](https://developer.clopos.com/docs/api-reference/inventory/operation-statuses.md): The status vocabulary, with localised display names.
- [Get Operation by ID](https://developer.clopos.com/docs/api-reference/inventory/get-operation-by-id.md): Retrieve a single inventory document.
- [Get Operation Items](https://developer.clopos.com/docs/api-reference/inventory/get-operation-items.md): Line items belonging to one operation.
- [List Operation Items](https://developer.clopos.com/docs/api-reference/inventory/list-operation-items.md): Operation line items across all documents.
- [Operation Item Totals](https://developer.clopos.com/docs/api-reference/inventory/operation-item-totals.md): Aggregate quantity and cost for the current filters. Sending with[]=group_by_storage_id returns one row per storage instead.
- [List Finance Categories](https://developer.clopos.com/docs/api-reference/finance/list-finance-categories.md): Categories money movements are classified under.
- [Get Finance Category by ID](https://developer.clopos.com/docs/api-reference/finance/get-finance-category-by-id.md): Retrieve a single finance category.
- [List Balances](https://developer.clopos.com/docs/api-reference/finance/list-balances.md): Cash and bank accounts with their current balance.
- [Balance List](https://developer.clopos.com/docs/api-reference/finance/balance-list.md): Condensed account list for selectors.
- [Balance Date States](https://developer.clopos.com/docs/api-reference/finance/balance-date-states.md): Per-date balance states across the requested range.
- [Customer Balances](https://developer.clopos.com/docs/api-reference/finance/customer-balances.md): Balances held against customers.
- [Balance Transactions](https://developer.clopos.com/docs/api-reference/finance/balance-transactions.md): Transactions grouped by account. Proxies to client-api `finance/balance/transaction`.
- [Get Balance by ID](https://developer.clopos.com/docs/api-reference/finance/get-balance-by-id.md): Retrieve a single account.
- [List Transactions](https://developer.clopos.com/docs/api-reference/finance/list-transactions.md): Money movements in and out of accounts.
- [Get Transaction by ID](https://developer.clopos.com/docs/api-reference/finance/get-transaction-by-id.md): Retrieve a single transaction.
- [List Taxes](https://developer.clopos.com/docs/api-reference/finance/list-taxes.md): Tax rates configured for the brand.
- [Tax Types](https://developer.clopos.com/docs/api-reference/finance/tax-types.md): The tax type vocabulary. Proxies to client-api `finance/tax/types`.
- [Tax Report](https://developer.clopos.com/docs/api-reference/finance/tax-report.md): Tax report over the requested period. Proxies to client-api `finance/tax/report`.
- [Tax Totals](https://developer.clopos.com/docs/api-reference/finance/tax-totals.md): Aggregate tax amounts. Proxies to client-api `finance/tax/total`.
- [Get Tax by ID](https://developer.clopos.com/docs/api-reference/finance/get-tax-by-id.md): Retrieve a single tax rate.
- [List Cash Shifts](https://developer.clopos.com/docs/api-reference/finance/list-cash-shifts.md): Till sessions opened and closed on terminals.
- [Get Cash Shift by ID](https://developer.clopos.com/docs/api-reference/finance/get-cash-shift-by-id.md): Retrieve a single cash shift. The identifier is a UUID.
- [Cash Shift Report](https://developer.clopos.com/docs/api-reference/finance/cash-shift-report.md): Sales, refunds and cash in/out totals for one shift.

## OpenAPI Specs

- [openapi](/api-reference/v1/openapi.json)
- [openapi](/api-reference/v2/openapi.json)

## Optional

- [Contact Support](mailto:dev@clopos.com)