Magento 2 Skill

Manage a Magento 2 / Adobe Commerce store via REST API. Use for orders, catalog, customers, inventory, promotions, and sales reporting. It can also discover...

view source

installs

stars

karma

SkillRank score ↗

8.2/ 10

evaluated by implexa, claude-haiku-4-5 · 2026-06-12

magento2 connects to adobe commerce stores via oauth 1.0a rest api, covering orders, catalog, customers, inventory, promotions, reporting, and system diagnostics. multi-site support and bulk operations included. read-only operations execute directly; writes require explicit confirmation.

structure

9.0

trigger phrases

9.0

procedure

9.0

edge cases

6.0

documentation

8.0

view original SKILL.md from clawhubclick to expand

---
name: magento2
description: >
  Manage a Magento 2 / Adobe Commerce store via REST API. Use for orders,
  catalog, customers, inventory, promotions, and sales reporting. It can also
  discover and interact with custom modules (like blogs) by exploring the
  system's modules and REST schema. Triggers on requests like "show me today's
  orders", "update product stock", "check installed modules", "call custom api",
  "morning brief", "store health", "inventory risk", "stockout", "promotion audit",
  "stuck orders", "order exceptions", "pricing issues", or anything referencing
  a Magento store.
version: 1.1.0
metadata:
  openclaw:
    emoji: "🛒"
    homepage: https://github.com/caravanglory/openclaw-magento2
    primaryEnv: MAGENTO_BASE_URL
    requires:
      env:
        - MAGENTO_BASE_URL
        - MAGENTO_CONSUMER_KEY
        - MAGENTO_CONSUMER_SECRET
        - MAGENTO_ACCESS_TOKEN
        - MAGENTO_ACCESS_TOKEN_SECRET
      bins:
        - python3
    install:
      - kind: uv
        packages:
          - requests
          - requests-oauthlib
          - pandas
          - tabulate
        label: "Install Python dependencies (uv)"
---

# Magento 2 Skill

Connect to one or more Magento 2 / Adobe Commerce stores via REST API using OAuth 1.0a.

## Authentication

All requests are signed with OAuth 1.0a. Credentials are read from environment variables — never ask the user to paste them in chat.

### Single site (default)

- `MAGENTO_BASE_URL` — e.g. `https://store.example.com`
- `MAGENTO_CONSUMER_KEY`
- `MAGENTO_CONSUMER_SECRET`
- `MAGENTO_ACCESS_TOKEN`
- `MAGENTO_ACCESS_TOKEN_SECRET`

### Multi-site setup

To connect to additional stores, define credentials with a site suffix (`MAGENTO_<VAR>_<SITE>`):

```
MAGENTO_BASE_URL_US=https://us.store.com
MAGENTO_CONSUMER_KEY_US=...
MAGENTO_CONSUMER_SECRET_US=...
MAGENTO_ACCESS_TOKEN_US=...
MAGENTO_ACCESS_TOKEN_SECRET_US=...

MAGENTO_BASE_URL_EU=https://eu.store.com
MAGENTO_CONSUMER_KEY_EU=...
...
```

All scripts accept `--site <alias>` to target a specific store. When omitted, the default (unsuffixed) credentials are used.

```
python3 orders.py list --site us --limit 10
python3 system.py sites            # list all configured sites
```

### Optional env vars

- `MAGENTO_TIMEOUT` — Default is 30 seconds. Supports per-site override: `MAGENTO_TIMEOUT_US`.
- `MAGENTO_DEBUG` — Set to 1 to enable verbose logging to stderr.

All scripts import the shared client from `scripts/magento_client.py`. Never construct raw HTTP requests inline — always use the client.

## Available commands

Run scripts with: `python3 <skill_dir>/scripts/<script>.py [args]`

### Orders — `scripts/orders.py`

```
# List recent orders (default: last 20)
python3 orders.py list [--limit N] [--status pending|processing|complete|canceled|closed|holded|payment_review]

# Get a single order
python3 orders.py get <order_id>

# Update order status
python3 orders.py update-status <order_id> <status>

# Cancel an order
python3 orders.py cancel <order_id>

# Ship an order (optional: add tracking number and carrier)
python3 orders.py ship <order_id> [--track N] [--carrier carrier_code] [--title title]

# Invoice an order
python3 orders.py invoice <order_id>
```

