canonical: https://jentic.com/apis/cs-cart.com/cs-cart-rest-api-read # CS-Cart REST API Jentic publishes the only available OpenAPI specification for CS-Cart REST API, keeping it validated and agent-ready. This is a slimmer slice of the CS-Cart REST surface focused on read-heavy access to products, orders, users, and categories under the `/api/2.0` base path. The eight catalogued endpoints suit reporting, lightweight catalogue browsing, and read-mostly automations rather than full storefront management. ## For AI agents Read products, orders, users, and categories from a CS-Cart store through a small set of REST endpoints under `/api/2.0.` ## Scope Does not include write operations, payment processing, or shipping label generation - use for read-only access to CS-Cart catalogue, orders, users, and categories only. ## Capabilities - List the products on a CS-Cart storefront with pagination and basic filtering - Retrieve a single product by its ID with full attribute payload - List orders placed against the store, useful for reporting pipelines - Look up customer users on the store to attach orders to CRM records - List the storefront category tree for navigation generation ## Use cases ### Catalogue Export for Search Indexing Export every product on a CS-Cart storefront into an external search index like Algolia or Elasticsearch. The agent pages through GET /products and pushes each record into the index, refreshing the index on a schedule. Because this slice is read-mostly, it suits unattended nightly jobs that should not have write capability. Example prompt: Page through GET /products with limit=100 and push each item into the search index, persisting the last seen page cursor. ### Reporting Pipeline Pull orders into a data warehouse for finance and operations reporting. The agent calls GET /orders on a schedule, transforms each record, and writes it to BigQuery, Snowflake, or Postgres. Because the surface is small, the integration is easy to lock down with a dedicated read-only API key without exposing write endpoints. Example prompt: Call GET /orders with a date filter for yesterday and write the resulting rows into the warehouse staging table. ### CRM Customer Enrichment Enrich CRM contacts with their CS-Cart purchase history. The agent looks up customers by email through the users endpoint, then fetches their orders and computes lifetime value or last-order-date attributes. This keeps the CRM aligned with what the storefront knows without granting write access. Example prompt: Call GET /users with an email filter, then GET /orders with the matching user_id, and compute lifetime value for the CRM record. ### AI Agent Read-Only Catalogue Access An AI agent answering customer or merchandiser questions about catalogue and order state can use this slim slice without ever needing write privileges. Through Jentic the agent searches for the right read operation, loads its schema, and executes against credentials in the vault. The minimal surface area limits blast radius if a prompt injection coerces the agent into unintended calls. Example prompt: Search Jentic for 'list CS-Cart products' and execute GET /products with a category filter to answer a merchandiser's question. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/products` | List products in the catalogue | | GET | `/products/{id}` | Retrieve a single product | | GET | `/orders` | List orders for reporting | | GET | `/users` | List users and customers | | GET | `/categories` | List storefront categories | ## Key resources - **Products** — Read products with pagination and inspect single products by ID - **Orders** — Read orders for reporting and reconciliation - **Users** — Read customer and admin user records - **Categories** — Read the storefront category tree ## Why Jentic - **Setup:** Wiring this read-only CS-Cart REST API by hand means building the Basic auth pair from an admin email and API key, resolving your own store domain into the {store_domain}/api/2.0 base, and handling retries yourself. Through Jentic you install once, import the CS-Cart REST API from the API Directory, store the email and API key once, and your agent calls it. - **Permission scoping:** CS-Cart puts the resource id in the URL path (`/products/{id}`), so a rule can pin your agent to one product: it can read that product and nothing else. This surface exposes read operations across products, orders, users, and categories, so you choose which of those the agent may call. - **Credential handling:** Your CS-Cart admin email and API key are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'list CS-Cart products' or 'export CS-Cart orders', and Jentic returns the matching read operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Shopify API** — Hosted e-commerce platform with managed REST and GraphQL admin APIs - **Magento API** — Open-source e-commerce platform with a similarly broad REST surface - **CS-Cart API** — The full CS-Cart 2.0 REST surface with write operations across 57 endpoints ## FAQ ### Why is there no official OpenAPI spec for CS-Cart REST API? CS-Cart does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CS-Cart REST API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the CS-Cart REST API use? This slice uses HTTP Basic authentication with the admin email as username and a generated API key as password, against the store's own domain at `/api/2.0.` Through Jentic the credentials and store domain are stored in the vault. ### Can I create products with this CS-Cart REST API slice? This catalogued slice is read-mostly and exposes GET endpoints for products, orders, users, and categories. For write operations, use the broader CS-Cart API (api_slug: main) which exposes POST and PUT across the same resources. ### What are the rate limits for the CS-Cart REST API? CS-Cart does not publish an application-level request rate limit; throughput is governed by the host's PHP-FPM and database capacity. Spread bulk reads across off-peak windows and use limit and page parameters on /products and /orders. ### How do I list orders for reporting through Jentic? Search Jentic for 'list CS-Cart orders' and execute the loaded GET /orders operation with date filters. Jentic supplies the Basic credentials and store domain from the vault and returns the rows for downstream warehouse loading. ### Is the CS-Cart REST API free? The REST API is included with every CS-Cart license; there is no per-call fee. License pricing is published at https://www.cs-cart.com/buy-license.html. ### How do I page through products? Pass page and items_per_page (or limit) query parameters to GET /products and increment until the response returns fewer items than the page size. CS-Cart returns the total count in the response so progress can be tracked deterministically. ### Can I limit what my agent is allowed to do with the CS-Cart REST API? Yes. Jentic One is self-hosted, so your own rules decide which of this slice's read operations the agent may call across products, orders, users, and categories. Because CS-Cart puts the resource id in the URL path, such as GET `/products/{id}`, a rule can pin the agent to a single product so it reads that record and nothing else. You also control which stored credentials and store domain the agent may use at execution time.