canonical: https://jentic.com/apis/cs-cart.com/cs-cart-rest-api # CS-Cart REST API Jentic publishes the only available OpenAPI specification for CS-Cart REST API, keeping it validated and agent-ready. CS-Cart is an e-commerce platform used to run single-vendor stores and multi-vendor marketplaces, and this REST surface exposes the products, categories, orders, and users resources at version 4. The 19 endpoints cover full CRUD for the major storefront entities and authenticate with HTTP Basic auth tied to a CS-Cart admin email and API key. ## For AI agents Manage products, categories, orders, and users on a CS-Cart 4 storefront through a 19-endpoint REST surface. ## Scope Does not handle payment processing, shipping label generation, or hosting infrastructure - use for CS-Cart catalogue, order, and user management only. ## Capabilities - Create a product with title, price, category, and description on a CS-Cart storefront - Update an existing product's price, stock level, or description by ID - List orders with filtering and inspect individual order line items and totals - Create or update a customer record and tie it to placed orders - Manage the category tree by creating, renaming, or deleting categories - Delete obsolete products without affecting historical orders that referenced them ## Use cases ### Catalogue Sync from PIM Sync a product information management system into a CS-Cart storefront so merchandisers edit in one place. The agent reads canonical product data from the PIM and creates or updates each product through POST /products and PUT `/products/{id}`, mapping PIM categories to CS-Cart category IDs. This replaces error-prone CSV imports with a daily delta sync. Example prompt: For each product in the PIM, call PUT `/products/{id}` if it exists or POST /products if it does not, then update the categories array. ### Order Pipeline to ERP Push CS-Cart orders into an ERP system for fulfilment and accounting. The agent polls GET /orders for new entries, fetches detail through GET `/orders/{id}`, and posts each order into the ERP. This avoids manual order entry and gives finance a single source of truth across multiple storefronts. Example prompt: Call GET /orders with a status filter for 'processing' and POST each order detail into the ERP order endpoint. ### Inventory Reconciliation Reconcile CS-Cart stock counts against a warehouse management system at the end of every shift. The agent reads stock from the WMS, compares against GET `/products/{id}` on CS-Cart, and patches differences through PUT `/products/{id}.` This prevents oversells when warehouse counts drift from the storefront's view. Example prompt: Diff WMS stock against GET `/products/{id}` amount fields, then call PUT `/products/{id}` for any product where the values disagree. ### AI Agent Storefront Operations An AI agent acting as a merchandiser can add new products, adjust pricing, and resolve order queries through Jentic. The agent searches for the right CS-Cart REST operation, loads its schema, and executes against the Basic auth credentials in the vault. The store admin keeps full audit trails because every API call is attributed to the configured CS-Cart admin user. Example prompt: Search Jentic for 'add a product to a CS-Cart store', load the POST /products operation, and execute it with title, price, and category mapping. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/products` | List products in the catalogue | | POST | `/products` | Create a new product | | GET | `/products/{id}` | Retrieve a single product | | PUT | `/products/{id}` | Update a product's fields | | GET | `/orders` | List orders with filtering | | GET | `/orders/{id}` | Retrieve order detail and line items | | GET | `/users` | List users and customers | | GET | `/categories` | List storefront categories | ## Key resources - **Products** — Create, update, and delete catalogue products - **Categories** — Manage the storefront category tree - **Orders** — List orders and inspect line items and totals - **Users** — Create and update customer and admin user records ## Why Jentic - **Setup:** Wiring the CS-Cart REST API by hand means building the Basic auth pair from an admin email and API key, resolving your own store URL into the {store_url}/api 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 and update that product and nothing else. You choose the operations it may call, so writes like creating products are not included unless you add them. - **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 'add a product to a CS-Cart store' or 'list recent orders', and Jentic returns the matching CS-Cart 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 a managed admin REST and GraphQL surface - **Magento API** — Open-source e-commerce platform with a similarly broad REST surface - **Stripe API** — Payments and subscription billing for e-commerce checkouts ## 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? CS-Cart REST uses HTTP Basic authentication with the admin email as the username and a generated API key as the password. The store URL also has to be configured as the base for every request. Through Jentic the credentials and store URL are stored in the vault. ### Can I update product stock levels with the CS-Cart REST API? Yes. Call PUT `/products/{id}` with an amount field set to the new stock count. The storefront immediately reflects the new availability on category and product pages. ### What are the rate limits for the CS-Cart REST API? CS-Cart does not publish a hard request rate limit at the application level; throughput is bounded by the underlying PHP-FPM and database capacity of the store host. Run bulk syncs off-peak and inspect server response headers for backpressure signs. ### How do I add a product through Jentic? Search Jentic for 'add a product to a CS-Cart store' and execute the loaded POST /products operation with title, price, and category mapping. Jentic supplies the Basic credentials and store URL from the vault. ### Is the CS-Cart REST API free? The REST API is included with every CS-Cart license; there are no separate per-call fees. CS-Cart sells annual or perpetual licenses with multiple editions; pricing is published at https://www.cs-cart.com/buy-license.html. ### How do I retrieve orders for a single customer? Call GET /orders with a user_id filter (or email filter on platforms that support it) to list every order placed by a given customer, then call GET `/orders/{id}` for line items and totals. ### Can I limit what my agent is allowed to do with the CS-Cart REST API? Yes. Because you run Jentic One yourself, your own rules decide which CS-Cart operations and credentials the agent may use. You pick the exact endpoints it can call, so read-only work like GET /products and GET /orders stays separate from writes like POST /products or PUT `/products/{id}`, which are excluded unless you add them. Since CS-Cart puts the resource id in the URL path, a rule can pin the agent to a single product so it reads and updates that one record and nothing else.