### Catalog — `scripts/catalog.py`

```
# Search products
python3 catalog.py search <query> [--limit N]

# Get product by SKU
python3 catalog.py get <sku>

# Update product price
python3 catalog.py update-price <sku> <price>

# Update product name / description
python3 catalog.py update-attribute <sku> <attribute> <value>

# Enable or disable a product
python3 catalog.py update-status <sku> {enabled|disabled}

# Delete a product
python3 catalog.py delete <sku>

# List categories
python3 catalog.py categories
```

### Customers — `scripts/customers.py`

```
# Search customers by email or name
python3 customers.py search <query> [--limit N]

# Get customer by ID
python3 customers.py get <customer_id>

# Get customer orders
python3 customers.py orders <customer_id>

# Update customer group
python3 customers.py update-group <customer_id> <group_id>
```

### Inventory — `scripts/inventory.py`

```
# Check stock for a SKU
python3 inventory.py check <sku>

# Update stock quantity
python3 inventory.py update <sku> <qty>

# List low-stock products (below threshold)
python3 inventory.py low-stock [--threshold N]

# Bulk stock check from a comma-separated SKU list
python3 inventory.py bulk-check <sku1,sku2,...>
```

#### Multi-Source Inventory (MSI)

Requires Magento 2.3+ with Inventory modules enabled.

```
# List inventory sources (warehouses)
python3 inventory.py sources [--limit N]

# Get details for a specific source
python3 inventory.py source-get <source_code>

# List source items (stock per source) — filter by SKU, source, or both
python3 inventory.py source-items --sku <sku> [--source <source_code>] [--limit N]

# Update quantity for a SKU at a specific source
python3 inventory.py source-item-update <sku> <source_code> <qty>

# Get salable quantity for a SKU in a stock
python3 inventory.py salable-qty <sku> <stock_id>

# Check if a product is salable in a stock
python3 inventory.py is-salable <sku> <stock_id>

# List inventory stocks (logical groupings)
python3 inventory.py stocks [--limit N]
```

### Promotions — `scripts/promotions.py`

```
# List active cart price rules
python3 promotions.py list [--active-only]

# Get a rule by ID
python3 promotions.py get <rule_id>

# Create a coupon code for an existing rule
python3 promotions.py create-coupon <rule_id> <code> [--uses N]

# Disable a promotion rule
python3 promotions.py disable <rule_id>

# List coupon usage stats
python3 promotions.py coupon-stats <coupon_code>
```

### Reporting — `scripts/reports.py`

```
# Sales summary for a date range
python3 reports.py sales --from YYYY-MM-DD --to YYYY-MM-DD

# Revenue by product (top N)
python3 reports.py top-products [--limit N] [--from YYYY-MM-DD] [--to YYYY-MM-DD]

# Revenue by customer (top N)
python3 reports.py top-customers [--limit N] [--from YYYY-MM-DD] [--to YYYY-MM-DD]

# Order status breakdown
python3 reports.py order-status [--from YYYY-MM-DD] [--to YYYY-MM-DD]

# Inventory value report
python3 reports.py inventory-value
```

### System & Discovery — `scripts/system.py`

```
# Check API connection status
python3 system.py status

# List installed modules
python3 system.py modules

# Inspect REST schema
python3 system.py schema

# List all configured sites
python3 system.py sites

# Cache management
python3 system.py cache-list
python3 system.py cache-flush [--types ID1,ID2]
```

### Custom API — `scripts/custom_api.py`

Use this for interacting with discovered custom endpoints.

```
# Call custom endpoints (e.g. blog module)
python3 custom_api.py GET <path> [--params '{"key": "value"}']
python3 custom_api.py POST <path> --data '{"body": "json"}'
```

### Morning Brief — `scripts/morning_brief.py`

Generate a daily store health summary across sales, orders, inventory, promotions, and customers.

```
# Generate morning brief (default: last 24 hours)
python3 morning_brief.py brief [--site SITE] [--hours 24] [--stock-threshold 10]

# JSON output for programmatic consumption
python3 morning_brief.py brief --format json
```

