canonical: https://jentic.com/apis/opencart-api.com/opencart-admin-api # Opencart Api Documentation of Opencart Rest Admin Api Jentic publishes the only available OpenAPI specification for Documentation of Opencart Rest Admin API, keeping it validated and agent-ready. The OpenCart REST Admin API exposes the administrative surface of an OpenCart 3.x storefront for headless and integration use cases. It covers the full catalogue (products, categories, manufacturers, options, attributes), customer and customer-group management, order processing, payment and shipping methods, store and language settings, and merchandising lists such as latest, featured, and bestseller products. Authentication is performed with a per-store secret key passed in the X-Oc-Restadmin-Id header. ## For AI agents Manage an OpenCart 3.x store administratively over REST - products, categories, customers, orders, options, and store-wide settings - using a per-store secret key. ## Scope Does not handle storefront rendering, payment capture, or shipping label generation - use for OpenCart 3.x administrative catalogue, customer, and order operations only. ## Capabilities - Create, update, and delete products, including variants, options, and image assets - Manage category trees with parent, child, level, and extended pagination operations - Maintain manufacturer records and attach manufacturer images for catalogue branding - Create and update customers, customer groups, and addresses for B2B segmentation - Process orders, list order histories, and update order status from external fulfilment systems - Configure payment methods, shipping methods, store details, and language packs - Surface merchandising lists such as latest, featured, and bestseller products for storefronts ## Use cases ### Headless Catalogue Sync Sync products, categories, manufacturers, and stock levels between OpenCart and an external PIM, ERP, or marketplace channel. The /products, /categories, and /manufacturers endpoints provide the CRUD surface needed to keep the OpenCart admin database aligned with a single source of truth, removing the need to maintain custom database scripts. Example prompt: POST /products with title, model, price, and category_ids, then PUT `/products/{id}` once the marketplace returns its external SKU. ### Order Fulfilment Automation Pull new orders into a 3PL or warehouse management system, push back tracking updates, and progress order statuses through the OpenCart admin lifecycle. The order endpoints expose order, order_status, and history operations to drive multi-step fulfilment without operators logging into the OpenCart admin UI. Example prompt: Poll the orders list filtered by status 'Processing', POST tracking number into the order history, and update order_status to 'Shipped'. ### Merchandising and Personalisation Drive personalised storefront sections by reading the latest, featured, and bestseller product lists from the admin API and combining them with customer-group context. The `/products/latest`, `/products/featured`, and merchandising endpoints expose the same lists used by the OpenCart admin so external storefronts and apps can render consistent recommendations. Example prompt: GET `/products/latest/limit/12` and render the response as a 'New Arrivals' section on a custom storefront. ### AI Agent Storefront Operations Through Jentic, an AI agent can manage an OpenCart store administratively without learning the OpenCart admin UI or the 140-endpoint surface. The agent searches for the right operation, loads its schema, and submits the request with the X-Oc-Restadmin-Id header injected from your Jentic One instance. This unlocks agent-driven catalogue maintenance, price changes, and stock adjustments for OpenCart merchants. Example prompt: Through Jentic, search for 'create an OpenCart product', load POST /products, and execute it with the supplied product payload. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/categories` | List categories | | POST | `/categories` | Create a category | | DELETE | `/categories` | Delete categories | | GET | `/categories/{id}` | Read a category | | POST | `/manufacturers` | Create a manufacturer | | POST | `/manufacturers/{id}/images` | Upload a manufacturer image | | GET | `/manufacturers/limit/{limit}/page/{page}` | Paginate manufacturers | ## Key resources - **Products** — Manage product records, variants, and images - **Categories** — Maintain category trees with parent and level operations - **Manufacturers** — Manage manufacturer records and brand imagery - **Customers** — Create and manage customer accounts and groups - **Orders** — Read orders, update statuses, and append history entries - **Store and Settings** — Configure stores, languages, payments, and shipping ## Why Jentic - **Setup:** Wiring the OpenCart REST Admin API by hand means managing the admin secret key, setting the X-Oc-Restadmin-Id header on every call, and navigating a 140-endpoint admin surface yourself. Through Jentic you install once, import the OpenCart Admin API from the API Directory, store the secret key once, and your agent calls it. - **Permission scoping:** The API puts the resource id in the URL path (`/categories/{id}`, `/manufacturers/{id}/images`), so a rule can pin your agent to per-resource work: it can read a category or add a manufacturer image. You choose the operations it may call, so category deletion is not included unless you add it. - **Credential handling:** Your OpenCart admin secret key is stored once, encrypted, by your own Jentic One instance and injected into the X-Oc-Restadmin-Id header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create an OpenCart product' or 'list categories', and Jentic returns the matching operation across the admin surface with its parameter schema so the agent calls the right endpoint without navigating the OpenCart admin docs. ## Related APIs - **Shopify API** — Hosted commerce platform with a similar admin surface and broader app ecosystem. - **Magento API** — Adobe Commerce/Magento admin REST API for enterprise self-hosted commerce. - **Stripe API** — Payment processing alongside catalogue and order management. ## FAQ ### Why is there no official OpenAPI spec for Documentation of Opencart Rest Admin API? The OpenCart REST Admin extension publishes its documentation in HTML rather than as an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call OpenCart over 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 OpenCart Admin API use? The spec defines an API key scheme called ApiKeyAuth where the secret key is sent in the X-Oc-Restadmin-Id HTTP header on every request. Through Jentic, the secret key is stored encrypted in your Jentic One instance and injected into the header at request time, so the OpenCart admin secret never enters the agent's context. ### Can I create products with images and options through this API? Yes. POST /products creates the base product record, and the related image and option endpoints (such as POST `/manufacturers/{id}/images` for brand imagery and the product option endpoints listed in the spec) attach assets and variant attributes. The full catalogue surface is exposed across roughly 140 endpoints covering products, categories, manufacturers, attributes, and options. ### What are the rate limits for the OpenCart Admin API? The OpenCart REST Admin extension does not advertise hard rate limits in the spec - limits depend on the underlying OpenCart hosting and any web application firewall in front of it. For production loads, batch CRUD calls and avoid tight loops on `/products/limit/{limit}/page/{page}` pagination to prevent saturating the storefront database. ### How do I list categories through Jentic? Search Jentic for 'list OpenCart categories', load GET /categories or GET `/categories/level/{level}`, and execute it with the X-Oc-Restadmin-Id header injected from your Jentic One instance. Jentic returns the parsed response so an agent can iterate over categories without writing HTTP client code. ### Is the OpenCart Admin API free? OpenCart itself is open source and free to self-host, but the REST Admin extension that exposes this 140-endpoint surface is a paid commercial extension distributed via opencart-api.com. Once installed on a self-hosted OpenCart store, there are no per-call charges from OpenCart itself. ### Can I limit what my agent is allowed to do with the OpenCart Admin API? Yes. Because you run Jentic One yourself, your own rules decide which of the roughly 140 OpenCart admin operations the agent may call and which credentials it may use. Since the API puts the resource id in the URL path, such as `/categories/{id}` and `/manufacturers/{id}/images`, you can pin the agent to per-resource work like reading a category or adding a manufacturer image. Destructive operations such as DELETE /categories are excluded unless you explicitly grant them.