# Clopos Open API

## Docs

- [Generate access token](https://developer.clopos.com/api-reference/authentication/generate-access-token.md): Exchange client credentials for a short-lived JWT token used in the `x-token` header.
- [Create customer](https://developer.clopos.com/api-reference/customers/create-customer.md): Create a new customer with contact information and group assignment
- [Get Customer by ID](https://developer.clopos.com/api-reference/customers/get-customer-by-id.md): Retrieve a specific customer by their unique identifier.
- [List Customer Groups](https://developer.clopos.com/api-reference/customers/list-customer-groups.md): Retrieve a list of all customer groups with pagination support.
- [List customers](https://developer.clopos.com/api-reference/customers/list-customers.md): Retrieve all customers with pagination, filtering, and relationship inclusion
- [Get category by ID](https://developer.clopos.com/api-reference/menu/get-category-by-id.md): Retrieve a single menu category with optional hierarchy metadata
- [List categories](https://developer.clopos.com/api-reference/menu/list-categories.md): Retrieve menu categories with optional hierarchy, type and status filters
- [Create order](https://developer.clopos.com/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/api-reference/orders/get-order-by-id.md): Retrieve a specific order by its unique identifier
- [List orders](https://developer.clopos.com/api-reference/orders/list-orders.md): Retrieve orders with optional filtering and pagination
- [Update order](https://developer.clopos.com/api-reference/orders/update-order.md): Update the status of an existing order (e.g. set to IGNORE to cancel)
- [Get product by ID](https://developer.clopos.com/api-reference/products/get-product-by-id.md): Retrieve a single product by ID
- [Get stop list](https://developer.clopos.com/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 products](https://developer.clopos.com/api-reference/products/list-products.md): Retrieve all products with optional filtering and pagination
- [Close receipt](https://developer.clopos.com/api-reference/receipts/close-receipt.md): Close an existing receipt by updating its payment methods and setting the closing timestamp.
- [Get receipt by ID](https://developer.clopos.com/api-reference/receipts/get-receipt-by-id.md): Retrieve a single receipt by its identifier.
- [List receipts](https://developer.clopos.com/api-reference/receipts/list-receipts.md): Retrieve receipts with filtering, sorting, and pagination options.
- [Update receipt](https://developer.clopos.com/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.
- [List Payment Methods](https://developer.clopos.com/api-reference/sales/list-payment-methods.md): Retrieve a list of all configured payment methods.
- [List Sale Types](https://developer.clopos.com/api-reference/sales/list-sale-types.md): Retrieve a list of all available sale types.
- [Get station by ID](https://developer.clopos.com/api-reference/stations/get-station-by-id.md): Retrieve a single preparation or service station
- [List stations](https://developer.clopos.com/api-reference/stations/list-stations.md): Retrieve all preparation and service stations for the venue
- [Get User by ID](https://developer.clopos.com/api-reference/users/get-user-by-id.md): Retrieve a specific user by their unique identifier.
- [List Users](https://developer.clopos.com/api-reference/users/list-users.md): Retrieve a list of all users.
- [Authenticate (v2)](https://developer.clopos.com/api-reference/v2/authentication/auth.md): Exchange client credentials for a JWT access token
- [List Categories](https://developer.clopos.com/api-reference/v2/categories/get-categories.md): Retrieve product categories along with their hierarchical structure
- [Get Category by ID](https://developer.clopos.com/api-reference/v2/categories/get-category-by-id.md): Retrieve a specific menu category with its hierarchical details
- [Create Customer](https://developer.clopos.com/api-reference/v2/customers/create-customer.md): Create a new customer with contact information and group assignment
- [List All Customers](https://developer.clopos.com/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/api-reference/v2/customers/get-customer.md): Retrieve a specific customer by their unique identifier.
- [List Customer Groups](https://developer.clopos.com/api-reference/v2/customers/get-customer-groups.md): Retrieve a list of all customer groups with pagination support.
- [Create Order (v2)](https://developer.clopos.com/api-reference/v2/orders/create-order.md): Submit a POS order using the streamlined v2 schema
- [Get Order by ID](https://developer.clopos.com/api-reference/v2/orders/get-order-by-id.md): Retrieve a single order with status, customer, and line item details.
- [Get Orders](https://developer.clopos.com/api-reference/v2/orders/get-orders.md): Retrieve orders with replicable filters and status-based searches
- [Update Order](https://developer.clopos.com/api-reference/v2/orders/update-order.md): Update the status of an existing order
- [API Overview (v2)](https://developer.clopos.com/api-reference/v2/overview.md): Base URL and authentication changes for Clopos Open API v2
- [List Products](https://developer.clopos.com/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/api-reference/v2/products/get-product-by-id.md): Retrieve a single product with type-specific details.
- [Get Stop List](https://developer.clopos.com/api-reference/v2/products/get-stop-list.md): Get stop list data for specific products
- [Close Receipt](https://developer.clopos.com/api-reference/v2/receipts/close-receipt.md): Close an existing receipt with payment methods and closing timestamp
- [Get Receipt by ID](https://developer.clopos.com/api-reference/v2/receipts/get-receipt-by-id.md): Retrieve the full details of a specific receipt
- [List Receipts](https://developer.clopos.com/api-reference/v2/receipts/get-receipts.md): Retrieve all receipts with support for filters and sorting
- [Update Receipt (after close)](https://developer.clopos.com/api-reference/v2/receipts/patch-update-receipt.md): Update specific fields of an existing receipt
- [List Payment Methods](https://developer.clopos.com/api-reference/v2/sales/get-payment-methods.md): Retrieve a list of all configured payment methods.
- [List Sale Types](https://developer.clopos.com/api-reference/v2/sales/get-sale-types.md): Retrieve a list of all available sale types.
- [Get Station by ID](https://developer.clopos.com/api-reference/v2/stations/get-station-by-id.md): Retrieve a specific preparation or service station
- [List Stations](https://developer.clopos.com/api-reference/v2/stations/get-stations.md): Retrieve all preparation and service stations
- [Get User by ID](https://developer.clopos.com/api-reference/v2/users/get-user-by-id.md): Retrieve a specific user by their unique identifier.
- [List Users](https://developer.clopos.com/api-reference/v2/users/get-users.md): Retrieve a list of active Clopos users
- [List Venues](https://developer.clopos.com/api-reference/v2/venues/get-venues.md): Retrieve a list of all venues (locations).
- [List Venues](https://developer.clopos.com/api-reference/venues/list-venues.md): Retrieve a list of all venues (locations).
- [Authentication](https://developer.clopos.com/authentication.md): Authenticate with the Clopos Open API v2 using a JWT access token
- [Common objects](https://developer.clopos.com/common-objects.md): Shared data structures that appear across multiple Clopos Open API v2 endpoints
- [Core concepts](https://developer.clopos.com/concepts.md): How brands, venues, and integrators fit together in the Clopos Open API v2
- [Errors](https://developer.clopos.com/errors.md): Error response envelope, status codes, and common failure modes in Clopos Open API v2
- [Clopos Open API Documentation](https://developer.clopos.com/index.md): Secure and unified access to the Clopos ecosystem for POS, ordering, payments, and restaurant management services
- [Quick Start](https://developer.clopos.com/quickstart.md): Get up and running with the Clopos Open API in minutes
- [Rate limits](https://developer.clopos.com/rate-limits.md): Request quotas, response headers, and how to handle throttling on Clopos Open API v2
- [Webhooks](https://developer.clopos.com/webhooks.md): Event-driven notifications from the Clopos Open API

## OpenAPI Specs

- [openapi](https://developer.clopos.com/api-reference/v2/openapi.json)

## Optional

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