### Diagnostics — `scripts/diagnose.py`

Deep-dive analysis for specific store issues.

```
# Inventory risk radar with velocity-based stockout prediction
python3 diagnose.py inventory-risk [--days 7] [--threshold 10] [--limit 50]

# Audit promotions for expired rules, missing coupons, exhausted limits
python3 diagnose.py promotion-audit [--warn-hours 48]

# Find stuck orders (pending too long, payment review, processing delay)
python3 diagnose.py order-exceptions [--pending-hours 24] [--processing-hours 48]

# Detect pricing anomalies (zero price, negative price, inverted specials)
python3 diagnose.py pricing-anomaly [--limit 50]

# JSON output available for all subcommands
python3 diagnose.py inventory-risk --format json
```

### Bulk Operations

Batch update prices, stock, and shipments via CSV or inline input.

```
# Bulk update prices (preview mode)
python3 catalog.py bulk-update-price --items "SKU1:29.99,SKU2:49.99"
python3 catalog.py bulk-update-price --csv prices.csv

# Execute bulk price changes
python3 catalog.py bulk-update-price --csv prices.csv --execute

# Bulk update stock
python3 inventory.py bulk-update --items "SKU1:100,SKU2:50"
python3 inventory.py bulk-update --csv stock.csv --execute

# Bulk ship orders
python3 orders.py bulk-ship --csv shipments.csv --execute
```

## Output format

All scripts print a UTF-8 table (via `tabulate`) or a JSON summary to stdout. When presenting results to the user, render them as a markdown table. For single-record lookups, format as a definition list.

## Error handling

Scripts exit with code 1 on API errors and print a JSON error to stderr:
```json
{ "error": "404 Not Found", "message": "No such entity with id = 99", "url": "..." }
```

If a script fails, read stderr, extract the `message` field, and tell the user plainly what went wrong. Do not retry automatically unless the user asks.

## Rules

- Never expose OAuth credentials in chat output, logs, or summaries.
- For any **write operation** (cancel, delete, update-price, update-status, update-group, cache-flush, ship, invoice, create-coupon, disable, source-item-update, and all POST/PUT/DELETE via custom_api.py), always repeat the full command back to the user and wait for explicit confirmation before executing.
- **Read-only operations** (list, get, search, check, status, modules, schema, cache-list, reports) may be executed directly without confirmation.
- When a date range is not specified for reports, default to the last 30 days.
- Monetary values are returned in the store's base currency — include the currency code in output.
- **Multi-site**: When multiple sites are configured, always confirm which site the user intends before executing write operations. Use `system.py sites` to discover available sites.
- **Production Safety**: After performing updates to products or prices, it is recommended to run `system.py cache-flush` if the changes don't appear on the frontend.
- **Morning Brief** and **diagnose** commands are read-only — they may be executed directly without confirmation.
- After generating a morning brief, proactively recommend relevant `diagnose.py` subcommands based on the findings.
- **Bulk operations**: Always preview first (default), then require `--execute` flag and explicit user confirmation. Follow preview templates in `references/workflows.md`.
- **Scenarios**: For detailed routing guidance, see `references/workflows.md`.

related skills

semantically similar in the cross-vendor index

clawhub

70% match

Shopify

Manage Shopify products, orders, customers, inventory, collections, and store operations via the Shopify Admin API with OAuth authentication. Use this skill...

don't have the plugin yet? install it then click "run inline in claude" again.

Magento 2 Skill

intent

Manage one or more Magento 2 or Adobe Commerce stores via REST API using OAuth 1.0a authentication. Use this skill to query and modify orders, products, customers, inventory (including multi-source inventory), promotions, and generate sales reports. Also discover and call custom module APIs. Triggers on requests like "show me today's orders", "update product stock", "check installed modules", "morning brief", "inventory risk", "promotion audit", "stuck orders", or anything referencing a Magento store's data or operations.

inputs

environment variables (required for all operations)

Default (single-site) setup:

