magento-api

Develop custom REST and GraphQL APIs for Magento 2.

35|16|Updated Mar 4, 2026
One-click install
npx skills add https://github.com/OrcaQubits/agentic-commerce-claude-plugins --skill magento-api-orcaqubits
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: magento-api
Source: https://github.com/OrcaQubits/agentic-commerce-claude-plugins/tree/main/magento2-commerce/skills/magento-api
Command: npx skills add https://github.com/OrcaQubits/agentic-commerce-claude-plugins --skill magento-api-orcaqubits

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill simplifies the complex process of developing custom REST and GraphQL APIs for Magento 2, enabling seamless integration and data access.

Core Features & Use Cases

  • REST API Development: Define endpoints, map HTTP methods, and implement service contracts using webapi.xml.
  • GraphQL API Development: Extend the GraphQL schema, create resolvers, and manage authorization for storefront APIs.
  • Authentication & ACL: Configure various authentication methods (Admin Token, Customer Token, OAuth) and implement fine-grained access control using acl.xml.
  • Use Case: Integrate a third-party application with your Magento 2 store by creating a custom REST endpoint to fetch product data or a GraphQL mutation to place orders.

Quick Start

Use the magento-api skill to create a new REST endpoint for fetching custom product attributes.

Frequently Asked Questions about magento-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a custom REST API in Magento 2?

To create a custom Magento 2 REST API, define endpoints and map HTTP methods in the webapi.xml configuration file, then implement the underlying service contracts for business logic.

How do I extend the GraphQL schema in Magento 2?

Extend the Magento 2 GraphQL schema by defining types and queries in the schema.graphqls file, then implement the corresponding resolvers and manage storefront API authorization.

How do I configure authentication and ACL for Magento 2 web APIs?

Configure Magento 2 API authentication using Admin Tokens, Customer Tokens, or OAuth, and implement fine-grained endpoint access control by defining rules in the acl.xml file.

What is the best way to integrate an external system with Magento 2 data?

Integrate external systems with Magento 2 by building custom REST endpoints to fetch specific data like product attributes, or create GraphQL mutations for actions like order placement.

Does this approach support both REST and GraphQL API development for Magento 2?

Yes, this approach supports developing both REST and GraphQL APIs for Magento 2, handling webapi.xml configuration, schema.graphqls definition, resolver implementation, and endpoint security.