- Retrieve a list of products with filtering and pagination (ACL Magento_Catalogproducts)
- Retrieve a specific product by SKU (ACL Magento_Catalogproducts)
- Create a new product (ACL Magento_Catalogproducts)
- Update an existing product (ACL Magento_Catalogproducts)
- Delete a product by SKU (ACL Magento_Catalogproducts)
- Get category tree
- Get category details
- Create a new category
- Update category information
- Delete a category
- Retrieve a list of customers with filtering
- Retrieve a specific customer by ID
- Create a new customer account
- Update customer information
- Delete a customer account
- Get all customer groups (ACL Magento_Customergroup)
- Get specific customer group by ID (ACL Magento_Customergroup)
- Create new customer group (ACL Magento_Customergroup)
- Update an existing customer group by ID
- Delete a customer group by ID
- Retrieve a list of orders with filtering
- Retrieve a specific order by ID
- Add a comment to an existing order. Requires orderId (integer — use list_orders to find it) and a statusHistory object with comment (string). Optionally set is_customer_notified (0 or 1) and is_visible_on_front (0 or 1).
- Cancel an existing order
- List invoices with filters (ACL Magento_Sales sales_invoice)
- Get specific invoice by ID (ACL Magento_Salessales_invoice)
- Send invoice email to customer (ACL Magento_Salessales_invoice)
- Create an invoice for an order. Requires orderId (integer) as a path parameter. Optionally pass items (array of {order_item_id, qty}) to invoice specific items, capture (boolean) for online payment capture, and notify (boolean) to email the customer. Use list_orders to find the orderId — order must have uninvoiced items.
- List shipments with filters (ACL Magento_Salesshipment)
- Get specific shipment by ID (ACL Magento_Salesshipment)
- Create a shipment for an order. Requires an entity object containing order_id (integer), items (array of {order_item_id, qty}), and optionally tracks (array of {track_number, title, carrier_code}) and comments. Use list_orders to find the order_id first — order must be in 'processing' status.
- List credit memos with filters (ACL Magento_Salescreditmemo)
- Retrieve a credit memo by its numeric id. Obtain ids by first calling list_credit_memos, or capture them from the response of create_credit_memo. Requires ACL Magento_Sales::creditmemo.
- Create a credit memo (refund) for an order. Requires a creditmemo object with order_id (integer) and optionally items (array of {order_item_id, qty}), shipping_amount, adjustment_positive, adjustment_negative. The order must already have an invoice — use create_invoice first if needed. Use list_orders to find the order_id.
- Create a new shopping cart for the authenticated customer
- Retrieve cart details by ID
- Add a product to the cart
- Update the quantity or product options of an existing cart item.
- Remove an item from the cart
- Get the legacy single-source stock status for a product by SKU (is it in stock? what quantity?). This uses the CatalogInventory module — for multi-source inventory (MSI) with multiple warehouses, use list_source_items instead.
- List multi-source inventory (MSI) source items — shows product quantities per warehouse/source. Filter by sku or source_code to find inventory across multiple locations. For simple single-source stock checks, use get_stock_status instead.
- Update inventory quantities at sources. Requires a sourceItems array where each item has sku (string — use list_products to find SKUs), source_code (string — use list_source_items to find source codes), quantity (number), and status (number: 1=in stock, 0=out of stock).
- Get all CMS pages (full standalone web pages like 'About Us', 'Home', 'Contact'). Pages have their own URL and are navigable in the storefront. Use list_cms_blocks for reusable content snippets embedded within pages instead.
- Get a specific CMS page
- Get all CMS blocks (reusable content snippets like banners, sidebars, footer widgets that are embedded within pages or layouts). Blocks do not have their own URL. Use list_cms_pages for full standalone web pages instead.
- Get a specific CMS block
- Get store configuration settings (locale, currency, timezone, base URLs, secure URLs). This returns the technical configuration of each store view — not the list of stores themselves. Use list_store_views to get the list of store views instead.
- Get all websites in the Magento multi-site hierarchy. A website is the top level — each website contains one or more store groups. Use this to find website_ids needed by create_cart_rule and other actions that require website scoping.
- Get all store groups (the middle level of Magento's hierarchy: Website > Store Group > Store View). Each store group belongs to a website and contains one or more store views. Also called 'stores' in the Magento admin.
- Get all store views (the lowest level of Magento's hierarchy: Website > Store Group > Store View). Each store view represents a specific language/locale frontend. The store view code is used in API base URLs (e.g., /rest/default/V1).
- Get all tax rates — the actual percentage rates applied to products (e.g., 8.25% for California). Each rate is tied to a country and optionally a region/zip code. Use list_tax_rules to see how rates are combined into rules, or list_tax_classes to see product/customer tax class categories.
- Get all tax rules — rules that combine tax rates with tax classes to determine which rate applies to which products/customers. A rule links one or more tax rates to customer tax classes and product tax classes. Use list_tax_rates for the actual percentage rates, or list_tax_classes for the category definitions.
- Get all tax classes — categories that classify products (e.g., 'Taxable Goods', 'Shipping') or customers (e.g., 'Retail Customer', 'Wholesale') for tax calculation purposes. Filter by class_type=PRODUCT or class_type=CUSTOMER. Use list_tax_rules to see how classes are linked to rates.
- Generate coupon codes for a cart price rule. Requires a couponSpec object with rule_id (integer — use list_cart_rules to find it; the rule must have coupon_type=SPECIFIC and use_auto_generation=true), quantity (integer), length (integer), and format (one of alphanum, alpha, num). Optionally add prefix, suffix, and delimiter.
- Get all coupon codes
- Delete a coupon by ID
- Get all cart price rules
- Get a specific cart price rule
- Create a new cart price rule (promotion). Requires a rule object with: name (string), is_active (boolean), simple_action (one of by_percent, by_fixed, cart_fixed, buy_x_get_y_free), discount_amount (number), customer_group_ids (array of integers — use list_customer_groups to find IDs), and website_ids (array of integers — use list_websites to find IDs). Use coupon_type SPECIFIC with use_auto_generation=true to enable coupon code generation via generate_coupons.
- Update an existing cart price rule by ID. Requires ruleId (integer) as path parameter and a rule object with the fields to update. Use list_cart_rules or get_cart_rule to find the ruleId first. The rule object has the same structure as create_cart_rule — at minimum include name, is_active, customer_group_ids, and website_ids.
- Delete a cart price rule by ID
No matching actions