MAGENTO_BASE_URL - store URL, e.g. https://store.example.com. Required. No trailing slash.
MAGENTO_CONSUMER_KEY - OAuth consumer key. Required.
MAGENTO_CONSUMER_SECRET - OAuth consumer secret. Required.
MAGENTO_ACCESS_TOKEN - OAuth access token. Required.
MAGENTO_ACCESS_TOKEN_SECRET - OAuth access token secret. Required.

Multi-site setup (optional): Define credentials with site suffix for additional stores. Example for "us" and "eu" sites:

MAGENTO_BASE_URL_US=https://us.store.com
MAGENTO_CONSUMER_KEY_US=...
MAGENTO_CONSUMER_SECRET_US=...
MAGENTO_ACCESS_TOKEN_US=...
MAGENTO_ACCESS_TOKEN_SECRET_US=...

MAGENTO_BASE_URL_EU=https://eu.store.com
MAGENTO_CONSUMER_KEY_EU=...
MAGENTO_CONSUMER_SECRET_EU=...
MAGENTO_ACCESS_TOKEN_EU=...
MAGENTO_ACCESS_TOKEN_SECRET_EU=...

Optional:

MAGENTO_TIMEOUT - HTTP timeout in seconds. Default 30. Supports per-site override: MAGENTO_TIMEOUT_US.
MAGENTO_DEBUG - Set to 1 to enable verbose logging to stderr.

external connections

Magento 2.3+ or Adobe Commerce REST API (OAuth 1.0a). Network connectivity required. No firewall rules documented; assume standard HTTPS port 443.

binaries and libraries

python3 - required to run all scripts.
requests, requests-oauthlib, pandas, tabulate - installed via uv (see metadata.requires.install).

context from user

target site alias (if multi-site; omit for default).
date ranges for reports (optional; defaults to last 30 days if not specified).
query terms for search operations (orders, products, customers).
SKUs, order IDs, or customer IDs for lookups.
new values for updates (prices, stock, statuses, attributes).

procedure

1. check api connectivity

input: environment variables set (MAGENTO_BASE_URL, OAuth credentials).

command: python3 scripts/system.py status

output: JSON with store version, API status, and timestamp. If connection fails, exits with code 1 and prints JSON error to stderr.

2. list or search orders

input: optional --limit (default 20), optional --status filter, optional --site.

command: python3 scripts/orders.py list [--limit N] [--status <status>] [--site <alias>]

output: UTF-8 table with order ID, created date, status, grand total, and customer email. Renders as markdown in chat.

3. get single order details

input: order ID.

command: python3 scripts/orders.py get <order_id> [--site <alias>]

output: JSON of full order object including items, addresses, totals, status, and comments. Format as definition list in chat.

4. update order status

input: order ID, target status (pending, processing, complete, canceled, closed, holded, payment_review).

command: python3 scripts/orders.py update-status <order_id> <status> [--site <alias>]

output: JSON confirmation with updated order ID and new status. User sees "order #123 status changed to 'processing'".

5. cancel an order

input: order ID.

command: python3 scripts/orders.py cancel <order_id> [--site <alias>]

output: JSON confirmation with order ID and cancellation timestamp. Magento reverts inventory if configured.

6. ship an order

input: order ID, optional tracking number, optional carrier code, optional title.

command: python3 scripts/orders.py ship <order_id> [--track <tracking_num>] [--carrier <code>] [--title <title>] [--site <alias>]

output: JSON with shipment ID, items shipped, and tracking info (if provided). Customer receives shipment email.

7. invoice an order

input: order ID.

command: python3 scripts/orders.py invoice <order_id> [--site <alias>]

output: JSON with invoice ID, order ID, and items billed. Invoice created in Magento.

8. search products

input: search query (name, SKU, description), optional --limit (default 20).

command: python3 scripts/catalog.py search <query> [--limit N] [--site <alias>]

output: UTF-8 table with product ID, SKU, name, price, status, and stock. Renders as markdown.

9. get product by SKU

input: SKU (exact match).

command: python3 scripts/catalog.py get <sku> [--site <alias>]

output: JSON of product object with all attributes, price, special price, stock, images, and category links. Format as definition list in chat.

10. update product price

input: SKU, new price (numeric).

command: python3 scripts/catalog.py update-price <sku> <price> [--site <alias>]

output: JSON confirmation with SKU, old price, new price, and timestamp.

11. update product attribute (name, description, etc.)

input: SKU, attribute code (name, description, short_description, etc.), new value.

command: python3 scripts/catalog.py update-attribute <sku> <attribute> <value> [--site <alias>]

output: JSON confirmation with SKU, attribute, and new value.

12. enable or disable product

input: SKU, status (enabled or disabled).

command: python3 scripts/catalog.py update-status <sku> {enabled|disabled} [--site <alias>]

output: JSON confirmation with SKU and new status.

13. delete product

input: SKU.

command: python3 scripts/catalog.py delete <sku> [--site <alias>]

output: JSON confirmation with deleted SKU. Cannot be undone.

14. list product categories

input: none.

command: python3 scripts/catalog.py categories [--limit N] [--site <alias>]

output: UTF-8 table with category ID, name, parent, and product count.

15. bulk update prices

input: CSV file or inline SKU:price pairs.

command: preview (no --execute): python3 scripts/catalog.py bulk-update-price --csv prices.csv [--site <alias>] or python3 scripts/catalog.py bulk-update-price --items "SKU1:29.99,SKU2:49.99" [--site <alias>]

output: preview table with SKU, old price, new price, and status. Then execute with --execute flag after user confirmation.

16. execute bulk price update

input: CSV file, user explicit confirmation.

command: python3 scripts/catalog.py bulk-update-price --csv prices.csv --execute [--site <alias>]

output: JSON summary with success count, failure count, and details per item.

17. search customers

input: email or name query, optional --limit (default 20).

command: python3 scripts/customers.py search <query> [--limit N] [--site <alias>]

output: UTF-8 table with customer ID, email, name, group, and created date.

18. get customer by ID

input: customer ID.

command: python3 scripts/customers.py get <customer_id> [--site <alias>]

output: JSON of customer object with email, name, group, addresses, and account data. Format as definition list.

19. get customer orders

input: customer ID.

command: python3 scripts/customers.py orders <customer_id> [--limit N] [--site <alias>]

output: UTF-8 table with order ID, date, status, and total for that customer.

20. update customer group

input: customer ID, group ID (e.g. 0 for Not Logged In, 1 for General, 2 for Wholesale).

command: python3 scripts/customers.py update-group <customer_id> <group_id> [--site <alias>]

output: JSON confirmation with customer ID and new group ID.

21. check stock for a SKU

input: SKU.

command: python3 scripts/inventory.py check <sku> [--site <alias>]

output: JSON with SKU, quantity on hand, is_in_stock (boolean), and stock status label. Single-item format.

22. update stock quantity

input: SKU, new quantity (integer).

command: python3 scripts/inventory.py update <sku> <qty> [--site <alias>]

output: JSON confirmation with SKU, old quantity, new quantity.

23. list low-stock products

input: optional --threshold (default varies by config; typically 10).

command: python3 scripts/inventory.py low-stock [--threshold N] [--limit 50] [--site <alias>]

output: UTF-8 table with SKU, name, current stock, and threshold flag.

24. bulk stock check

input: comma-separated SKU list (no spaces).

command: python3 scripts/inventory.py bulk-check <sku1,sku2,sku3> [--site <alias>]

output: UTF-8 table with SKU, quantity, and in-stock status for each.

25. bulk update inventory

input: CSV file or inline SKU:qty pairs.

command: preview: python3 scripts/inventory.py bulk-update --csv stock.csv [--site <alias>] or python3 scripts/inventory.py bulk-update --items "SKU1:100,SKU2:50" [--site <alias>]

output: preview table. Execute with --execute flag after confirmation.

26. multi-source inventory (MSI): list sources (warehouses)

input: optional --limit (default 20).

command: python3 scripts/inventory.py sources [--limit N] [--site <alias>]

output: UTF-8 table with source code, name, and enabled status. Requires Magento 2.3+ with Inventory modules.

27. multi-source inventory: get source details

input: source code (e.g. default, warehouse-east).

command: python3 scripts/inventory.py source-get <source_code> [--site <alias>]

output: JSON with source code, name, contact info, and configuration. Format as definition list.

28. multi-source inventory: list source items (stock per source)

input: optional --sku, optional --source, optional --limit (default 20).

command: python3 scripts/inventory.py source-items [--sku <sku>] [--source <source_code>] [--limit N] [--site <alias>]

output: UTF-8 table with SKU, source code, quantity, and status.

29. multi-source inventory: update source item quantity

input: SKU, source code, new quantity.

command: python3 scripts/inventory.py source-item-update <sku> <source_code> <qty> [--site <alias>]

output: JSON confirmation with SKU, source code, and new quantity.

30. multi-source inventory: get salable quantity

input: SKU, stock ID (logical grouping, e.g. 1 for default).

command: python3 scripts/inventory.py salable-qty <sku> <stock_id> [--site <alias>]

output: JSON with SKU, stock ID, and total salable quantity across sources assigned to that stock.

31. multi-source inventory: check if product is salable

input: SKU, stock ID.

command: python3 scripts/inventory.py is-salable <sku> <stock_id> [--site <alias>]

output: JSON with SKU, stock ID, and boolean is_salable.

32. multi-source inventory: list inventory stocks

input: optional --limit (default 20).

command: python3 scripts/inventory.py stocks [--limit N] [--site <alias>]

output: UTF-8 table with stock ID, name, and source assignments.

33. list active promotions

input: optional --active-only flag.

command: python3 scripts/promotions.py list [--active-only] [--limit N] [--site <alias>]

output: UTF-8 table with rule ID, name, description, status, and discount type.

34. get promotion rule by ID

input: rule ID.

command: python3 scripts/promotions.py get <rule_id> [--site <alias>]

output: JSON with rule ID, name, conditions, actions, coupon settings, and usage limits. Format as definition list.

35. create coupon code for a promotion rule

input: rule ID, coupon code (string, alphanumeric), optional --uses (usage limit per coupon; default unlimited).

command: python3 scripts/promotions.py create-coupon <rule_id> <code> [--uses N] [--site <alias>]

output: JSON confirmation with rule ID, coupon code, and usage limit set.

36. disable a promotion rule

input: rule ID.

command: python3 scripts/promotions.py disable <rule_id> [--site <alias>]

output: JSON confirmation with rule ID and new status (disabled).

37. list coupon usage stats

input: coupon code.

command: python3 scripts/promotions.py coupon-stats <coupon_code> [--site <alias>]

output: JSON with coupon code, times used, and remaining uses (if limited).

38. sales report (date range)

input: --from YYYY-MM-DD, --to YYYY-MM-DD. Both required. If omitted, defaults to last 30 days.

command: python3 scripts/reports.py sales --from YYYY-MM-DD --to YYYY-MM-DD [--site <alias>]

output: JSON with total orders, total revenue, average order value, and currency code.

39. top products by revenue

input: optional --limit (default 10), optional date range (--from, --to).

command: python3 scripts/reports.py top-products [--limit N] [--from YYYY-MM-DD] [--to YYYY-MM-DD] [--site <alias>]

output: UTF-8 table with SKU, product name, quantity sold, revenue, and currency.

40. top customers by revenue

input: optional --limit (default 10), optional date range.

command: python3 scripts/reports.py top-customers [--limit N] [--from YYYY-MM-DD] [--to YYYY-MM-DD] [--site <alias>]

output: UTF-8 table with customer ID, email, order count, and total revenue.

41. order status breakdown

input: optional date range.

command: python3 scripts/reports.py order-status [--from YYYY-MM-DD] [--to YYYY-MM-DD] [--site <alias>]

output: JSON with count of orders per status (pending, processing, complete, canceled, etc.) for the period.

42. inventory value report

input: none.

command: python3 scripts/reports.py inventory-value [--site <alias>]

output: JSON with total on-hand inventory value (cost or retail) across all products, by category and in aggregate. Currency included.

43. check api status and info

input: none.

command: python3 scripts/system.py status [--site <alias>]

output: JSON with Magento version, API status, timezone, and timestamp.

44. list installed modules

input: optional --limit (default all).

command: python3 scripts/system.py modules [--limit N] [--site <alias>]

output: UTF-8