Magento 2 API

Name: Magento 2 API
Brand: Magento 2 API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentE CommerceStorefrontbearer24 EndpointsREST

For Agents

Manage Magento 2 catalogues, orders, customers, carts and CMS content through 24 REST endpoints covering the full storefront lifecycle.

Install Jentic One Beta

Connect the Magento 2 API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Magento 2 API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Magento 2 API.

Manage product listings via /products endpoints supporting list, create, retrieve by SKU, update and delete

Maintain category hierarchies through /categories with full create, retrieve, update and delete coverage

Process and fulfil sales orders, invoices, shipments and credit memos via dedicated endpoints

GET STARTED

Start building with Magento 2 API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Magento 2 API for, with concrete tasks.

★ Catalogue Management

Run bulk product and category operations against a Magento storefront. POST /products creates new SKUs, GET /products lists existing ones, and PUT /products/{sku} applies attribute changes such as price, stock or description. The /categories endpoints maintain the merchandising hierarchy. Suitable for ops teams syncing product data from a PIM or running seasonal price changes.

POST /products with the new SKU payload and then PUT /categories/{id} to attach the SKU to the seasonal landing category

Order and Fulfilment Processing

Drive the order-to-cash flow against Magento orders. GET /orders polls new orders, POST /invoices issues an invoice once payment captures, POST /shipments creates a shipment when goods leave the warehouse, and POST /creditmemos handles refunds. The agent can chain these calls to deliver a fully automated fulfilment pipeline.

Poll GET /orders for new entries, POST /invoices to invoice the order, then POST /shipments when goods are dispatched

Stock and Inventory Sync

Keep Magento stock levels aligned with an external warehouse system. GET /stockItems lists current stock records, POST /stockItems creates a record for a new SKU, and PUT /stockItems/{id} updates the quantity. The agent can run this on a schedule to push warehouse counts into Magento before storefront browsing reflects out-of-stock states.

PUT /stockItems/{id} for every SKU with a changed quantity in the warehouse export feed

Customer Account Administration

Manage customer records and authentication for support and onboarding workflows. GET /customers lists accounts, POST /customers provisions new ones, and POST /integration/customer/token issues a customer-scoped access token for delegated calls. Useful for support agents resetting accounts or onboarding flows that import bulk customer data.

POST /customers to create the new account, then POST /integration/customer/token to mint a session token for the storefront

AI Agent Storefront Operations

Let an AI agent operate a Magento storefront end-to-end without holding raw admin credentials. Through Jentic the agent searches for catalogue, order or stock operations, loads the schema for the relevant /products, /orders or /stockItems endpoint, and executes with credentials brokered by the vault. Suitable for retail ops assistants and merchandising bots.

Search Jentic for 'create a magento product', load POST /products, and execute with the agent-provided SKU and price payload

Key Endpoints

24 endpoints — jentic publishes the only available openapi specification for magento 2 api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/products

Create a new product

PUT

/products/{sku}

Update a product by SKU

GET

/orders

List orders

POST

/invoices

Issue an invoice

POST

/shipments

Create a shipment record

POST

/creditmemos

Create a credit memo for refunds

PUT

/stockItems/{id}

Update stock quantity

POST

/integration/admin/token

Get an admin access token

POST

/products

Create a new product

PUT

/products/{sku}

Update a product by SKU

GET

/orders

List orders

POST

/invoices

Issue an invoice

POST

/shipments

Create a shipment record

POST

/creditmemos

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Magento bearer tokens are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — the admin or customer token never enters the agent's context, so prompt leakage cannot expose the underlying credential.

Intent-based discovery

Agents search by intent (e.g. 'create a magento product' or 'issue a magento refund') and Jentic returns the matching /products, /orders or /creditmemos operation along with its input schema, so the agent picks the right endpoint without browsing the Magento docs.

Time to first call

Direct Magento integration: 3-5 days for token issuance, retry logic and schema mapping across 24 endpoints. Through Jentic: under 2 hours — search, load schema, execute.

FAQs

Specific to using Magento 2 API through Jentic.

Why is there no official OpenAPI spec for Magento 2 API?

Adobe Commerce does not publish a curated OpenAPI specification for Magento 2 — its docs use a custom Swagger-style schema generator. Jentic generates and maintains this spec so AI agents and developers can call the Magento REST API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Magento 2 API use?

The API uses bearer tokens (the BearerAuth scheme in the spec). Tokens are minted by POSTing to /integration/admin/token (admin scope) or /integration/customer/token (customer scope). Through Jentic these tokens are stored encrypted in the MAXsystem vault, so an agent calls /products or /orders with a scoped token rather than handling raw credentials.

Can I create products and categories through the Magento 2 API?

Yes. POST /products creates a SKU and POST /categories creates a category, both at the {store_url}/rest/V1 base path. PUT /products/{sku} and PUT /categories/{id} apply updates, and DELETE handles removal. The same pattern applies to customers, carts, invoices, shipments and CMS content.

What are the rate limits for the Magento 2 API?

Magento does not enforce platform-wide REST rate limits in the spec; limits are typically driven by the underlying server's configuration and any rate-limiting Adobe Commerce Cloud or Fastly applies in front of the store. For high-volume sync workloads, batch via /products and stagger calls based on your store's observed throughput.

How do I update inventory levels with the Magento 2 API through Jentic?

Run pip install jentic, search for 'update magento stock', and Jentic surfaces PUT /stockItems/{id} with its input schema. Execute with the SKU stock item id and the new quantity, and Jentic returns the updated stock record. The same flow works for batch updates by iterating over the warehouse export.

Can the Magento 2 API issue refunds?

Yes. POST /creditmemos creates a credit memo against an existing order, which is the canonical Magento mechanism for refunds. Pair this with PUT /orders/{id} to update the order state if a partial refund or comment is needed.

Magento 2 API

Connect the Magento 2 API to your agent

Capabilities

Start building with Magento 2 API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs